lwjgl/doc
Elias Naur 4636c4b251 Added the opengl-template-pattern ant property to control the set of included opengl extensions 2005-09-29 18:12:20 +00:00
..
3rdparty added licenses 2005-06-29 20:16:43 +00:00
changelogs 0.6 2003-05-04 20:57:12 +00:00
templates Templates showing the structure of the XML model files. Schemas that can be used to validate model files. 2004-09-29 02:03:18 +00:00
CREDITS added comment about 3rd party library usage and dependency 2005-06-29 20:16:11 +00:00
LICENSE it's 2005! :) 2005-01-25 20:53:46 +00:00
README updated readme to include jinput 2005-08-18 13:48:43 +00:00
generator.txt Added the opengl-template-pattern ant property to control the set of included opengl extensions 2005-09-29 18:12:20 +00:00
lwjgl_hidden_switches.text moved Sys.log to LWJGLUtils and renamed property to org.lwjgl.util.Debug 2005-03-29 18:09:33 +00:00

README

This is the official readme file for lwjgl.

Unless otherwise stated, all files distributed or in CVS are covered by 
the license as stated in the LICENSE file. If you have not received this
file, please download it from the cvs server.

Please note that DevIL and OpenAL are distributed along side. Their license is also included.
If you want to use FMOD you must download the binary from their site: http://fmod.org. Please
note that FMOD is a commercial offering and you must accept their license before using.

To run some of the included tests:
 Extract the archive, and cd into directory
 (please substitute ; and \ according to platform)

  java -cp .;res;jar\lwjgl.jar;jar\lwjgl_test.jar;jar\lwjgl_util.jar;jar\lwjgl_fmod3.jar;jar\lwjgl_devil.jar;jar\jinput.jar; -Djava.library.path=native TEST 
  (this specifies that the jvm should locate the lwjgl native libs in 'native' directory)
  
 where TEST is one of the following: 
 
 	org.lwjgl.test.WindowCreationTest
 	org.lwjgl.test.SysTest
 	org.lwjgl.test.DisplayTest
 
  org.lwjgl.test.input.MouseCreationTest
  org.lwjgl.test.input.MouseTest
  org.lwjgl.test.input.HWCursorTest
  org.lwjgl.test.input.KeyboardTest
  org.lwjgl.test.input.TestControllers
  
  org.lwjgl.test.openal.ALCTest
  org.lwjgl.test.openal.OpenALCreationTest
  org.lwjgl.test.openal.MovingSoundTest
  org.lwjgl.test.openal.PlayTest
  org.lwjgl.test.openal.PlayTestMemory
  org.lwjgl.test.openal.SourceLimitTest
  org.lwjgl.test.openal.PositionTest
  org.lwjgl.test.openal.StressTest
  org.lwjgl.test.openal.SourceLimitTest
  
  org.lwjgl.test.opengl.FullScreenWindowedTest
  org.lwjgl.test.opengl.PbufferTest
  org.lwjgl.test.opengl.VBOIndexTest
  org.lwjgl.test.opengl.VBOTest
  
  org.lwjgl.test.opengl.pbuffers.PbufferTest
  
  org.lwjgl.test.opengl.shaders.ShadersTest

  [requires fmod dll (fmod.org)]  
  org.lwjgl.test.fmod3.CDDAPlayer
  org.lwjgl.test.fmod3.CDPlayer
  org.lwjgl.test.fmod3.DSPTest
  org.lwjgl.test.fmod3.MusicPlayer
  org.lwjgl.test.fmod3.NetTest
  org.lwjgl.test.fmod3.StreamPlayer
  org.lwjgl.test.fmod3.StreamTest
  org.lwjgl.test.fmod3.SyncTest
  
  org.lwjgl.test.devil.BasicTest
  
You may also run the Space invaders demo by executing:
  java -cp .;res;jar\lwjgl.jar;jar\lwjgl_test.jar;jar\lwjgl_util.jar; -Djava.library.path=native org.lwjgl.examples.spaceinvaders.Game
  
Project Webpage: www.lwjgl.org
Project Forum: forum.lwjgl.org
Project CVS: cvs.lwjgl.org