Difference between revisions of "Getting Started for Users"

From Sirikata Wiki
Jump to: navigation, search
(New releases dir links)
(Remove DYLD_LIBRARY_PATH notes since 0.0.18 has wrapper scripts, update instructions for clearing ogre.cfg)
Line 32: Line 32:
  
 
   cd sirikata_mac/bin
 
   cd sirikata_mac/bin
   DYLD_LIBRARY_PATH=../lib ./space
+
   ./space
 
+
The setting for DYLD_LIBRARY_PATH is required for it to find the libraries that are installed alongside it because they aren't installed to system directories that are already in the search path.  If you install to one of those directories (e.g. /usr/), then that setting will not be necessary.
+
  
 
space starts a space (world) locally. It is private and will only use the objects you start. cppoh.app is the client. By default, it loads up a few objects as well as your avatar. If everything worked, you should see a window pop up and start displaying the world.
 
space starts a space (world) locally. It is private and will only use the objects you start. cppoh.app is the client. By default, it loads up a few objects as well as your avatar. If everything worked, you should see a window pop up and start displaying the world.
Line 40: Line 38:
 
To run cppoh.app from the command line and add parameters, run it as
 
To run cppoh.app from the command line and add parameters, run it as
  
   DYLD_LIBRARY_PATH=../lib ./cppoh.app/Contents/MacOS/cppoh [--option=value]
+
   ./cppoh.app/Contents/MacOS/cppoh [--option=value]
  
 
==== Configuration ====
 
==== Configuration ====
Line 61: Line 59:
 
** Chances are you unzipped the sirikata package using Cygwin, which doesn't handle file permissions properly. Try unzipping using Windows' standard utilities.
 
** Chances are you unzipped the sirikata package using Cygwin, which doesn't handle file permissions properly. Try unzipping using Windows' standard utilities.
 
* The settings I chose for Ogre don't work and it doesn't pop up the configuration screen anymore.
 
* The settings I chose for Ogre don't work and it doesn't pop up the configuration screen anymore.
** In the sirikata_win32/bin/ directory, delete the file ogre.cfg. The next time you run, the configuration will pop up again.
+
** You need to clear out your ogre.cfg file. On Windows you can find this under, e.g., C:\Users\Username\AppData\Local\Sirikata. Under Linux and Mac it should be under ~/.sirikata. Delete the file ogre. and the next time you run the configuration will pop up again.
 
* I'm having another problem not covered here.
 
* I'm having another problem not covered here.
 
** Get in touch with the developers on the [http://groups.google.com/group/platformtalk developer mailing list] or via IRC (#sirikata on irc.freenode.net).
 
** Get in touch with the developers on the [http://groups.google.com/group/platformtalk developer mailing list] or via IRC (#sirikata on irc.freenode.net).

Revision as of 01:42, 4 January 2012

Downloading and Installing Sirikata

Note Currently, we don't package binaries for Linux. Linux users should check out and build the code themselves. This process is scripted, so it should be simple even though it takes a long time.

Windows

To run Sirikata, including the graphical client, you'll need to install two additional packages:

With these installed, simply download the latest package. Unzip it anywhere on your computer. You should then have directories that look like this:

* sirikata_win32/
 * bin/
 * include/
 * lib/
 * share/

Go into sirikata_win32/bin/ and run space.exe, then cppoh.exe. space.exe starts a space locally. It is private and will only use the objects you start. cppoh.exe is the client. By default, it loads up a few objects as well as your avatar. If everything worked, you should see a window pop up and start displaying the world.

Mac OS X

Download the latest package. Unzip it anywhere on your computer. You should then have directories that look like this:

* sirikata_mac/
 * Frameworks/
 * bin/
 * include/
 * lib/
 * share/

Go into sirikata_mac/bin/ and run space, then cppoh.app. To run these, you likely need to set DYLD_LIBRARY_PATH, e.g.:

 cd sirikata_mac/bin
 ./space

space starts a space (world) locally. It is private and will only use the objects you start. cppoh.app is the client. By default, it loads up a few objects as well as your avatar. If everything worked, you should see a window pop up and start displaying the world.

To run cppoh.app from the command line and add parameters, run it as

 ./cppoh.app/Contents/MacOS/cppoh [--option=value]

Configuration

See the Keybindings page for information about how to control your object.

When you first start the client, a window will pop up with the Ogre logo asking for some settings. Usually you only need to change two settings: from the top drop down, select 'OpenGL Renderer' and in the resulting option list chnage 'Fullscreen' to off. OpenGL is the more reliable default, but you may also try the Direct3D renderer (see 'Troubleshooting' below for more details).

Connecting to a Different Sirikata World

TODO

Troubleshooting

  • I'm getting the message 'This application has failed to start because d3dx9_42.dll was not found. Re-installing the application may fix this problem.'
    • You need to install the DirectX End-User Runtime. Make sure you've followed the instructions above.
  • Nothing is showing up.
    • Give it a minute or two on the first run. The default scene isn't small and the meshes need to be downloaded. On future runs, the content will be loaded from your local disk if possible, making it start up much more quickly. If, after a few minutes, still nothing shows up, get in touch with the developers as described below.
  • I'm getting a message that I don't have permissions to access a file when I try to run the space server.
    • Chances are you unzipped the sirikata package using Cygwin, which doesn't handle file permissions properly. Try unzipping using Windows' standard utilities.
  • The settings I chose for Ogre don't work and it doesn't pop up the configuration screen anymore.
    • You need to clear out your ogre.cfg file. On Windows you can find this under, e.g., C:\Users\Username\AppData\Local\Sirikata. Under Linux and Mac it should be under ~/.sirikata. Delete the file ogre. and the next time you run the configuration will pop up again.
  • I'm having another problem not covered here.