INSTALL

   1
   2
   3              ________
   4             /        \________  _______
   5             \         \       \|       \
   6          ____\     ___/____   /|_       \
   7         /     \     \    \    \ |        \
   8         \            \____\_   \|         \
   9          \___________/          \    |    /
  10                  s3D \__________/________/
  11
  12                                                 INSTALL
  13
  14
  15
  16
  17 1. Preparing
  18 ------------
  19
  20
  21 Before being able to install s3d and the sample programs, you need to prepare
  22 the build, and compile s3d.
  23
  24 You will need to setup CMake first. The following assumes that cmake 2.4.4 or
  25 better is available and installed into a directory listed in the $PATH
  26 environment variable. It is possible to run cmake direct from the source
  27 directory, but we recommend to create a directory from where you start cmake.
  28
  29 $ mkdir build
  30 $ cd build
  31 $ cmake .. [-DPROFILING=ON|OFF] [-DDEBUG=VLOW|LOW|MED|HIGH|VHIGH] \
  32            [-DENABLE_FINAL=ON|OFF] [-DEXAMPLES=ON|OFF] \
  33            [-DCMAKE_INSTALL_PREFIX=...]
  34
  35 This will configure s3d. Use the -DCMAKE_INSTALL_PREFIX command line argument to
  36 select a different prefix to install s3d into. The default is /usr/local, so
  37 binaries will get installed into /usr/local/bin, libraries into /usr/local/lib,
  38 and documentation into /usr/local/share/doc/s3d-version. If you are intending to
  39 work on s3d, you can use the -DDEBUG argument to enable building a debug
  40 version. Likewise, -DPROFILING=ON will enable a version compiled for profiling.
  41 Pseudo global optimisation can be enabled by setting -DENABLE_FINAL=ON. This
  42 will create a single file for each target which includes all other files and
  43 the compiler will only compile that specific file.
  44
  45 You can use ccmake to ccmake to set additional cmake cache variables.
  46
  47 $ ccmake ..
  48
  49 2. Building
  50 -----------
  51
  52 After configure has finished, you can start the build of s3d:
  53
  54 $ make
  55
  56 in the build directory will compile server, client-lib and the examples for you.
  57
  58
  59 3. Installing
  60 -------------
  61
  62 Because of the new plugins, things need to be installed before you can test.
  63
  64 $ make install
  65
  66 installs s3d in the selected prefix (default /usr/local/*), you may need to
  67 become root first.
  68
  69 $ s3d --no-rc
  70
  71 fires up the server. Uf you're lucky, a X11 window appears. Now the s3d is
  72 listening on TCP port 6066.
  73 Now it's time to test some things. on another terminal:
  74
  75 $ cd examples
  76 $ ./modelloader ../objs/miu.3ds
  77
  78 now there should appear a rotating cat. you can move with with the middle
  79 mouse-button pushed.
  80 now you can try the MCP, which is something like a windowmanager in X:
  81
  82 $ cd apps/dot_mcp
  83 $ ./dot_mcp
  84
  85 now you should get some fancy window decorations :D
  86 there are a few other examples, just play around
  87
  88 4. s3drc
  89 --------
  90
  91 We recommend to make use of the .s3drc. The idea is the same as in .xinitrc,
  92 starting the window manager (the mcp) along with the server. When the .s3drc
  93 is finished, the server will go down with it (so you can press a "quit" button
  94 in the mcp).
  95
  96 Give it a try:
  97
  98 $ cat << EOF > ~/.s3drc
  99 #!/bin/sh
 100 dot_mcp
 101 EOF
 102 $ s3d
 103
 104 (note, this time without --no-rc)