PlaneShift Compiling Guide

Table of Content

Source Revisions
Working Directory
Install Tools
Download Source Code
Compile the Code
Get the Server Running (optional)
Get the NPC Server Running
Mini Scripts (optional)
Get the Client Running
Common problems / Troubleshooting
Getting Help
Credits

Select your Configuration

Currently compatible with trunk of PS:
CAL3D SVN revision: CAL3D_SOURCE_REV_HEAD
CS SVN revision: CS_SOURCE_REV_HEAD
+ for windows only manually apply 39918 as patch to fix startup crashes

Set Working Directory

The first step is to create your development directory. If you want to choose a specific directory, you can do that, however this guide will assume you use:

Install Tools

Password:
OK, I'll ask you some questions and update the configuration file in '/sw/etc/fink.conf'.
In what additional directory should Fink look for downloaded tarballs? []
Which directory should Fink use to build packages? (If you don't know what this means, it is safe to leave it
at its default.) []

Should Fink try to download pre-compiled packages from the binary distribution if available? [y/N] n
(1)     Quiet (do not show download statistics)
(2)     Low (do not show tarballs being expanded)
(3)     Medium (will show almost everything)
(4)     High (will show everything)

How verbose should Fink be? [4] 4

Proxy/Firewall settings
Enter the URL of the HTTP proxy to use, or 'none' for no proxy. The URL should start with http:// and may
contain username, password, and/or port specifications. Note that this value will be visible to all users on
your computer.
Example, http://username:password@hostname:port
Your proxy:  [none]
Enter the URL of the FTP proxy to use, or 'none' for no proxy. The URL should start with http:// and may
contain username, password, and/or port specifications. Note that this value will be visible to all users on
your computer.
Example, http://username:password@hostname:port
Your proxy:  [none]
Use passive mode FTP transfers (to get through a firewall)? [Y/n] y

Mirror selection
All mirrors are set. Do you want to change them? [y/N] n

Writing updated configuration to '/sw/etc/fink.conf'...

Server Databases

Download Source Code

Compile the Code

Get PS Art

Minimal Art from SVN

Released Art from a PlaneShift installation

If you want your compiled client to have all art (icons, skins, characters, ...) then you need to get the art from an official released client.
If you have previously downloaded a release package, you can use it to get the needed files. The files are in the "art" and "data" directories. However you should keep the following folders in data because the contents from the SVN are usually more recent and updated: gui, shader, shader-snippets and renderlayers.

For those who seek to only build the client, this is all you need. Start the client, and go enjoy the game.

Notice: you will also need this art to run the (SVN) server.

Get the Server Running

Create the Database

mysql> create database planeshift;
mysql> GRANT ALL PRIVILEGES ON planeshift.* TO planeshift@localhost IDENTIFIED BY 'planeshift';
mysql> quit

mysql> use planeshift;
mysql> source create_all.sql;
mysql> quit

Sometimes it is convenient to use another database name, user or password for development. In this case the file psserver.cfg has to be updated with the changed values. To change the database name the file create_all.sql also has to be modified.

Running the Server

PS Server: loadmap npcroom1
PS Server: loadmap npcroom2
PS Server: loadmap npcroom_corr
PS Server: loadmap podium
PS Server: spawn
PS Server: ready

Additional maps can be listed with the "maplist" command, and loaded via the "loadmap" command. To see a list of all available psserver commands, type "help". You can shut down the server with "quit".

You should now be able to start psclient and log in. The server is localhost on port 13331, if your server is located somewhere else or you want to connect to somebody's else server, you need to modify the servers list.

To perform server actions you just have to log in as a GM character. If you want a list of commands available execute the /admin command. You will be given the list of available commands for your account's security group. When logged in with this account, you can view the in-game help to obtain the full list of available commands and syntax. If you loaded any maps other than the test map "npcroom", you may teleport to them by using the command: "/teleport me map [mapname]"

Get the NPC Server Running

jam navgen
./navgen
./psnpcclient

Get the Client Running

To have the client running you need at least two parts, described in the next chapters:
- ensure you are using the Crystal Space base configuration files
- ensure you are using some client art, better if the released art.

Note: If you just want to run the client and use it to connect to the main server, you can copy/paste the /art and the /data folder from the release client, and skip the rest of this section.

Pointing to Crystal Space configuration files

VFS.Mount.config = $@data$/config-plugins$/

VFS.Mount.config = $@data$/config-plugins$/,$/development$/CS$/data$/config-plugins$/

Pointing to PlaneShift release art files

1) Open up the vfs.cfg file in the PlaneShift dir. Find the list of mount points (VFS.Mount.* lines) and add a mount for each custom dir you wish to use. For this example, I will mount a pre-installed package. Using the VFS syntax key at the top, add a mount as follows:

VFS.Mount.bins = $/development$/PSbins$/

2) Open psclient.cfg (or the cfg file of the PS application you want to use a mount). To continue the above example, I can set the SVN build client to use the installed package's maps by editing the following in psclient.cfg:

Planeshift.GUI.Skin.Base = /bins/art/skins/base/client_base.zip
PlaneShift.GUI.Skin.Dir = /bins/art/skins/
PlaneShift.GUI.Skin.Selected = elves.zip

If you wish the server and NPC client to use these as well, modify/add that line to their cfg files too.

Note: PS mounts such as Planeshift.GUI.Skin.Base take a VFS path to a ZIP file, as opposed to a dir. If you wish to mount from an uncompressed dir, you need to add a slash to the end of the path:

Pointing the client to your local server

To have your client connect to your local server, you just need to modify /planeshift/data/servers.xml adding one line like:

<server name="Localhost" description="Local test server" ip="localhost" port="13331" />

Common Problems / Troubleshooting

Generic Problems

If sounds does not work: change to Open AL in pslaunch.

If you get errors about art/skins/default.zip, change it to elves.zip in psclient.cfg. (there is no default.zip in the production art.

If your client crashes right after loading, or when looking at spells/effects being cast, add: Video.OpenGL.UseExtension.GL_ARB_vertex_buffer_object = true to your psclient.cfg (notice that sometimes a client prefers to take the file located in %appdata%) It seems some graphics cards cannot handle fancy effects without it. You can also set this by starting the launcher and clicking options. (Notice this also applies to ATI cards, ignore what pslaunch says about them.)

LINUX

Problem: You are getting this error:

Getting Help

If you have trouble getting any of this to work, please feel free to contact us and we will do our best to help.
There is an IRC channel dedicated to providing help with building PlaneShift:

Server: irc.freenode.net
Channel: #PlaneShift-build

Credits