Changes between Version 1 and Version 2 of Requirements

Timestamp:

01/14/11 04:31:56 (2 years ago)

Author:

ArcRiley

Comment:

--

Requirements

@@ -1 +1 @@
 = Hardware Requirements =
 
-One of our goals with PySoy is support games for everyday desktop and mobile users so our hardware requirements are quite low.  Any video card with a driver providing the following OpenGL extensions should be supported by PySoy:
+One of our goals with PySoy is support games for everyday desktop and mobile users so our hardware requirements are quite low.  Any video card supporting OpenGL 1.4 (or OpenGL ES 1.1) and following OpenGL extensions should be supported by PySoy:
 
  * '''[http://www.opengl.org/registry/specs/ARB/vertex_buffer_object.txt GL_ARB_vertex_buffer_object]'''
  * '''[http://www.opengl.org/registry/specs/ARB/texture_cube_map.txt GL_ARB_texture_cube_map]'''
- * '''[http://www.opengl.org/registry/specs/EXT/texture3D.txt GL_EXT_texture3D]'''
  * '''[http://www.opengl.org/registry/specs/ARB/vertex_program.txt GL_ARB_vertex_program]'''
 
-If your computer was manufactured in the past 5 years it should be supported.  The following cards are considered "base line" in supporting the above extensions:
+If your computer was manufactured in the past 7 years it should be supported.  The following cards are considered "base line" in supporting the above extensions:
  * '''AMD/ATI Radeon 9000'''
  * '''Intel i915'''
  * '''nVidia geForce2'''
 
-= Software Dependencies =
+= Runtime Dependencies =
 
-OpenGL and OpenAL are provided by numerous compatible driver frameworks.  These should already be installed on your system.  For GNU/Linux we recommend:
+OpenGL and OpenAL are provided by numerous compatible driver frameworks.  These should already be installed on your system, though some Windows users may need to acquire them separately.  For GNU/Linux we recommend:
  * '''[http://www.mesa3d.org/ Mesa] (7.6+)''' with direct rendering, test with "glxinfo|grep direct"
  * '''[http://kcat.strangesoft.net/openal.html OpenAL-soft] (1.8)''' or any OpenAL 1.1 library, provides 3d audio and hardware abstraction
@@ -25 +24 @@
  * '''[http://www.pango.org/ pango] (1.8+)''' text layout and rendering library
 
+We also use a handful of multimedia libraries:
+ * '''[http://glew.sourceforge.net/ glew] (1.4+)''' provides clean cross-platform OpenGL extension handling
+ * '''[http://xiph.org/ libogg] with libvorbis, and libtheora''' provides audio and video processing
+
+The [http://ode.org/ Open Dynamics Engine (ODE)] is currently required, though we are working on replacing this with internal lighter-weight physics functions that can run on lower powered devices. Check the documentation that came with the PySoy version you've downloaded for what version of ODE is required as ODE's API changes in incompatible ways between versions.
+
 
 = Development Essentials =
+
+To work on PySoy you must first get a working copy of [http://www.selenic.com/mercurial/wiki/ Mercurial] and clone the repositories to your computer:
+{{{
+hg clone http://hg.pysoy.org/libsoy
+hg clone http://hg.pysoy.org/pysoy
+}}}
+
+Beyond the runtime dependencies, you will also need a copy of [http://live.gnome.org/Vala valac] to compile the Genie source (.gs) to C source (.c) and [http://code.entropywave.com/projects/orc/ orcc] for compiling Orc source (.orc) to assembly (.s).  You will also need the C headers (.h) for all our runtime dependencies, Redhat and Debian based distributions (including Ubuntu and Fedora) provide these in separate *-dev packages.
+
+Once all these requirements are met, you can use [http://code.google.com/p/waf/ waf] to build libsoy.  Waf is self-contained in our source tree and only depends on Python (2.x or 3.x) to run:
+{{{
+./waf configure
+./waf build
+sudo ./waf install
+}}}
+
+During the configure step waf will check to ensure all dependencies are met and report any that are missing.
+
+PySoy itself depends only on Python 3.1+ and libsoy and is built using Distutils:
+{{{
+./setup.py build
+sudo ./setup.py install
+}}}
+
+With these steps you should be able to modify and test changes to the source.  Join #PySoy on irc.freenode.net for help and how to commit improvements back to the Mercurial repository.