git.cworth.org Git - vogl/blob - README.md

   1 vogl
   2 =============
   3
   4 ## Warning ##
   5
   6 This project is alpha^2 right now. If you are up for suffering through a bit of pain with early releases, please continue on - we'd love to have your help...
   7
   8 ## Build ##
   9
  10 To build the vogl chroots (uses schroot), do the following:
  11
  12     vogl/bin/chroot_build.sh --i386 --amd64
  13
  14 You should now be ready to build in your chroots. Something like any of these:
  15
  16     vogl/bin/mkvogl.sh --release --amd64
  17     vogl/bin/mkvogl.sh --debug --amd64 --i386 --clang34 --verbose
  18     vogl/bin/mkvogl.sh --release --amd64 --i386 --gcc48 --CRNLIB_ENABLE_ASSERTS
  19
  20 Note that you do _not_ have to use the chroots or mkvogl.sh to build. You could do your own cmake (cmake vogl/src) and go from there. It's up to you to get the dependencies correct though. Look at vogl/bin/chroot_configure.sh to see how the chroots are set up. The source for mkvogl is in vogl/bin/src/mkvogl.cpp - it's just a simple cpp wrapper around cmake.
  21
  22 If you do use the chroots, do not build from within an encrypted home folder, as files in an encrypted home folder will not be visible from within the chroot, causing the build script to fail.
  23
  24 ## Capturing ##
  25
  26     vogl/bin/steamlauncher.sh --gameid vogl/vogl_build/bin/glxspheres32
  27     vogl/bin/steamlauncher.sh --gameid vogl/vogl_build/bin/glxspheres64 --amd64
  28
  29 You should now have something like the following in your temp directory:
  30
  31     /tmp/vogltrace.glxspheres64.2014_01_20-16_19_34.bin
  32
  33 ## Replay ##
  34
  35     vogl/vogl_build/bin/voglreplay64 /tmp/vogltrace.glxspheres64.2014_01_20-16_19_34.bin
  36
  37 or
  38
  39     vogl/vogl_build/bin/vogleditor64 /tmp/vogltrace.glxspheres64.2014_01_20-16_19_34.bin
  40
  41 ## Directory structure ##
  42
  43 The directory structure for vogl currently looks like this:
  44
  45         vogl/
  46             bin/
  47                 chroot_build.sh ; script to build/rebuild chroots
  48                 chroot_configure.sh ; script to build libs to chroots (used by chroot_build.sh)
  49                 gligen_run.sh ; run vogl_build/bin64/gligen.sh (put in glspec)
  50                 gligen_copy_inc_files.sh ; copy glspec/*.inc
  51                 set_compiler.sh ; switch chroot default compiler
  52             external/ ; external source (libunwind, etc.)
  53             glspec/
  54             src/ ; vogl source
  55             vogl_build/
  56                 bin/ ; destination for binaries
  57             vogl_extbuild/
  58                 i386/   ; external projects untar'd & built here
  59                 x86_64/ ;
  60
  61 ## QtCreator tagging and building ##
  62
  63   See qtcreator/qtcreator.md file: [qtcreator.md](qtcreator/qtcreator.md)
  64
  65 ## Vogl Dev List ##
  66
  67     http://lists.voglproj.com/listinfo.cgi/dev-voglproj.com
  68
  69 ## Useful Links ##
  70
  71 Vogl Wiki
  72
  73 * https://github.com/ValveSoftware/vogl/wiki
  74
  75 OpenGL documentation/references
  76
  77 * 4.x: http://www.opengl.org/sdk/docs/man/
  78 * 3.3: http://www.opengl.org/sdk/docs/man3/
  79 * 2.1: http://www.opengl.org/sdk/docs/man2/
  80
  81 Specifications:
  82
  83 * 4.0: http://www.opengl.org/registry/doc/glspec40.core.20100311.pdf
  84 * 3.3: http://www.opengl.org/registry/doc/glspec33.core.20100311.withchanges.pdf
  85 * 2.1: http://www.opengl.org/documentation/specs/version2.1/glspec21.pdf
  86