README.TXT 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. =====================================================================
  2. libRocket Sample Applications
  3. =====================================================================
  4. This directory contains a collection of sample applications
  5. that demonstrate the use of libRocket in small, easy
  6. to understand applications.
  7. To build the samples, you can either use Microsoft Visual Studio
  8. (using the project files found within each directory), or use SCons
  9. (SConstruct files are present in directories except those for
  10. Windows-specific samples).
  11. If you build with Visual Studio, make sure the actual sample is the
  12. 'startup project' (displayed in bold) rather than the sample shell
  13. project.
  14. If you build with SCons, be sure to compile the sample shell (found
  15. in /samples/shell/) before you compile other samples. All the
  16. SConstructs will build a debug build by default; to build a release
  17. version, run 'scons release'.
  18. When compiling Python examples, you will need to set up your build
  19. paths to point at the local copy of Python and Boost. If using Visual
  20. Studio, change these in the project's include and library paths. If
  21. using SCons, edit /build/config.py and change the paths as
  22. appropriate.
  23. Directory Overview:
  24. * assets - This directory contains the assets shared by
  25. all the sample applications.
  26. * basic - This directory contains basic applications
  27. that demonstrate initialisation, shutdown and
  28. installing custom interfaces.
  29. * customlog - setting up custom logging
  30. * directx - using DirectX 9 as a renderer
  31. * directx10 - using DirectX 10 as a renderer
  32. * drag - dragging elements between containers
  33. * loaddocument - loading your first document
  34. * ogre3d - interfacing with Ogre3D engine
  35. * treeview - using a nested DataSource
  36. * invaders - A full implementation of the 1970s classic
  37. Space Invaders using the libRocket interface.
  38. * pyinvaders - Python version of the above (only installed
  39. with the Python plugin).
  40. * luainvaders- Lua version of the invaders (only installed
  41. with the Lua plugin).
  42. * shell - Common platform specific code used by all the
  43. samples for open windows, processing input and
  44. access files.
  45. Supports Windows, MacOSX and Linux
  46. * tutorial - Tutorial code that should be used in conjunction
  47. with the tutorials on the libRocket website.
  48. http://www.librocket.com/wiki/documentation
  49. =====================================================================