From Scrabble3D Manual
Jump to: navigation, search

There is no need to run your own service to play with your friends. In addition to use the public server you can run games via direct connection. An own server makes only sense to provide it as 24/7 service for a large number of users.

The server program itself is available at Sourceforge, either for ARM CPUs (eg. SheevaPlug or Raspberry Pi) with the option to use mySQL 5.0, 5.5 or 5.6 (fits MariaDB 10.0.x), and for i386 with mySQL 5.0 (both run on Linux). The program utilizes port 5001; make sure the port forwarding is configured appropriately. Furthermore you need a working mySQL/MariaDB database management system that consists of a table "Users" (the database name is variable, e.g. Scrabble3D, the table name is fix).

Use the following sql statement to create the table "Users" with all required fields (NULL is required!):

`Name` text,
`Passwd` text,
`GamesPlayed` int(11) DEFAULT NULL,
`Rating` int(11) DEFAULT NULL,
`Registered` datetime DEFAULT NULL,
`LastConnect` datetime DEFAULT NULL,
`LastIP` text,
`LastMac` text,
`Messages` text,
`AllowKibitz` tinyint(1) DEFAULT NULL,
`Email` varchar(255) DEFAULT NULL,

In case of an exeption after the first start it might help to create one entry:

INSERT INTO `Users`(`Name`, `Passwd`, `Key`, `GamesPlayed`, `Rating`, `Registered`, 
`LastConnect`,`LastIP`, `LastMac`, `Messages`, `AllowKibitz`, `Email`) 
 VALUES ('testuser','password','1','1','1000','12/08/2012',

(Edit: Empty table should work well with the latest version).

The server program is not a daemon, which means you must not close the shell where you started it. Use a terminal multiplexer like GNU Screen to logout, nonetheless.

You can pass the following parameters with the program start:

ScrabbleServer v0.2
 -u <user>
 -p <password>
 -d <database>
 -h (Shows this help)

Those that are not specified as parameter have to be entered later. That makes sense for at least the password for security reason.

Errors are saved in /var/log/Scrabble3D, but most serial output goes to the shell.

Every game is stored as singular file with a running number. After a configurable period of non-access these files are deleted but backed up previously to the file backup.tar (it is just a tar ball and not packed automatically).

All variables are loaded at startup from the file ScrabbleServer.ini:

Current=Welcome to the Free International Scrabble3D Server! //Message shown on connect

GameNumber=43834 //internal value; file name increment
MaxDaysForStoredGames=7 //games that are not accessed within this time are backed up
NumberOfBestPlayers=20 //how many players should be reported on best info
MaxNumberOfAccounts=3 //max number of accounts per user (MAC address counts)
TimeToAfk=600000 //time without action until user is treated as away from keyboard in ms 

91:0e:4a:bf:10:d3=0 //you can ban users based on their MAC address; set value to 1 to activate 

To provide access to your server you may insert the address manually in the local Scrabble3D.conf:

<Servers Count="2">
 <f0 Name="Free International Scrabble3D Server" Address=""/>
 <f1 Name="FISS (old address)" Address=""/>

In case of a dynamically allocated IP address a DNS service provider is very useful. If your server runs 24/7 and if you want to make it public for all people the better way is to publish your address via automatical update. Please contact the author for this option.

GeoLogo.png Language: