OpenBlox Game Engine Readme
---------------------------
Version 0.6 (bugfix release)
Installing on Windows
---------------------
(You'll need an Internet connection to run the Windows installer.
Note that it may take around 2-5 minutes to for the installer to download the required libraries.)
Be sure to keep the default installation location (C:\Program Files\OpenBlox); otherwise, OpenBlox won't work.
Also, if a message comes up concerning "EGG caching", you can safely press "No."
If there is a dialog box comes up about "default Python installation", press "Yes."
Merely run the given Windows installer; you may be using it to view this README!
If that's the case, proceed to the "Testing" section.
Installing on Linux
-------------------
System Requirements
-------------------
* Panda3D(available from http://panda3d.org/download.php, currently, you must download the SDK ("Panda3D SDK for Developers"), not "Panda3D Runtime for End-Users").
* Python 2.6
* wxPython (optional; install only if you want the GUI)
Python 2.6 should be installable from your package manager; consult its manual on how to install it.
If you're viewing this from the installer, install the above software; otherwise, install the above software and then run the installer.
Installing on Mac OSX
---------------------
System Requirements
-------------------
* Python 2.6
* Panda3D
* wxPython (optional; install only if you want the GUI)
* LuaJIT 2 beta 4
* Lupa 0.18
A DMG image for Panda3D is available from http://www.panda3d.org/download.php?platform=macosx&version=1.7.0&sdk .
Note that the OSX version of Panda3D requires the NVIDIA Cg Toolkit, which you can download at:
http://developer.download.nvidia.com/cg/Cg_3.0/Cg-3.0_July2010.dmg
A wxPython DMG is downloadable at:
http://downloads.sourceforge.net/wxpython/wxPython2.8-osx-unicode-2.8.11.0-universal-py2.6.dmg
Just run the wxPython installer inside the DMG image.
Lupa is downloadable from http://pypi.python.org/packages/source/l/lupa/lupa-0.18.tar.gz#md5=331237744561d41a1a659e514893d938 .
(Note: Lupa/Lua is a C application, and thus needs to be compiled. No pre-compiled binaries are yet availiable, otherwise this step would be unnecessary.
If you like, email the OpenBlox administrator at openblocks@users.sourceforge.net with the attached OSX binaries of Lupa, so others won't have to go through this step.)
To compile Lupa:
* Download LuaJIT (at http://luajit.org/download/LuaJIT-2.0.0-beta4.tar.gz)
* Untar the LuaJIT folder inside the Lupa directory
* Open a Terminal, and change directories to the LuaJIT folder
* Type "make" (without quotes)
* Type "cd .." (again, without quotes)
* Type "make" again
* Copy the build/lib.xxxxx-xxxx-2.6/lupa directory to the obengine/scripting/lupa directory inside your OpenBlox download archive.
Now you can proceed to the 'Testing' section...
Testing
-----------------
Windows
-------
Open OpenBlox from your Start Menu (All Programs > OpenBlox > OpenBlox).
Select the test world (World).
Press "Play game."
See the "Playing" section for more information.
Linux
-------
GUI
-------
Open OpenBlox from your desktop, or applications menu (the location varies across distributions).
Select the test world (World).
Press "Play game."
See the "Playing" section for more information.
Command-line UI (if you didn't install wxPython)
------------------------------------------------
Open up a terminal, and type "cd ~/OpenBlox" (without quotes).
Next, type "python oblaunch.py World" (again, without quotes).
See the "Playing" section for more information.
Mac OSX
--------
GUI
--------
Open the directory where you extracted OpenBlox.
Double-click oblaunchgui.py (If this step doesn't work, open up a terminal, change directories, and type "python oblaunchgui.py", without quotes ).
Select the test world (World).
Press "Play game."
See the "Playing" section for more information.
Command-line UI (if you didn't install wxPython)
------------------------------------------------
Open up a terminal, and change directories to where you extracted OpenBlox
Next, type "python oblaunch.py World" (again, without quotes).
See the "Playing" section for more information.
Playing
--------
You can move with the following keys:
Up arrow key: Move forward
Down arrow key: Move forward
Left arrow key: Rotate left
Right arrow key: Rotate right
Space: Jump
(Note that the character can fall down at times, so either restart OpenBlox, or set your avatar upright by carefully pressing Jump)
Creating your own games
-----------------------
The OpenBlox wiki has all the info you need to make your very own OpenBlox games.
Go to:
http://openblox.sf.net/?q=wiki
for more information, and a tutorial.
FAQ
-----------------
The world launcher opens, and I can select a game, but the actual game never shows up!
You do not have Panda3D installed. See one of the above sections on how to install it.
Note that Panda3D will be integrated into OpenBlox in a future release.
Nothing runs!
Python isn't installed. Again, see one if the above sections on how to install it.
In a future release, Python will(hopefully) no longer be a dependency, so you don't have to worry about this for long.
Further support
-----------------
The OpenBlox Wiki:
http://openblox.sf.net/?q=wiki/main-page
The OpenBlox Forums (always search for a solution before asking for help):
http://openblox.sourceforge.net/?q=forum
Download Latest Version
OpenBlox 0.6.2 (Mac OSX, others) (11.8 MB)
