Difference between revisions of "Server Setup"

Revision as of 16:23, 18 June 2005

This page will guide you through the process of setting up an ASSS server. Before beginning you should definetely read the userguide located in /docs or here. It's probably most important to read the "File Layout" section, which describes the what you're looking at when you extract the ASSS package. Afterwards, visit the ASSS website and download the release you're looking for (Linux or Windows).

You also want to make sure that if you are not going to use MySQL or Python that you disable the appropriate modules. Or conversely, make sure that all the System Requirements are installed before proceeding any further.

Building Linux Version

• tar zxvf asss-1.x.y.tar.gz
• cd asss-1.x.y/src
• edit Makefile (in your favorite text editor)
• make

Configuring ASSS

You will probably want to take a look at the modules.conf config file before running ASSS for the first time to check for dependency issues.

Note: A ';' refers to a comment and all following characters before a newline are ignored.

Changing Zone Name / Description

The zone name and description are both defined in the /conf/global.conf file. Edit this file and you will be able to change your zone's name / description:

[ Billing ]
;Proxy = bin/proxy
IP = 127.0.0.1
Port = 1850
ServerName = _ZONENAME_
Password = billingpw

[Directory ]
Name = _ZONENAME_
Description = _ZONEDESCRIPTION_

Changing Staff

Your staff is defined in /conf/staff.conf

In order to give yourself sysop you would change it to:

[GroupPasswords]
; this section is just "group-name = password"
; groups that aren't listed can't be logged into by password.

; the rest of the sections in this file are named after arena groups

[(global)]
; these are "playername = group"
_YOURNAME_ = Sysop

You may also need to log in once using ?passwd <subspace login password> and rejoining the zone before commands work. This is to validate that only someone using your password is allowed to use sysop commands, in case the Billing Server goes down, or you don't use a biller.

Changing Map

To change the map you need to first put the map (.lvl file) you want to use into the /maps/ directory. Then you edit the settings in the arena you want your map to be in. Change General:Map to be the name of the .lvl file you want it to use.

Changing Settings

To change what default arena is using, edit /arenas/(default)/arena.conf. Note that this file may use data from other files using #include statements. To override certain settings without editing them from the original files, you can define them at the end of a file. For example, if you wanted svs settings, but the map to be "mymap.lvl" you could set your arena.conf to be:

; drop in all of svs settings here
#include conf/svs/svs.conf

[General]
Map = mymap.lvl

Changing Modules

You can change which modules your server uses. First make sure the compiled .dll file with your plugin is in the /dist/bin/ directory. Let's say our .dll file was called MyModules.dll and the module we were trying to use was called FreqWatcher. Now edit /conf/modules.conf and at the very end add:

MyModules:FreqWatcher

The order of the modules.conf file is important, as files that depend on other files must be listed after them (unless they take advantage of MM_POSTLOAD in their main module function). Usually when the server aborts while loading, the problem can be traced back to the modules.conf file (a module is missing, or in the wrong place).

Adding Your Zone to a Directory server

Uncomment the directory module in modules.conf:

directory
;billing

Edit the Directory section in global.conf, and add in directory server addresses in Server1, Server2, etc ... At this time the following directory servers work: sscentral.sscuservers.net and sscentral.subspacehq.com.

When you run ASSS you should see the following output on module load:

I <cmod> loading C module 'directory' from 'internal'
I <directory> server on port 5000 using name 'YOUR ZONE NAME HERE'
I <directory> using 'sscentral.sscuservers.net' at 62.65.37.101 as a directory server
I <directory> using 'sscentral.subspacehq.com' at 199.232.158.5 as a directory server

and the following during normal ASSS operation:

D <directory> sending information to directory servers

Running ASSS

To run the windows version of ASSS, locate ASSS.bat and double click it. That's it! You now have your own zone up and running.

In Linux, just run ./scripts/run-asss, which handles ?shutdown -r. IMPORTANT: You will need to edit the ASSSHOME variable defined inside the script to point to the directory you extracted ASSS.