Difference between revisions of "Setting Up a Shard"

m (Preparation)
(Dataserver setup)
Line 28: Line 28:
 
After the "keygen" command, two blocks of text have been printed. The first block goes into the dirtsand.ini file of the server, just copy-and-paste it there (copy only the lines starting with "Key"!). The second part is necessary for the client to connect to the server, save it to some file called "server.ini" that you send to the Windows machine (again, only the lines starting with "Server" must be copied).
 
After the "keygen" command, two blocks of text have been printed. The first block goes into the dirtsand.ini file of the server, just copy-and-paste it there (copy only the lines starting with "Key"!). The second part is necessary for the client to connect to the server, save it to some file called "server.ini" that you send to the Windows machine (again, only the lines starting with "Server" must be copied).
  
==IP addresses and folders==
+
==Remaining configuration==
  
 
The dirtsand.ini file needs one final touch: The IP addresses and paths to the files need to be changed to your setup. I assume that the full path to the DirtSand directory is "/home/user/dirtsand", usually you will just have to insert your username. If in doubt, run
 
The dirtsand.ini file needs one final touch: The IP addresses and paths to the files need to be changed to your setup. I assume that the full path to the DirtSand directory is "/home/user/dirtsand", usually you will just have to insert your username. If in doubt, run
Line 40: Line 40:
 
  Sdl.Path = /home/user/dirtsand/SDL
 
  Sdl.Path = /home/user/dirtsand/SDL
 
  Age.Path = /home/user/dirtsand/ages
 
  Age.Path = /home/user/dirtsand/ages
 +
 +
To properly host the ages, the Shard needs to know which ages are available. That's why you downloaded the SDL and age files at the beginning (just delete the Python folder in there, you only need it on the client machine). Copy the remaining two folders "SDL" and "dat" to the DirtSand directory, and rename "dat" to "ages". These are exactly the folders you just set for "Sdl.Path" and "Age.Path".
  
 
==Dataserver==
 
==Dataserver==
 +
 +
To complete the server, we need a minimalistic dataserver. We do not have to actually put any data on it, so that you can still put whatever you want into the client folder, but the client will still request some data and we must tell the server that there's nothing to reply with. The following command will create a bunch of empty files to achieve exactly that:
 +
<source lang="bash">cd ~/dirtsand
 +
mkdir data authdata
 +
touch data/Internal.mfs data/InternalPatcher.mfs data/ThinInternal.mfs authdata/Python_pak.list authdata/SDL_sdl.list</source>
 +
That's it, the little fake dataserver is complete! It is now your responsibility to make sure all the clients (if more than one person connects to the Shard) use the same dataset.
  
 
=Client setup=
 
=Client setup=

Revision as of 11:56, 2 August 2011

This tutorial documents the smallest possible setup for a Shard. It is intended to be used on a "normal" PC, to develop ages or the actual server and client software. You can however easily build a "production-style" Shard on top of this.

Preparation

You will need both a Windows machine for the client, and a Linux machine for the software. It is possible to do it all on one PC using a virtual machine and possible Wine, but that's beyond the scope of this tutorial.

On your Windows box, you need to

On the Linux machine

Server setup

The DirtSand server is not yet quite ready, we need to give it some final touches

Encryption keys

The connection between the server and the client is always encrypted. To make this work, you need to generate the necessary keys. Don't worry, DirtSand has it all built in (the paths assume that you installed DirtSand into ~/dirtsand, which is what the installation tutorial does):

cd ~/dirtsand
bin/dirtsand dirtsand.ini # start the server, another prompt will open
ds-902> keygen new # This may take some time and will generate some random series of characters
ds-902> quit # quit the server, go back to the shell

After the "keygen" command, two blocks of text have been printed. The first block goes into the dirtsand.ini file of the server, just copy-and-paste it there (copy only the lines starting with "Key"!). The second part is necessary for the client to connect to the server, save it to some file called "server.ini" that you send to the Windows machine (again, only the lines starting with "Server" must be copied).

Remaining configuration

The dirtsand.ini file needs one final touch: The IP addresses and paths to the files need to be changed to your setup. I assume that the full path to the DirtSand directory is "/home/user/dirtsand", usually you will just have to insert your username. If in doubt, run

echo $HOME/dirtsand

To find out the address of your machine, you can use the command "sudo ifconfig". Look for the line saying "inet addr" (if it's "127.0.0.1", you looked at the wrong interface). Be sure to have some kind of firewall between you and the internet!

Now open dirtsand.ini, and insert your IP address behind "File.Host", "Auth.Host" and "Game.Host". You will also need to edit the "Paths" section, this tutorial assumes it looks as follows:

File.Root = /home/user/dirtsand/data
Auth.Root = /home/user/dirtsand/authdata
Sdl.Path = /home/user/dirtsand/SDL
Age.Path = /home/user/dirtsand/ages

To properly host the ages, the Shard needs to know which ages are available. That's why you downloaded the SDL and age files at the beginning (just delete the Python folder in there, you only need it on the client machine). Copy the remaining two folders "SDL" and "dat" to the DirtSand directory, and rename "dat" to "ages". These are exactly the folders you just set for "Sdl.Path" and "Age.Path".

Dataserver

To complete the server, we need a minimalistic dataserver. We do not have to actually put any data on it, so that you can still put whatever you want into the client folder, but the client will still request some data and we must tell the server that there's nothing to reply with. The following command will create a bunch of empty files to achieve exactly that:

cd ~/dirtsand
mkdir data authdata
touch data/Internal.mfs data/InternalPatcher.mfs data/ThinInternal.mfs authdata/Python_pak.list authdata/SDL_sdl.list

That's it, the little fake dataserver is complete! It is now your responsibility to make sure all the clients (if more than one person connects to the Shard) use the same dataset.

Client setup