Difference between revisions of "Development:DIRTSAND"

(start of a dirtsand wiki page)
 
(add setup steps)
Line 16: Line 16:
 
* zlib [zlib1g-dev]
 
* zlib [zlib1g-dev]
 
* git (to get the sources) [git]
 
* git (to get the sources) [git]
 +
 +
=Building the code=
 +
 +
Run the following commands in an appropriate folder:
 +
<source lang="bash">git clone git://github.com/H-uru/dirtsand.git
 +
cd dirtsand
 +
mkdir build
 +
cd build
 +
cmake .. -DCMAKE_INSTALL_PREFIX=/opt/dirtsand
 +
make
 +
sudo make install</source>
 +
 +
If you run into any errors about finding libraries or headers, make sure you have the *development* versions of all of the required libraries, and that they are in your path.  You can also use the cmake-gui to help cmake locate the missing paths and files.
 +
 +
You should not continue beyond this step before completing above commands without error messages!
 +
 +
=Setting up the server=
 +
 +
Now the database server needs to be set up and DirtSand needs to be configure to work with it.
 +
 +
== Set up the postgres user ==
 +
 +
The command
 +
<source lang="bash">sudo -u postgres psql</source>
 +
will open a postgres shell that you can type commands into. The following commands will create a user to be used by DirtSand (replace "<password>" by some random series of characters):
 +
CREATE USER dirtsand WITH PASSWORD '<password>';
 +
CREATE DATABASE dirtsand WITH TEMPLATE = template0 ENCODING = 'UTF8';
 +
ALTER DATABASE dirtsand OWNER TO dirtsand;
 +
\q
 +
 +
== Install the UUID functionality ==
 +
 +
This may be provided by your OS distribution.  In Ubuntu, simply install the postgresql-contrib package to provide the necessary libraries and installation scripts.  If your distribution does not provide a contrib or uuid-ossp bundle, you can get it and build it yourself from the sources provided at:  http://www.ossp.org/pkg/lib/uuid/
 +
 +
Once you have the ossp, you can add it to the dirtsand database by running the import script:
 +
 +
<source lang="bash">sudo -u postgres psql -d dirtsand < /path/to/uuid-ossp.sql</source>
 +
 +
Example for Ubuntu 10.10:
 +
<source lang="bash">sudo -u postgres psql -d dirtsand < /usr/share/postgresql/8.4/contrib/uuid-ossp.sql</source>
 +
 +
== Set up the dirtsand database ==
 +
 +
Make sure that your working directory is the "dirtsand" folder you cloned above.
 +
<source lang="bash">sudo -u postgres psql -d dirtsand < db/dbinit.sql
 +
sudo -u postgres psql -d dirtsand < db/functions.sql</source>
 +
 +
 +
If there were no other errors, your database should be ready for DIRTSAND
 +
 +
 +
== Configure dirtsand ==
 +
 +
A sample dirtsand.ini has been provided in the root of the dirtsand sources.  We can copy this to our install directory and then edit the fields we need. If you have dirtsand installed to somewhere other than /opt/dirtsand, you will also need to point the configuration to the right paths too.
 +
 +
<source lang="bash">sudo cp dirtsand.sample.ini /opt/dirtsand/dirtsand.ini
 +
sudo adduser dirtsand
 +
sudo chown dirtsand /opt/dirtsand/dirtsand.ini
 +
sudo -u dirtsand <your-favorite-editor> dirtsand.ini</source>
 +
 +
For now, only change the database settings - usually, the line containing "Db.Password" should be the only one you need to change. It must be set to the same random series of characters that you used when creating the user in postgres.
 +
 +
== Done! ==
 +
 +
That's it for the actual server setup. To complete this installation to a working Shard, more work is required - have a look at the [[Development:Sandbox Shard|Sandbox Shard tutorial]].

Revision as of 15:55, 31 July 2011

This page contains information about how to set up DirtSand, the "D'ni in Real-Time Server and Network Dæmon" by Zrax. It is a server compatible with the CyanWorlds.com Engine. CWE needs a server to run at all, which makes setting up DirtSand (or a compatible server) a necessary part of any CWE setup. DirtSand currently works only on Linux operating systems.

This tutorial assumes that you run the DirtSand server and the database it uses on the same machine, which will usually be the case. If you plan to use a dedicated database server, you probably know enough about Postgres and Linux do change the setup accordingly.

Git

DirtSand uses git for its source control needs. If you're already familiar with git, some of these instructions may seem obvious to you. If you're not familiar with git, it is recommended that you read through some of the excellent articles in the GitHub help area.

Dependencies

You will need to install some applications and libraries before you can build DirtSand. The package names in brackets are tested on Debian, they should be called similar on other distributions.

  • GCC 4.4+ (might work with other C++0x compliant compilers, but untested) [gcc]
  • Postgres, server and development libraries [postgresql, libpq-dev]
  • OpenSSL [libssl-dev]
  • libreadline [libreadline6-dev]
  • zlib [zlib1g-dev]
  • git (to get the sources) [git]

Building the code

Run the following commands in an appropriate folder: 

git clone git://github.com/H-uru/dirtsand.git
cd dirtsand
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/opt/dirtsand
make
sudo make install

If you run into any errors about finding libraries or headers, make sure you have the *development* versions of all of the required libraries, and that they are in your path. You can also use the cmake-gui to help cmake locate the missing paths and files.

You should not continue beyond this step before completing above commands without error messages!

Setting up the server

Now the database server needs to be set up and DirtSand needs to be configure to work with it.

Set up the postgres user

The command 

sudo -u postgres psql

will open a postgres shell that you can type commands into. The following commands will create a user to be used by DirtSand (replace "<password>" by some random series of characters): 

CREATE USER dirtsand WITH PASSWORD '<password>';
CREATE DATABASE dirtsand WITH TEMPLATE = template0 ENCODING = 'UTF8';
ALTER DATABASE dirtsand OWNER TO dirtsand;
\q

Install the UUID functionality

This may be provided by your OS distribution. In Ubuntu, simply install the postgresql-contrib package to provide the necessary libraries and installation scripts. If your distribution does not provide a contrib or uuid-ossp bundle, you can get it and build it yourself from the sources provided at: http://www.ossp.org/pkg/lib/uuid/

Once you have the ossp, you can add it to the dirtsand database by running the import script: 

sudo -u postgres psql -d dirtsand < /path/to/uuid-ossp.sql

Example for Ubuntu 10.10: 

sudo -u postgres psql -d dirtsand < /usr/share/postgresql/8.4/contrib/uuid-ossp.sql

Set up the dirtsand database

Make sure that your working directory is the "dirtsand" folder you cloned above. 

sudo -u postgres psql -d dirtsand < db/dbinit.sql
sudo -u postgres psql -d dirtsand < db/functions.sql


If there were no other errors, your database should be ready for DIRTSAND


Configure dirtsand

A sample dirtsand.ini has been provided in the root of the dirtsand sources. We can copy this to our install directory and then edit the fields we need. If you have dirtsand installed to somewhere other than /opt/dirtsand, you will also need to point the configuration to the right paths too. 

sudo cp dirtsand.sample.ini /opt/dirtsand/dirtsand.ini
sudo adduser dirtsand
sudo chown dirtsand /opt/dirtsand/dirtsand.ini
sudo -u dirtsand <your-favorite-editor> dirtsand.ini

For now, only change the database settings - usually, the line containing "Db.Password" should be the only one you need to change. It must be set to the same random series of characters that you used when creating the user in postgres.

Done!

That's it for the actual server setup. To complete this installation to a working Shard, more work is required - have a look at the Sandbox Shard tutorial.