ASSS Wiki - User contributions [en]

MERVBot Tutorial

2009-08-03T09:38:37Z

Doc flabby: fixed tutorial link

This tutorial is based on the ever-popular MERVBot Tutorial by Underlord. It has since been updated to reflect new changes with MervBot. To see examples of how to use this instruction, see [[MERVBot Example Code]].

This tutorial also assumes that you have a basic knowledge of C++. If you don't, check out cplusplus.com's great [http://www.cplusplus.com/doc documentation].

==Setting up a MERVBot (plugin)==

[http://mervbot.com MERVBot download site]

===Obtaining MERVBot===

* Download the [http://mervbot.com/files/MERVBot.rar latest build].
* Unrar MERVBot.rar into a new folder. (example c:\program files\continuum\mervbot)
* Unzip src.zip into "src" subfolder of that new folder (example c:\program files\continuum\mervbot\src)

===Preparing to write a plugin===

''Note:'' if you only want to execute someone's premade plugin (.dll), skip to [[MERVBot Tutorial#Run your bot dll|step 4]], otherwise continue to learn how to make your own bot

Download [http://www.mervbot.com/files/Tutorial.rar DLL-plugin Tutorial] and unzip Tutorial.zip (containing spawn.h, spawn.cpp, and command.cpp) into a "tutorial" subfolder of that new folder. (example c:\program files\continuum\mervbot\src\tutorial).

''File descriptions:''
* spawn.h = declare/initialize globals
* command.cpp = code for commands coming into bot (ie /!help, /!play, etc)
* spawn.cpp = code that interacts with bot spawns

===Microsoft Visual c++===

<ol>
<li>Start Visual Studios 6.0.
<li>Click the Drop Down Menu labeled "File" at the top left of your screen.
<li>Click "New".
<li>On the next screen that comes up, choose from the Project tab, then Win32 Dynamic-Link Library
<li>Select the "/src" folder as the base folder (example c:\program files\continuum\mervbot\src)
<li>Name your project "mybot". This will make a "mybot" subfolder in your "src" folder. Click OK. (example creates c:\program files\continuum\mervbot\src\mybot)
<li>Choose to create an "Empty DLL project".
<li>Click "Finish".
<li>Click the Drop Down Menu labbled "Project".
<li>Click "Add To Project Files"
<li>Copy only spawn.h, spawn.cpp, and command.cpp from the "tutorial" folder into the this new folder. (example from c:\program files\continuum\mervbot\src\tutorial to c:\program files\continuum\mervbot\src\mybot)
<li>Click the Drop Down Menu labelled "Build".
<li>Click "Build (dll name)" - where (dll name) is "mybot"
<li>Go into your "mybot" folder and look for a folder named "Debug"
(example c:\program files\continuum\mervbot\src\mybot\debug)
<li>Your new DLL will be in that folder. (example mybot.dll)
<li>Copy mybot.dll to your base folder that has mervbot.exe in it (example c:\program files\continuum\mervbot)
</ol>

===Run your bot dll===

To run your bot you need your DLL (mybot.dll), Commands.txt, MERVBot.exe, MERVBot.ini, Operators.txt, Spawns.txt, and zlib.dll all in one folder (example c:\program files\continuum\mervbot).

<ol>
<li>Edit spawns.txt. '''Read every word of spawns.txt to find out what needs to go in there.'''

<br>
''Example:''
<pre>2v2-Bot-League : botpw : 2v2a : 2v2league : staffpw</pre>

''Note:'' The bot will attempt to create the name if it doesn't exist already.

<li>Edit MERVBot.ini
<br>
<br>
<pre>[Login]
Zone=216.33.98.254:21000 // your zone IP:PORT available from zone.dat in Continuum dir
</pre>

<li>Edit operators.txt. '''Read every word of operators.txt to find out what needs to go in there.'''<br />

''Example:''
<pre>
4:my_name:
4:another_sysop:
3:other_person:
</pre>

<li>Make sure the bot is on vip.txt or has smod+ access, then run MERVBot.exe.

<li>You can now edit your plugin code by opening "mybot.dsw" (example c:\program files\continuum\mervbot\src\mybot\mybot.dsw) in Microsoft Visual C++. Edit the spawn.h, spawn.cpp, and command.cpp to create your plugin, then build, copy your updated DLL to your MERVBot.exe folder and then execute the bot. Use the tutorial to get ideas on how to implement certain types of features into the bot.

</ol>

==Player Commands - (command.cpp)==

This section describes how to implement player commands into your plugin. Commands are sent to the botInfo::gotCommand function in command.cpp.

Example (makes bot reply to !test with "hi"):
<pre>
void botInfo::gotCommand(Player *p, Command *c) {
switch (p->access)
{
case OP_Moderator:
{
// handle moderator-operator commands here.
}
case OP_Player: //appropriate staff rank here.
{
if (c->check("test")) //replace "test" with whatever command you want
{
//put your command code here
sendPrivate(p,"hi"); //example
}
}
</pre>

===How to have commands with numerical parameters===
Example (!test #):
<pre>
if (c->check("test")) { // reads in test #, default to 1 if invalid number input
int temp = 1;

if (isNumeric(c->final))
temp = atoi(c->final);
</pre>

===How to have player name as input===
Example (!rank player):
<pre>
if (c->check("rank"))
{
String player_name = c->final;

if (player_name.IsEmpty()) // default name to self if invalid name
player_name = p->name;
</pre>

===How to have multi-parameter input===

Use the CRT function sscanf() to scan the string for the values.

Example (!squads squadA vs squadB ''or'' !squads teamA:squadA:teamB:squadB):
<pre>
else if (c->check("squads"))
{
char squadA[20], squadB[20];
int teamA, teamB;

strncpy(squadA, "", 20);
strncpy(squadB, "", 20);

int n_found;

//Note: %[A-Za-z ] is equivalent to %s, but allows an internal space.

//scan the string for the two squads separated by " vs "
n_found = sscanf(c->final, "%[A-Za-z ] vs %[A-Za-z ]", squadA, squadB);

//if that fails, scan the string for freqA:squadA:freqB:squadB
if (n_found < 2)
sscanf(c->final, "%d:%[A-Za-z ]:%d:%[A-Za-z ]", &teamA, squadA, &teamB, squadB);
}
</pre>

===Help Menu===
When a player sends !help to the bot, MERVBot calls botInfo::gotHelp() in each plugin loaded.
<pre>
void botInfo::gotHelp(Player *p, Command *c)
{
if (!*c->final)
{
sendPrivate(p, "4v4 Bot General Commands:");
sendPrivate(p, "------------------------");
sendPrivate(p, "!caps - get captain names");
sendPrivate(p, "!roster <squad> - get roster of a squad");
sendPrivate(p, "!schedule- get current schedule");
sendPrivate(p, "!score - get current score");
</pre>

==Event Calls==

MERVBot is event based, so when making a bot you need to decide what will happen at certain events. Normal plugins need to consider what happens when bot enters arena, player enters arena, player leaves arena, player events like kill, shipchange, teamchange, spec, move then any other relevant events to your bot. Just worry about events that are relevant to the tasks your bot is doing.

MERVBot sends events to botInfo::gotEvent() in spawn.cpp. Each supported event is already present and categorized in gotEvent(), along with the paramters that MERVBot sends with the event. When a plugin wants the bot to do something, it sends tell(event) to the bot.

See dllcore.h for a list of current events and their descriptions. Dllcore.h also contains functions (like makeFollowing) to make events to send back to the bot via tell().

<pre>tell(makeFollowing(false));</pre>

==The Messaging System==

Private message - void sendPrivate(Player *player, char *msg);

''Examples:''

<pre>
sendPrivate(p,"hi");

String s="test";
sendPrivate(p,s);

String s="test";
s += "ing";
sendPrivate(p,s);

char captain1[20];
char captain2[20];
strncpy(captain1,"",20);
strncpy(captain2,"",20);
sendPrivate(p,(String) captain1 + " and " + (String) captain2 + " are the captains.");
</pre>

Team message - void sendTeamPrivate(Uint16 team, char *msg);<br />
<blockquote>Examples: <br />
a) sendTeamPrivate(8025,"hi spec freq");<br />
b) Uint16 test=0; sendTeamPrivate(test,"hi freq 0");<br />
</blockquote>

Public message - void sendPublic(char *msg);<br />
<blockquote>Example: sendPublic("*arena " + (String) p->name + " is now a captain");<br />
</blockquote>
Chat channel message - void sendChannel(char *msg);<br />
<blockquote>Example: sendChannel("hi chat channel");<br />
</blockquote>
Remote private message - void sendRemotePrivate(char *name, char *msg);<br />
<blockquote>Example: sendRemotePrivate("Player01", "hi");<br />
</blockquote>

Note: to have bot print several lines of text fast it needs sysop in the
arena (sysop in arena bot first spawns to also) otherwise it'll print slow to avoid being
kicked for spam

===Output of data in messages===
<p>An example of using normal strings to output data/messages.</p>
<pre>
// does *arena X pilots left in game
// NOTE: variable temp needs to be defined with some value

String s = "*arena ";
s += temp;
s += " pilots left in the game.";

sendPublic(s);
</pre>
Or,
<pre>
//NOTE: this can be considered inefficient.

sendPublic("*arena " + (String)temp + " pilots left in the game");
</pre>

<p>An example using sprintf to align/space data, where output data will be in this approximate format.</p>
<pre>
// output data will be in this approximate format (not lined up perfectly because of html)
// --------------------------------------------------------------------------------------
// Squad: squadname PTS FPTS K D DMG DEALT TAKEN F FK FLT
// --------------------------------------------------------------------------------------
// PlayerA 10000 500 116 101 9999 99999 10 150 980:55
// PlayerB 500 200 7 5 9999 99999 5 3 0:04

char str[255];
sendPublic("*arena--------------------------------------------------------------------------------");

sprintf(str, "*arena Squad: %-20s PTS FPTS K D DMG DEALT TAKEN F FK FLT",
freqs[freq].freqname
);

sendPublic(str);

sendPublic("*arena--------------------------------------------------------------------------------");

// assuming existing freqs struct with data
for (pilot=freqs[freq].playercount-1; pilot>=0; pilot--)
{
// on freq squad so print stats
char outString[255];

sprintf(outString, "*arena %-20s %12d %8d %3d %3d %10d %6d %2d %3d %3d:%02d",
freqs[freq].pilots[pilot].name,
freqs[freq].pilots[pilot].points,
freqs[freq].pilots[pilot].flagpoints,
freqs[freq].pilots[pilot].kills,
freqs[freq].pilots[pilot].deaths,
freqs[freq].pilots[pilot].dmgdealt,
freqs[freq].pilots[pilot].dmgtaken,
freqs[freq].pilots[pilot].flags,
freqs[freq].pilots[pilot].flagkills,
freqs[freq].pilots[pilot].flagtime /60,
freqs[freq].pilots[pilot].flagtime %60
);

sendPublic(outString);
}

// Notes: sprintf format = sprintf(output char string, spacing, variables)
// Notes: s = chars, d = integer, - = left align, right align default
// Notes: doing %02d = put 0 in front if not 2 digits, %3d:%02d makes 0:04 format
</pre>

==Time==

Each time MERVBot sends an EVENT_Tick to a plugin (once a second), the default handler code decrements each value in an array of countdowns. You can modify the number of countdowns and add code to occur at a specific value for one of the countdowns.

Setup number of timers and initialize in spawn.h:
<pre>
class botInfo
{
#define COUNTDOWNS 10 // how many countdowns you want
int countdown[COUNTDOWNS]; // this gives you 10 timers

// unrelated code

public:
botInfo(CALL_HANDLE given)
{
countdown[0] = 0;
countdown[1] = 60; // 60 seconds
//
// initialize values
//
countdown[9] = 5*60; // 5 minutes
</pre>
Using timer functions in spawn.cpp:
<pre>
case EVENT_Tick:
{
for (int i = 0; i < COUNTDOWNS; ++i) //cycles through each countdown you have
--countdown[i]; //note that countdowns will continue decrementing past 0.

if (countdown[1] == 2) // when timer #1 hits two seconds
{
// do stuff here when timer #1 hits 2 seconds
// example: sendPublic("two seconds left, setting timer to 1 minute");
// example: countdown[1] = 60; // change timer #1 value
}
</pre>

You can then have events (such as EVENT_PlayerDeath) change the value of a countdown to make the bot do something a set time after an event occurs.

=== Tracking time not using countdown[n] ===

This is a solution to a common problem of determining the amount of time it takes for something to occur. Using basic math, we record a start-time B, and an end-time E, both in the unit of seconds, we calculate the time elapsed by E-B.

Lucky for us, Windows provides a function called GetTickCount() that is a measurement of time (milliseconds) that we can use for such cases.

So:
<pre>
int begin = GetTickCount();

// do some code here.

int end = GetTickCount();

int delta = (end - begin) / 1000; // elapsed time converted to seconds from milliseconds
</pre>

=== Obtaining the current time ===

''Requirements:'' Include <time.h>.

Use:
<pre>
char u[100];
time_t t=time(NULL);
tm *tmp = localtime(&t);
strftime(u,99,"%c",tmp);
sendPublic("Current date and time: " + u);
</pre>

==Writing Functions==

For this example, we will take the function called closeto, which determines
if a player exists in an specific radius around a point. Now to apply this function to a MervBot plugin, you need to write it into the spawn.cpp - at the top of the file in the //////// DLL "import" //////// setion, as below:
<pre>
//////// DLL "import" ////////

bool closeto(Player *p, int x, int y, int tolerance)
{
// Requires the function abs() to be declared elsewhere.
// Return if player p is in area of square with center x, y
// and radius = tolerance
return (abs((p->tile.x) - x) - tolerance) && (abs((p->tile.y) - y) - tolerance);
}
</pre>

If you want your function to have access to the data from spawn.h botInfo class, you make the function apart of it. To do this, we add the '''botInfo::''' infront of the function name, in spawn.cpp.
<pre>
//////// DLL "import" ////////

bool botInfo::closeto(Player *p, int x, int y, int tolerance)
{
...
}
</pre>
In '''spawn.h''', add your method's prototype without botInfo::, it will look
like this:
<pre>
//...
botInfo(CALL_HANDLE given)
{
// ...
}
bool closeto(Player *p, int x, int y, int tolerance); // Your function prototype.

void clear_objects(); //provided by Catid, and already exists.
void object_target(Player *p); //provided by Catid, and already exists.
// ...
};
</pre>
If you're not familiar with prototypes, notice it is similar to that in your spawn.cpp, but without the botInfo::, and a trailing ;.

===Function notes===

Remember that you can pass variables [http://www.cplusplus.com/doc/tutorial/tut2-3.html by reference]. If variables are passed by reference, any changes a function makes to the variables will remain after the function returns.

From time to time you will need to pass an array to a function. An example illustrating this is:
<pre>
int freqs[5]; // declare our example data.

// call function - notice freqs and not freqs[5] or freqs[].
my_function(freqs); //You're not passing the array itself, just a pointer to the array.

// function - notice freqs[] and not freqs[5] or freqs
void my_function(int freqs[]) {} //You're specifying that the freqs parameter is an array
</pre>

==Cycling through players==

MERVBot stores player-related data in a linked list. A linked list is a datatype that stores its data in a series of structures linked to each other, hence the name.

To search through the players in the arena, just start at the first link, then continue through all the following links until you reach the end:
<pre>
_listnode <Player> *parse = playerlist->head; //set to first link of the player linked list

while (parse) //parse will be NULL when we reach the last link
{
Player *p = parse->item; //item is the actual data stored in the link

// do functionality here
// Example 1: sendPrivate(p,"*watchdamage"); // turns on all pilot's watchdamage
// Example 2: if (p->safety != 0) sendPrivate(p,"*spec"); // spec all pilots in safe zone

parse = parse->next; //set parse to the next link
}
</pre>

For example, assuming our bot has smod+ privilages, the following code will set all non-spectator players to a specific ship. First begin by adding the following function prototype to the spawn.h in the botInfo class:
<pre>
void handleCmdSetShip(enum Ship_Types ship);
</pre>

In spawn.cpp add:
<pre>
void botInfo::handleCmdSetShip(enum Ship_Types ship)
{
//Note that the parameter ship is of the Ship_Types enum,
//so its value is hopefully restricted to the proper types.

_listnode <Player> *parse = playerlist->head;
while (parse)
{
Player *p = parse->item;

if ( p->ship != ship && p->ship != SHIP_Spectator )
sendPrivate(p, "*setship " + (String)ship);

parse = parse->next;
}
}
</pre>

To use, just call the function with the appropriate Ship_Type from the enum in clientprot.h:
<pre>
handleCmdSetShip(SHIP_Warbird);
</pre>

==Random numbers==

===Generating a random number===

To use this method, these two includes must be used:
<pre>
#include "time.h" //provides time() function.
#include "stdlib.h" //provides srand() and rand() functions.
</pre>

Use:
<pre>
srand(time(NULL)); // seed random number generator.

rand(); // randomize.

int temp = (int) (51 * ((float)rand()/RAND_MAX));
// the above line returns a random integer between 0 and 51.
// Note: RAND_MAX is a global constant defined in stdlib.h
</pre>

===Picking a random pilot===

''Note:'' A required user-defined function, getInGame(), must be created for this example to work.

<pre>
int temp = GetTickCount() % getInGame(); // getInGame() = how many pilots in arena

Player *rabbit = NULL;

_listnode <Player> *parse = playerlist->head;
while (parse)
{
Player *p = parse->item;

if (p->ship != SHIP_Spectator) // if player is not a spectator
if ( !(--temp) ) // and if we've hit the randomly-selected pilot
{
rabbit = p;
break;
}
parse = parse->next;
}
</pre>

==Storing data for pilots==

There are several ways to store data for pilots (ie tracking flagtime or kills in a period of time). Note that these methods are all purely internal to the bot, and don't effect anything beyond the plugin in any way.

# Built-in get/setTag: Tracks data until player leaves the arena, then automatically deletes data.
# Modified perm get/setTag: Tracks data until bot leaves arena, then automatically deletes data. (Advantage: easier to sort by player)
# Custom Structs: Tracks data until plugin deletes it. (Advantage: easier to sort by freqs)

''Note:'' 2 and 3 are similar in effect, mostly the difference is in how you are able to search through data you need to decide which method of storing data is best for each bot depending on what it does.

===Built-in get/setTag method===

Player tags simply tag a player with a number. Define the wanted values in '''spawn.h''' at the top:
<pre>
#define DMG_DEALT 0
#define DMG_TAKEN 1
</pre>

In spawn.cpp, initialize the values on ArenaEnter and PlayerEnter:
<pre>
case EVENT_ArenaEnter:
{
// ...

// do for all pilots in arena when bot enters
_listnode <Player> *parse = playerlist->head;
while (parse)
{
Player *p = parse->item; // get pilot

set_tag(p, DMG_DEALT, 0); // initialize to 0
set_tag(p, DMG_TAKEN, 0);
sendPrivate(p, "*watchdamage"); // optionally turn on player *watchdamage

parse = parse->next; // get next pilot
}
}
</pre>
<pre>
case EVENT_PlayerEntering:
{
// ...
set_tag(p, DMG_DEALT, 0); // initialize to 0
set_tag(p, DMG_TAKEN, 0);
sendPrivate(p,"*watchdamage");
}
</pre>

Then somewhere edit the tag values:
<pre>
case EVENT_WatchDamage:
{
// sets tag for k (shooter) to be old value plus damage currently dealt

int old_damage = get_tag(k, DMG_BOMB_DEALT);
set_tag(k, DMG_BOMB_DEALT, old_damage + damage);
}
</pre>

The following demonstrates how to retrieve the tag values as a command in command.cpp:
<pre>
if (c->check("showstats"))
{
int temp = get_tag(p, DMG_TOTAL_DEALT);

String s = "You've done ";
s += temp;
s += " damage so far!";

sendPrivate(p,s);
}
</pre>

===Modified permanent get/setTag method===

This method is the same as get/setTag with some modifications to the tag code to retain them after the player leaves. Beware of using this method if bot is in an arena for long periods of time, linkedlist could get huge.

// spawn.h, add char name[20]; into struct PlayerTag
<pre>
struct PlayerTag
{
Player *p;
char name[20];
int index;
int data;
};
</pre>

In spawn.cpp:
<pre>
case EVENT_PlayerLeaving:
{
Player *p = (Player*)event.p[0];

// killTags(p); // remove so tag not deleted on arena exit

// ...
</pre>

Locate in spawn.cpp and modify accordingly:
<pre>
int botInfo::get_tag(Player *p, int index)
{
_listnode <PlayerTag> *parse = taglist.head;
PlayerTag *tag;

while (parse)
{
tag = parse->item;

// if (tag->p == p)
if (strcmp(tag->name,p->name)==0) // now tracking by player name, not pointer
if (tag->index == index)
return tag->data;

parse = parse->next;
}
return 0;
}

void botInfo::set_tag(Player *p, int index, int data)
{
_listnode <PlayerTag> *parse = taglist.head;
PlayerTag *tag;

while (parse)
{
tag = parse->item;

//if (tag->p == p)
if (strcmp(tag->name,p->name)==0) // now tracking by player name, not pointer
if (tag->index == index)
{
tag->data = data;
return;
}
parse = parse->next;
}

tag = new PlayerTag;
// tag->p = p; // not tracking by pointer anymore
strncpy(tag->name, p->name, 20); // tracking by player name
tag->index = index;
tag->data = data;
taglist.append(tag);
}
</pre>

===Using structs===

In '''spawn.h''':
<pre>
class botInfo
{
struct freqdata
{
int kills, deaths;
};
// ...
};
</pre>

To make use of this structure, implement accordingly:
<pre>
freqdata freqs[100]; // 100 of those structs
</pre>
Access the data in spawn.cpp using
<pre>
freqs[56].kills = 1;
</pre>

See CPlusPlus.com's [http://www.cplusplus.com/doc/tutorial/tut3-5.html Structures] tutorial for a more comprehensive guide. Note that, as shown on the bottom of the page, you can have structures within structures. Thus, for example, you could have a structure for each freq with a structure for each player nested within them.

==Input/Output to files==

For reading and/or writing to files with C++ you must have the required include statement as follows:
<pre>
#include <fstream>
using namespace std;
</pre>

===File stream input===
The following example will show you how to read a file, duel.ini, line by line.

<pre>#include "stdlib.h" // for atoi()</pre>

<pre>
ifstream file("duel.ini");

if (!file.good()) // if there was an error opening the file
sendPublic("*arena Error opening file for reading"); // or add your own error handler
else
{
char line[256];

// read in MaxBoxes=X
while (file.getline(line, 256))
{

if (CMPSTART("MaxBoxes=", line)) //Does the line begin with MaxBoxes= ?
{
MAX_BOXES = atoi(&(line[9])); //If so, read the value into an integer, using atoi.
break;
}
}

file.close();
}
</pre>

===File stream output===
The following code example will demonstrate how to append to a file, duelleaguestat.inc.
<pre>
ofstream file("duelleaguestat.inc", ios::app); // app = put all data at end of file

if (!file.good()) // if there was an error opening the file
sendPublic("*arena Error opening file.");
else
{
file << squad1<< endl; // squad1 = char[20]
file << " vs "<< endl;
file << squad2<< endl; // squad2 = char[20]
file.close();
}
</pre>

Similarly, you are able to write an output of a String to a file:
<pre>
// key is converting String to (char*) to file write
String str = freqs[freq].slotname[slot];
str += ", Repels: " + (String)(int) t->repel;
file << endl;
file << (char*) str;
</pre>

===Input with GetPrivateProfileString===

GetPrivateProfileString(), a function provided by Windows for reading INI files, will automatically find an INI key (like "MaxBoxes=") in a file for you. See the [http://msdn.microsoft.com/library MSDN Library] for help on this function. This next example will show how to read input using GetPrivateProfileString() based on the rampage plugin.

The file format for rampage.ini is like this:
<pre>
7=is on a killing spree! (6:0)
10=is opening a can of booya! (9:0)
</pre>

In '''rampageini.cpp''':
<pre>
#include "rampageini.h"
#define WIN32_LEAN_AND_MEAN
#include <windows.h>

#define NUM_RANKS 10
#define BUFFER_LEN 256

struct RampageSettings
{
char quotes[NUM_RANKS][BUFFER_LEN];
};

void LoadSettings(RampageSettings &setts);

static char path[BUFFER_LEN];

char *rank_type[NUM_RANKS] = { "7", "10" };

void LoadSettings(RampageSettings &setts)
{
GetCurrentDirectory(BUFFER_LEN - 64, path);
strcat(path, "\rampage.ini");

for (int i = 0; i < NUM_RANKS; ++i)
{
GetPrivateProfileString("Comments", rank_type[i], "-ERROR-",
setts.quotes[i], BUFFER_LEN, path);
}
}
</pre>

==Player data==

As stated earlier in the tutorial, MervBot stores useful player data internally as Player objects, see player.h for implementation details.

* p->name = player name stored as char[20] (''Note:'' SubSpace protocol allows for usernames to be 19+ in length, do not rely on this for player-name comparisions.)
* p->squad = player squad stored as char[20]
* p->ship = ship (0-9) enumerated as SHIP_Warbird, SHIP_Spectator, etc..
* p->safety = whether ship is in safety zone (boolean)
* p->bounty = player bounty
* p->energy = player energy (have bot with *energy on to get accurate readings)
* p->flagCount = how many flags player is holding
* p->team = player frequency
* p->(burst, repel, thor, brick, decoy, rocket, portal) = how many items of that type player has
* p->(stealth, cloak, xradar, awarp, ufo, flash, safety, shields, supers) = if player has that item on (boolean)
* p->score.killPoints = player kill points
* p->score.flagPoints = player flag points
* p->score.wins = player kills from f2
* p->score.losses = player deaths from f2

Just access the respective member of the Player class to check the player's property.

For example, in spawn.cpp, to check whether a player is in a safety zone:
<pre>
EVENT_PlayerMove:
{
Player *p = (Player*)event.p[0];

if ( p->safety ) // player is in safe zone.
{
// do something.
}

if ( !p->safety ) // player NOT in safe zone.
{
// do something.
}
}
</pre>

=== Obtaining a player pointer using name comparison ===

Since Player pointers are internal to MERVBot, it is necessary to find a way of obtaining a Player pointer from the identifying information given by the game. One of the simpler ways is just to compare the names after converting to lowercase.

''Note'': Using pilot names as vital comparisions should be used with caution. See [http://cypherjf.sscentral.com/articles/bots-as-clients/ Bot-Issues] by CypherJF.

<pre>
// return Player* info (or NULL if not found) from p->name info
Player * botInfo::GetPilot(char *name)
{
// get pilot from a name, return as TempPlayer
_listnode <Player> *parse = playerlist->head;

//convert search name to lowercase
char nname[20], pname[20];
strncpy(nname, name, 20);
tolower(nname);

while (parse)
{
Player *p = parse->item;

// convert to lowercase to compare
strncpy(pname,p->name,20);
tolower(pname);
if (strcmp(pname,nname)==0)
return p;

parse = parse->next;
}

return NULL; //player not found
}
</pre>

==Bot built in functions==

Here are some useful MervBot commands to control what the bot is doing.

Player.cpp:
* Player::move(Sint32 x, Sint32 y) moves a player to the coordinates specified by x and y
* Player::clone(Player *p) clones a player into a player class

Look in Commands.txt , command.cpp (core), or /!help to bot to see all bot external commands (example /!go <arena>).

''LVZ Object toggling commands in plugins are to go here.''

[[Category:Guides]]

Directory server

2009-05-06T15:11:23Z

Doc flabby: updated software list

A '''Directory server''' is provides a way for [[client]]s to retreive a list of [[zone]]s that are currently online and running. These servers provide information on any zones that have registered with the directory server. This information includes the name and description of the zone, the ip and port that should be used to connect to the zone, the server version, whether or not a billing server is connected to the zone, as well as the number of players in the zone.

Both [[SubSpace]] and [[Continuum]] [[client|clients]] are capable of saving this information locally on the PC in the [[zone.dat]] file.

== Communication ==

A [[client]] can connect to a directory server to retrieve a list of active zones. Client's connect to UDP port 4990 using the [[Directory Client Protocol]].

A [[zone]] can register itself with one or more directory servers so players can find the zone. It utilizes the [[Directory Game Server Protocol]] on UDP port 4991.

== Directory Server Software ==

A variety of directory server's are available for you to download.

=== Windows ===

* Public Directory Server software v0.3 (by [[PriitK]])
** http://www.subspacedownloads.com/index.php?act=list&cat=3

* SubSpace Directory Server 4 (by [[catid]])
** http://www.mervbot.com/files/DDirServ.zip

* JEDirectoryServer (by Ben Diacuzn)
** http://www.subspacedownloads.com/index.php?act=list&cat=3

=== Linux ===

* SubSpace Directory Server 4 (by [[catid]]), ported to Linux by [[User:Doc flabby|Doc Flabby]].
** http://forums.minegoboom.com/viewtopic.php?p=74575

=== Cross Platform ===
* Central by [[User:Doc flabby|Doc Flabby]], written in C#.
** http://forums.minegoboom.com/viewtopic.php?p=80198

* SubSpace Directory Server by [[Snrrrub]]
** http://forums.minegoboom.com/viewtopic.php?t=8236

* SkyDir by [[User:Doc flabby|Doc Flabby]], written in Python with SQLite.
** http://forums.minegoboom.com/viewtopic.php?t=7590

== Public Directory Servers ==

The current available and "reliable" public directory servers are:

* sscentral.sscuservers.net
** ''Administrated by [[PriitK]]''
* ssdir.playsubspace.com
** ''Administrated by [[User:Doc flabby|Doc Flabby]]''

[[Category: Definitions]]
[[Category: Servers]]

Directory server

2009-05-06T15:09:54Z

Doc flabby: /* Directory Server Software */

A '''Directory server''' is provides a way for [[client]]s to retreive a list of [[zone]]s that are currently online and running. These servers provide information on any zones that have registered with the directory server. This information includes the name and description of the zone, the ip and port that should be used to connect to the zone, the server version, whether or not a billing server is connected to the zone, as well as the number of players in the zone.

Both [[SubSpace]] and [[Continuum]] [[client|clients]] are capable of saving this information locally on the PC in the [[zone.dat]] file.

== Communication ==

A [[client]] can connect to a directory server to retrieve a list of active zones. Client's connect to UDP port 4990 using the [[Directory Client Protocol]].

A [[zone]] can register itself with one or more directory servers so players can find the zone. It utilizes the [[Directory Game Server Protocol]] on UDP port 4991.

== Directory Server Software ==

A variety of directory server's are available for you to download.

=== Windows ===

* Public Directory Server software v0.3 (by [[PriitK]])
** http://www.subspacedownloads.com/index.php?act=list&cat=3

* SubSpace Directory Server 4 (by [[catid]])
** http://www.mervbot.com/files/DDirServ.zip

* JEDirectoryServer (by Ben Diacuzn)
** http://www.subspacedownloads.com/index.php?act=list&cat=3

=== Linux ===

* SubSpace Directory Server 4 (by [[catid]]), ported to Linux by [[User:Doc flabby|Doc Flabby]].
** http://forums.minegoboom.com/viewtopic.php?p=74575

=== Cross Platform ===
* Central by [[User:Doc flabby|Doc Flabby]], written in C#.
** http://forums.minegoboom.com/viewtopic.php?p=80198

* SkyDir by [[User:Doc flabby|Doc Flabby]], written in Python with SQLite.
** http://forums.minegoboom.com/viewtopic.php?t=7590

== Public Directory Servers ==

The current available and "reliable" public directory servers are:

* sscentral.sscuservers.net
** ''Administrated by [[PriitK]]''
* ssdir.playsubspace.com
** ''Administrated by [[User:Doc flabby|Doc Flabby]]''

[[Category: Definitions]]
[[Category: Servers]]

Directory Client Protocol

2009-05-06T15:08:59Z

Doc flabby: added some detail on description max length

[[Core protocol]] is used as usual. Dirserv specific c2s/s2c protocol.

Continuum sends a sync request and SubSpace doesn't.
The list request is sent as reliable. On the traditional directory servers (not [[catid]]'s), traffic is always encrypted, even if you send a null encryption key.

Directory servers listen on port 4990 for [[client]] connections.

<pre>
c2s

0x01 list request
offset size comment
0 1 type 0x01
1 4 minimum players

s2c

0x01 list data
offset size comment
0 1 type 0x01
1 4 ip
5 2 port
7 2 player count
9 2 billing (on 0x01 0x00)
11 4 version (0x86 0x00 0x00 0x00)
15 64 name
79 ? description (should not be longer than around 480-490 in length)
packet repeats from offset 1 until end
</pre>

=== See also ===
* [[Directory Game Server Protocol]]

[[Category: Protocol]]

UDP Billing Protocol

2007-10-18T18:34:38Z

Doc flabby: addded start of udp billing documentation

The UDP billing protocol is the original protocol written by [[VIE]] which was implemented in [[Subbill]]. It features more capabilities then the newer [[TCP Billing Protocol]] such as the ability to remotely restart or shutdown a game server, and save scores to a central location.

The protocol has never formally been documented and has been reversed engineered by individuals. However, it does utilize the same [[core protocol]] as the [[UDP Game Protocol]].

An attempt at documenting the protocol has been started below.

<pre>

Zone to Billing
---------------

Billing to Zone
---------------

Login_Params

0 PRMEANING_ENTER, // Implemented
1 PRMEANING_ASK, // Implemented
2 PRMEANING_BADPW, // Implemented
3 PRMEANING_IPBLOCK, // Implemented
4 PRMEANING_NONEW, // Implemented
5 PRMEANING_BADNAME, // Implemented
6 PRMEANING_REGFORM, // Implemented
7 PRMEANING_BUSY, // Implemented
8 PRMEANING_DEMO // Unused

Kick_Reasons
0 KICK_SYSTEM, // Other reason
1 KICK_FLOOD, // Player command-flooded
2 KICK_BAN // Player was banned (Or BanID..)

Player Response 0x01
offset size comment
0 1 0x01
1 1 Login_Params (see top)
2 4 PlayerId
6 24 PlayerName
30 24 Squad Name
54 96 Banner
150 4 Total Seconds
154 2 Year
156 2 Month
158 2 Day
160 2 Hour
162 2 Minute
164 2 Secound
166 4 Extra 1
170 4 ScoreID
174 4 Extra 2
178 2 Wins
180 2 Losses
182 2 GoalCount
184 4 Points
188 4 Event Points

Player Private Chat (aka pm) 0x03
offset size comment
0 1 0x03
1 4 Source Server ID
5 1 0x02
6 1 Sound
7 varies Message Terminated with \0

Zone Recycle 0x04
offset size comment
0 1 0x04
1 1 0x00
2 4 0x00000001
6 4 0x00000002

Kick Player 0x08
offset size comment
0 1 0x08
1 4 Connection Id
5 4 Kick_Reasons (see top)

Command Message 0x09 (?blogin etc)
offset size comment
0 1 0x09
1 4 ConnectionId
5 varies Message Terminated with \0

Chat Message 0x0A
offset size comment
0 1 0x0A
1 4 ConnectionId
5 1 Channel
6 varies Message Terminated with \0

ScoreReset 0x31
offset size comment
0 1 0x31
1 4 ScoreId
5 4 -ScoreId

This is far from complete i've use asss3's src and some of ssbilling2's src. maybe someone will find is useful one day -doc flabby

</pre>

[[Category: Protocol]]

Talk:UDP Billing Protocol

2007-10-18T18:31:37Z

Doc flabby: wrong page

Talk:UDP Billing Protocol

2007-10-18T18:31:11Z

Doc flabby: started documenting udp billing

<pre>

Zone to Billing
---------------

Billing to Zone
---------------

Login_Params

PRMEANING_ENTER, // Implemented
PRMEANING_ASK, // Implemented
PRMEANING_BADPW, // Implemented
PRMEANING_IPBLOCK, // Implemented
PRMEANING_NONEW, // Implemented
PRMEANING_BADNAME, // Implemented
PRMEANING_REGFORM, // Implemented
PRMEANING_BUSY, // Implemented
PRMEANING_DEMO // Unused

Kick_Reasons
KICK_SYSTEM, // Other reason
KICK_FLOOD, // Player command-flooded
KICK_BAN // Player was banned (Or BanID..)

Player Response 0x01
offset size comment
0 1 0x01
1 1 Login_Params (see top)
2 4 PlayerId
6 24 PlayerName
30 24 Squad Name
54 96 Banner
150 4 Total Seconds
154 2 Year
156 2 Month
158 2 Day
160 2 Hour
162 2 Minute
164 2 Secound
166 4 Extra 1
170 4 ScoreID
174 4 Extra 2
178 2 Wins
180 2 Losses
182 2 GoalCount
184 4 Points
188 4 Event Points

Player Private Chat (aka pm) 0x03
offset size comment
0 1 0x03
1 4 Source Server ID
5 1 0x02
6 1 Sound
7 varies Message Terminated with \0

Zone Recycle 0x04
offset size comment
0 1 0x04
1 1 0x00
2 4 0x00000001
6 4 0x00000002

Kick Player 0x08
offset size comment
0 1 0x08
1 4 Connection Id
5 4 Kick_Reasons (see top)

Command Message 0x09 (?blogin etc)
offset size comment
0 1 0x09
1 4 ConnectionId
5 varies Message Terminated with \0

Chat Message 0x0A
offset size comment
0 1 0x0A
1 4 ConnectionId
5 1 Channel
6 varies Message Terminated with \0

ScoreReset 0x31
offset size comment
0 1 0x31
1 4 ScoreId
5 4 -ScoreId

This is far from complete i've use asss3's src and some of ssbilling2's src. maybe someone will find is useful one day

</pre>

Talk:Billing Protocol

2007-10-17T14:55:17Z

Doc flabby: surgested merge

[[User:Mine GO BOOM|Mine GO BOOM]] 13:06, Sep 28, 2006 (PDT): Wow, we don't have the billing protocol here? We have the [[TCP Billing Protocol]], but not Subspace's UDP version.

[[User:CypherJF|CypherJF]] 14:03, Sep 28, 2006 (PDT): it's because no one has documented it. I've asked Lord Maucaub some time ago to provide me with the documentation he created for it but he has since long disappeared. I think I also asked 2dragons for it but that was a no go either.

[[User:Mine GO BOOM|Mine GO BOOM]] 14:34, Sep 28, 2006 (PDT): Sounds like a good project. ASSS has source code for it, Catid made his own replacement billing server. Both ends have full open source for it, shouldn't be hard to throw up a quick layout and let people add in the details.

[[User:Doc flabby|Doc flabby]] 07:55, October 17, 2007 (PDT):
I suggest merging this with the [[biller]] page?

Biller

2007-10-17T14:53:51Z

Doc flabby: /* Billing Software */

== Purpose ==
The Billing Server is a server that is separate from [[ASSS]] that keeps track of player's passwords and handles chat channels.

One biller can be shared between many game servers. This makes chat channel and inter-zone private messaging a desirable feature of a biller. More importantly billers can contain a ban system that allow one ban to affect all zones (called a ''netban'').

Today, the name Billing Server is confusing as it is just a user database. The publishers ([[VIE]]) of SubSpace probably wanted to charge players a subscription and this server would control it, hence the name biller.

Excerpt from a copy of the [http://beginners.subspace.net/history/vie/subnews.html VIE website]:

<blockquote>We are just concluding deals with various partners the upshot of which is that billing for Subspace will almost certainly not happen till July we are still assuming a $10 a month or $1 a day scheme and a box version that will include several months play built in.</blockquote>

== Billing Software ==
Billers communicate using either the TCP or UDP [[Billing Protocol]]
=== UDP ===
The original billing protocol.
==== Windows ====

*SubSpace Billing Server 2.00b by [[Confess]]
**This is Confess' version of SSBiller2 with a bunch of new features. (C++ source)
**http://www.mervbot.com/files/ssb2confess.rar

*SubSpace Billing Server 2 Release 11j by [[Catid]]
**This is SOS' much improved version of my billing server, open-sourced as well. The BAN.DAT and BANFREE.DAT files are not compatible with the original SSBiller2. New: Fixed a large security-related bug. Download and replace your copy of SSBilling2.EXE!
**Fully Featured
**http://www.mervbot.com/files/ssb2.zip

*subbill 0.23 by [[Prittk]]
**Not recommended as it uses 100% CPU
**Has only basic features.
**http://www.subspacedownloads.com/index.php?act=file&fid=31

==== Linux ====

*Linux Port of SubSpace Billing Server 2 Release 11j by [[Doc Flabby]]
** No Encryption
** Issues with Compilation from source (compiler version specific)
** http://forums.minegoboom.com/viewtopic.php?t=7782

=== TCP ===
The new billing protocol.
See the [[TCP Billing FAQ]]

[[Category: Definitions]]
[[Category: Servers]]

Biller

2007-10-17T14:53:13Z

Doc flabby: /* Billing Software */

== Purpose ==
The Billing Server is a server that is separate from [[ASSS]] that keeps track of player's passwords and handles chat channels.

One biller can be shared between many game servers. This makes chat channel and inter-zone private messaging a desirable feature of a biller. More importantly billers can contain a ban system that allow one ban to affect all zones (called a ''netban'').

Today, the name Billing Server is confusing as it is just a user database. The publishers ([[VIE]]) of SubSpace probably wanted to charge players a subscription and this server would control it, hence the name biller.

Excerpt from a copy of the [http://beginners.subspace.net/history/vie/subnews.html VIE website]:

<blockquote>We are just concluding deals with various partners the upshot of which is that billing for Subspace will almost certainly not happen till July we are still assuming a $10 a month or $1 a day scheme and a box version that will include several months play built in.</blockquote>

== Billing Software ==
Billers communicate using either the TCP or UDP [Billing Protocol]
=== UDP ===
The original billing protocol.
==== Windows ====

*SubSpace Billing Server 2.00b by [[Confess]]
**This is Confess' version of SSBiller2 with a bunch of new features. (C++ source)
**http://www.mervbot.com/files/ssb2confess.rar

*SubSpace Billing Server 2 Release 11j by [[Catid]]
**This is SOS' much improved version of my billing server, open-sourced as well. The BAN.DAT and BANFREE.DAT files are not compatible with the original SSBiller2. New: Fixed a large security-related bug. Download and replace your copy of SSBilling2.EXE!
**Fully Featured
**http://www.mervbot.com/files/ssb2.zip

*subbill 0.23 by [[Prittk]]
**Not recommended as it uses 100% CPU
**Has only basic features.
**http://www.subspacedownloads.com/index.php?act=file&fid=31

==== Linux ====

*Linux Port of SubSpace Billing Server 2 Release 11j by [[Doc Flabby]]
** No Encryption
** Issues with Compilation from source (compiler version specific)
** http://forums.minegoboom.com/viewtopic.php?t=7782

=== TCP ===
The new billing protocol.
See the [[TCP Billing FAQ]]

[[Category: Definitions]]
[[Category: Servers]]

Billing

2007-10-17T14:51:55Z

Doc flabby: added redirect

#REDIRECT [[Biller]]

Biller

2007-10-17T14:48:15Z

Doc flabby: started a list of billers

== Purpose ==
The Billing Server is a server that is separate from [[ASSS]] that keeps track of player's passwords and handles chat channels.

One biller can be shared between many game servers. This makes chat channel and inter-zone private messaging a desirable feature of a biller. More importantly billers can contain a ban system that allow one ban to affect all zones (called a ''netban'').

Today, the name Billing Server is confusing as it is just a user database. The publishers ([[VIE]]) of SubSpace probably wanted to charge players a subscription and this server would control it, hence the name biller.

Excerpt from a copy of the [http://beginners.subspace.net/history/vie/subnews.html VIE website]:

<blockquote>We are just concluding deals with various partners the upshot of which is that billing for Subspace will almost certainly not happen till July we are still assuming a $10 a month or $1 a day scheme and a box version that will include several months play built in.</blockquote>

== Billing Software ==

=== UDP ===
The original billing protocol.
==== Windows ====

*SubSpace Billing Server 2.00b by [[Confess]]
**This is Confess' version of SSBiller2 with a bunch of new features. (C++ source)
**http://www.mervbot.com/files/ssb2confess.rar

*SubSpace Billing Server 2 Release 11j by [[Catid]]
**This is SOS' much improved version of my billing server, open-sourced as well. The BAN.DAT and BANFREE.DAT files are not compatible with the original SSBiller2. New: Fixed a large security-related bug. Download and replace your copy of SSBilling2.EXE!
**Fully Featured
**http://www.mervbot.com/files/ssb2.zip

*subbill 0.23 by [[Prittk]]
**Not recommended as it uses 100% CPU
**Has only basic features.
**http://www.subspacedownloads.com/index.php?act=file&fid=31

==== Linux ====

*Linux Port of SubSpace Billing Server 2 Release 11j by [[Doc Flabby]]
** No Encryption
** Issues with Compilation from source (compiler version specific)
** http://forums.minegoboom.com/viewtopic.php?t=7782

=== TCP ===
The new billing protocol.
See the [[TCP Billing FAQ]]

[[Category: Definitions]]
[[Category: Servers]]

Talk:Core Protocol

2007-10-14T13:23:47Z

Doc flabby: not all packets can be nested

== Note on 0x0a00 packet ==
I think when asss sends these the total size of each packet is 480 bytes, with the last packet in the stream being the remainder (read: less than 480 bytes).

correct [[User:BaK|BaK]] 06:34, Jan 12, 2007 (PST)

== Note on login response ==
sending back the original key without change means no encryption, both to 1.34 and continuum

== Packets can be nested(?) ==
Revision: http://wiki.minegoboom.com/index.php?title=Core_protocol&oldid=5804

Revision By: Doc Flabby

[[User:Smong|Smong]] 13:11, October 13, 2007 (PDT) says:
:I'm not sure on this, I think at one point I decided only 00 03 (reliable) and 00 0e (clustered) packets are allowed to contain other core packets. Or put another way, the fragmented packets (small and large streams) cannot contain another core packet. This is important when it comes to implementing a core protocol stack.

:An implementation could use a packet object which contains a 520 byte buffer, you could have these packet objects allocated statically or from a resizable pool. If this method is used it is impossible to pass a packet larger than 520 bytes through the core protocol stack without some ugly special case code.

:Also since you can only have one small and one large stream at a time you do not need to keep a list of streams. You only need 2 static variables, one for each type of stream (most likely a struct containing a pointer to a dynamically allocated buffer).

:Finally ASSS does not expect a core packet to be inside a fragmented packet (it will just ignore it by default).

[[User:Smong|Smong]] 13:18, October 13, 2007 (PDT) says:
:Additionally I think this phrase already in the page "There is support for reliable ordered packets, large packets and cluster packets" covers the "Packets can be nested (They are usually processed recursively)" phrase. The original intention of the bullet points was for important specifications that would look awkward written as a complete sentence.

--[[User:Doc flabby|Doc flabby]] 06:23, October 14, 2007 (PDT) says

: I wasn't sure which packets could be nested, but I thought it worth meantioning as It was something that is non-obvious and took me quite a time to find out!

Core Protocol

2007-10-12T13:52:12Z

Doc flabby: packets can be nested

This protocol is UDP and bi-directional. It can be thought of as another layer within an application's network layer. [[Subgame]], [[ASSS]], [[Continuum]], VIE's [[SubSpace]] client, the [[Directory server]], and some [[Billing Server|Billing Servers]] utilize this protocol.

There is support for reliable ordered packets, large packets and cluster packets.

*The maximum packet size is 520 bytes
*All integers are little endian
*All core packets begin with the type byte 0x00
*Packets can be nested (They are usually processed recursivly)

<pre>
0x01 login
offset size comment
0 1 type 0x00
1 1 type 0x01
2 4 client key
6 2 protocol version (vie = 0x01, ctm = 0x11)

0x02 login response
offset size comment
0 1 type 0x00
1 1 type 0x02
2 4 ~client key (negative)

0x03 reliable header
offset size comment
0 1 type 0x00
1 1 type 0x03
2 4 packet id
6 ? payload (514 max)

0x04 reliable acknowledge
offset size comment
0 1 type 0x00
1 1 type 0x04
2 4 packet id

0x05 sync
offset size comment
0 1 type 0x00
1 1 type 0x05
2 4 local time
6 4 packets sent
10 4 packets received

0x06 sync response
offset size comment
0 1 type 0x00
1 1 type 0x06
2 4 time from last received 0x05 packet
6 4 server time

0x07 disconnect
offset size comment
0 1 type 0x00
1 1 type 0x07

0x08 small chunk
offset size comment
0 1 type 0x00
1 1 type 0x08
2 ? payload (expect 472 max)
keep appending payloads until 0x09 chunk tail is received

0x09 chunk tail
offset size comment
0 1 type 0x00
1 1 type 0x09
2 ? payload (expect 472 or less)
append this payload then process contents as a non-core packet

0x0A stream
offset size comment
0 1 type 0x00
1 1 type 0x0A
2 4 total length of all segments
6 ? payload
keep appending payloads until total length is reached then process contents as
a non-core packet.

0x0B cancel stream request
offset size comment
0 1 type 0x00
1 1 type 0x0B

0x0C cancel stream acknowledge
offset size comment
0 1 type 0x00
1 1 type 0x0C

0x0E cluster
offset size comment
0 1 type 0x00
1 1 type 0x0E
2 1 length
3 ? payload with length as above
packet repeats from offset 2 until end, process contents as arbitrary packet
</pre>

[[Category: Protocol]]

Directory server

2007-10-12T13:45:42Z

Doc flabby: added working directory servers (sorry for edit spammage) - if this was abad idea please remove :)

A '''Directory server''' is provides a way for [[client]]s to retreive a list of [[zone]]s that are currently online and running. These servers provide information on any zones that have registered with the directory server. This information includes the name and description of the zone, the ip and port that should be used to connect to the zone, the server version, whether or not a billing server is connected to the zone, as well as the number of players in the zone.

Both [[SubSpace]] and [[Continuum]] [[client|clients]] are capable of saving this information locally on the PC in the [[zone.dat]] file.

== Communication ==

A [[client]] can connect to a directory server to retrieve a list of active zones. Client's connect to UDP port 4990 using the [[Directory Client Protocol]].

A [[zone]] can register itself with one or more directory servers so players can find the zone. It utilizes the [[Directory Game Server Protocol]] on UDP port 4991.

== Directory Server Software ==

A variety of directory server's are available for you to download.

=== Windows ===

* Public Directory Server software v0.3 (by [[PriitK]])
** http://www.subspacedownloads.com/index.php?act=list&cat=3

* SubSpace Directory Server 4 (by [[catid]])
** http://www.mervbot.com/files/DDirServ.zip

* JEDirectoryServer (by ''unknown'')
** http://www.subspacedownloads.com/index.php?act=list&cat=3

=== Linux ===

* SubSpace Directory Server 4 (by [[catid]]), ported to Linux by [[User:Doc flabby|Doc Flabby]].
** http://forums.minegoboom.com/viewtopic.php?p=74575

=== Cross Platform ===
* SkyDir by [[User:Doc flabby|Doc Flabby]], written in Python with SQLite.
** http://forums.minegoboom.com/viewtopic.php?t=7590

== Public Directory Servers ==

The current available and "reliable" public directory servers are:

* sscentral.sscuservers.net
** ''Administrated by [[PriitK]]''
* ssdir.playsubspace.com
** ''Administrated by [[User:Doc flabby|Doc Flabby]]''

[[Category: Definitions]]
[[Category: Servers]]

User talk:Doc flabby

2007-10-12T13:37:32Z

Doc flabby: New page: hello!

hello!

Directory server

2007-10-12T13:36:39Z

Doc flabby: /* Cross-Platform */

A '''Directory server''' is provides a way for [[client]]s to retreive a list of [[zone]]s that are currently online and running. These servers provide information on any zones that have registered with the directory server. This information includes the name and description of the zone, the ip and port that should be used to connect to the zone, the server version, whether or not a billing server is connected to the zone, as well as the number of players in the zone.

Both [[SubSpace]] and [[Continuum]] [[client|clients]] are capable of saving this information locally on the PC in the [[zone.dat]] file.

== Communication ==

A [[client]] can connect to a directory server to retrieve a list of active zones. Client's connect to UDP port 4990 using the [[Directory Client Protocol]].

A [[zone]] can register itself with one or more directory servers so players can find the zone. It utilizes the [[Directory Game Server Protocol]] on UDP port 4991.

== Directory Server Software ==

A variety of directory server's are available for you to download.

=== Windows ===

* Public Directory Server software v0.3 (by [[PriitK]])
** http://www.subspacedownloads.com/index.php?act=list&cat=3

* SubSpace Directory Server 4 (by [[catid]])
** http://www.mervbot.com/files/DDirServ.zip

* JEDirectoryServer (by ''unknown'')
** http://www.subspacedownloads.com/index.php?act=list&cat=3

=== Linux ===

* SubSpace Directory Server 4 (by [[catid]]), ported to Linux by [[User:Doc flabby|Doc Flabby]].
** http://forums.minegoboom.com/viewtopic.php?p=74575

=== Cross Platform ===
* SkyDir by [[User:Doc flabby|Doc Flabby]], written in Python with SQLite.
** http://forums.minegoboom.com/viewtopic.php?t=7590

[[Category: Definitions]]
[[Category: Servers]]

Directory server

2007-10-12T13:36:27Z

Doc flabby: rearranged page a bit

A '''Directory server''' is provides a way for [[client]]s to retreive a list of [[zone]]s that are currently online and running. These servers provide information on any zones that have registered with the directory server. This information includes the name and description of the zone, the ip and port that should be used to connect to the zone, the server version, whether or not a billing server is connected to the zone, as well as the number of players in the zone.

Both [[SubSpace]] and [[Continuum]] [[client|clients]] are capable of saving this information locally on the PC in the [[zone.dat]] file.

== Communication ==

A [[client]] can connect to a directory server to retrieve a list of active zones. Client's connect to UDP port 4990 using the [[Directory Client Protocol]].

A [[zone]] can register itself with one or more directory servers so players can find the zone. It utilizes the [[Directory Game Server Protocol]] on UDP port 4991.

== Directory Server Software ==

A variety of directory server's are available for you to download.

=== Windows ===

* Public Directory Server software v0.3 (by [[PriitK]])
** http://www.subspacedownloads.com/index.php?act=list&cat=3

* SubSpace Directory Server 4 (by [[catid]])
** http://www.mervbot.com/files/DDirServ.zip

* JEDirectoryServer (by ''unknown'')
** http://www.subspacedownloads.com/index.php?act=list&cat=3

=== Linux ===

* SubSpace Directory Server 4 (by [[catid]]), ported to Linux by [[User:Doc flabby|Doc Flabby]].
** http://forums.minegoboom.com/viewtopic.php?p=74575

=== Cross-Platform ===
* SkyDir by [[User:Doc flabby|Doc Flabby]], written in Python with SQLite.
** http://forums.minegoboom.com/viewtopic.php?t=7590

[[Category: Definitions]]
[[Category: Servers]]

Directory server

2007-10-08T16:43:01Z

Doc flabby: /* Windows */

Directory server

2007-10-08T16:42:17Z

Doc flabby: added software links, will tidy later

User:Doc flabby

2007-05-23T20:12:35Z

Doc flabby:

The Doc!

Talk:Discretion

2007-05-23T20:12:11Z

Doc flabby:

Custom Client Side Code

A better idea would be a custom client side scripting system. Similar to how second life works.

Talk:Server.ini

2007-04-06T14:18:45Z

Doc flabby: directory servers

Oh yes, and sorry about the weird mistakes in here. RegEx's make me lazy. Also, I'm giving information on all the settings I know about, and all the settings Priit has added with explanations in the changelog, but some I have no clue (like most of Comms and Permission) --[[User:Cyan~Fire|Cyan~Fire]]

==TOC==

gerbils, that TOC looks ''really'' ugly. --[[User:Cyan~Fire|Cyan~Fire]]

[[User:I88gerbils|i88gerbils]]: Put it on the left side though it's refreshing to find a Table of Contents on the right. Better than having it ontop.

[[User:Mine GO BOOM|Mine GO BOOM]]: I like it better on the right than anywhere else. On top is too long, on the left just pushes the page too far over. If you want to get fancy, put it in a floating div box on either side, so the rest of the page wraps around it. Should look better then (though I still think better on the right).

Floating boxes are so annoying to get right. Can't we just take advantage of the "Hide" feature? --[[User:Cyan~Fire|Cyan~Fire]]

[[User:I88gerbils|i88gerbils]]: I told you it looked purrty! :d

== Directory Servers ==

[[User:Doc Flabby|Doc Flabby]]: Are the ones in the wiki correct?

sscentral.subspace.inet.fi,ssdir.playsubspace.com

I thought it was
sscentral.sscuservers.net,ssdir.playsubspace.com

Subgame

2007-02-10T12:38:52Z

Doc flabby: Opioions should be left for the discussion page.

Based on [[VIE]]'s special Subgame, [[Subgame]] (or Subgame2) is the alternate server to [[ASSS]]. It was originally made by [[VIE]], but was edited by [[PriitK]] to support [[Continuum]]. It is closed source, uses more memory, and lacks many of the features ASSS has. Subgame works in connection with a [[Billing Server]] to allow users to enter a zone. Old and stable, Subgame is used by most zones today.

== .scr files ==
Subgame saves private arena scores in .scr files, one for each arena. These files are composed of repeating structures that hold score information for one player as follows:
<pre>struct PlayerScore
{
unsigned long userid; //given by ?userid command
unsigned short kills, deaths;
unsigned short victories; //incremented on a team victory, player must be in a ship, not spec.
long killpoints, flagpoints;
};</pre>
[http://www.shanky.com/cgi-bin/ryan/download.cgi?scrfiles.zip Here] are two tools to manipulate .scr files.

== Change Log ==
<pre>
----------------------------- version 1.34.14bs2 ------------------------------
Small update to disable "Unknown Integrity Violation" alerts caused by a yet
unsupported packet.

----------------------------- version 1.34.14bs -------------------------------
Removed handler for 'Process debugger' security warnings, as Cont039pr3 sends
them (as well as your process list) erroneously.

----------------------------- version 1.34.14b --------------------------------
Added new security checks for Continuum 0.39pr2

Fixed rare crash on certain invalid packet sequence

New server.ini variable: Misc:BindIP - local IP address to bind server ports
to. Useful in multihomed systems only.

----------------------------- version 1.34.14a --------------------------------
New server.ini variable: Misc:BotsIP - clients with that IP are allowed to
exceed packet flood limits

----------------------------- version 1.34.14 ---------------------------------
New server.ini variable: Misc:AllowPrerelease - default 1, when set, users with
new prerelease versions are allowed to play

New cfg variable: Misc:SaveSpawnScore - default 0, when set, server will save
arena score to arenaname.scr file. NB! default setting changes differs from
older subgame versions, where spawn scores were always saved to .scr file and
there was no option to disable it. Disabling .scr file save will make server
run smoother and will prevent server directory filling up with useless files.

Fixed false connection flood alerts

Fixed player not taking damage after macroing ?go arena several times

----------------------------- version 1.34.13c --------------------------------
Added client timer drift percentage to /*einfo

----------------------------- version 1.34.13b --------------------------------
Added support for position packet queueing and smart clustering to save
bandwidth. To enable it, set in server.ini Routing:QueuePositions:1. Following
variables can be used to control clustering process:
Routing:PosSendRadar - how long radar packets are queued, default 100 ms
Routing:PosSendEdge - how long packets on screen edge are queued, default 30 ms
Routing:PosSendClose - how long close packets are queue, default 20 ms
Routing:ClosePosPixels - how near are packets considered close, default 250
pixels

New cfg variable: Misc:MaxTimerDrift - percentage how much client timer is
allowed to differ from server timer [Continuum 0.38+]

Added support for chat channel multicast to prevent zone<>biller connection
overload on very popular chats like Hockey zone's ?chat=zilla

New cfg variable: Latency:NegativeClientSlowPacketTime - packets with future
timestamp farther in future than this variable are considered as slow packets.
Default value: 0 - feature is disabled. Feature is still experimental.
[Continuum 0.38+]

New cfg variable: Soccer:DisableWallPass - default 0, when set, passing ball
through walls is diabled. There must be clear line between ball and ship
center to pick up ball [Continuum 0.38+]

New cfg variable: Soccer:DisableBallKilling - default 0, when set, ships with
0 velocity in safezone don't catch ball [Continuum 0.38+]

----------------------------- version 1.34.13a --------------------------------
Fixed extreme lagging bug when subgame was stated when GetTickCount() returned
negative values (Windows has been running without rebooting 25 days)

----------------------------- version 1.34.13 ---------------------------------
Removed incoming bandwidth limit from localhost connections

New cfg variable: Misc:AntiWarpSettleDelay - time in 1/100th seconds after
warping/portaling/attaching during which artificial antiwarp is activated
[Continuum 0.38+]

New cfg variables: Spawn:Team0-X, Spawn:Team0-Y, Spawn:Team0-Radius - allows
specify spawn location and radius per team. If only Team0 variables are set,
all teams use them, if Team0 and Team1 variables are set, even teams use Team0
ones and odd team Team1 ones. It is possible to set spawn positions upto 4
teams (Team0-Team3) [Continuum 0.38+]

New cfg variable: Misc:DisableScreenshot - disables Continuum's screenshot
functionality for non-spectators if set to 1 [Continuum 0.37+]

New server.ini variable: Comms:FlushTime - time in millseconds how long server
will collect position packets before sending them to clients. Recommended
setting: 10 - 20

Fixed unauthenticated users (name starting with ^) getting moderator powers
when using billing server proxy and billing server is down

New server.ini variable: Comms:BandwithIdleTime - time in seconds when server
stops sending position packets to idle spectators. Useful to save bandwidth.
Idle time is also shown in /*einfo now

Fixed server crash when client requested to go to negative frequency

New server.ini variable: Comms:SelectTime - time in millseconds how long server
should wait incoming packet using select() function. This is replacement for
CPU:SleepTime, which sleeps constant time, regardless if there are incoming
packets waiting processing or not. Recommended settings: Comms:SelectTime:10,
CPU:SleepTime:0 and CPU:SleepPerIteration:0

Fixed bug in Continuum's protocol. NB! Continuum 0.38 will require 1.34.13

----------------------------- version 1.34.12a --------------------------------
Added proxy detection to /*einfo. Proxy is detected for Continuum 0.37 and
later clients. You need to set server IP address in server.ini [Misc] ServerIP
for it to work.
* Undetermined - SS 1.3x or Continuum 0.36 clients
* SOCKS5 proxy - User is using Continuum's built in SOCKS5 proxy
* Using proxy at localhost - player is using proxy ran in same machine as
Continuum client. There is no other reason to do so than monitoring or
tampering with packet stream
* Using custom proxy - player is using custom proxy. Suspect cheating.
* Using NAT - player is using router or firewall doing NAT translation
* Not using proxy - no proxy was detected between client and server

Fixed timer desync and slow FPS sysop messages. Before "Unknown interity
violation" was displayed

New cfg variable: Misc:StartInSpec - if set, players entering arena are always
put to spectator mode

New server.ini variable: Misc:ForceContinuumOnly - if set server will ignore
ContinuumOnly variable is all cfg files and require Continuum in all arenas

New command: *objset +/-<object id>,+/-<object id>,... - sets state of listed
map/screen objects. +<object id> shows object and -<object id> hides it. For
example "*objset +1,-20,+13" shows objects 1 and 13 and hides object 20.
Command is meant to replace *objon and *objoff commands and it can be sent
to player privately or to whole arena. Command is meant for humans to use, for
bots there is special packet for toggling objects states which is much more
efficient. See BuildLevel documentation for more info about the objects.
[Continuum 0.38+]

----------------------------- version 1.34.12 release -------------------------
Added support for zone staff chats. To use local chats set Misc:StaffChat in
server.ini to comma separated chat name list. Only players with moderator and
higher powers can enter these chats and in ?chat these chats are listed as
(staff) chatname

Disabled non-public chat ? commands (ie /?password or '?squadleave) as there
has beed a lot of accidents where players trying to help others will do the
command without intention

Bugfix in Continuum 0.37 user handling

----------------------------- version 1.34.12pr4 ------------------------------
Fixed a crash bug introduced in 1.34.12pr3 in user sound checking

New command: /*watchdamage - Toggles player damage reporting on/off for
selected player. When turned on moderator will see something like that:
PriitK took 500 damage from l33t L2 bomb having 1400 nrg [Continuum 0.37+]

----------------------------- version 1.34.12pr3 ------------------------------
Added support for team sounds. Regular users can play sounds %150 - %255 in
team chat, zone sysops can upload these sounds in lvz file

New cfg variable: Misc:MinUsage. Specifies amount of usage in hours for players
to play in arena.

Adding + in front of level files specified by Misc:LevelFiles will make
downloading them optional for users

----------------------------- version 1.34.12pr2 ------------------------------
Fixed crash when lvz file is specified in cfg, but file is not present

Fixed /*tinfo to display invalid last line

Fixed vip functionality to bypass code checksums

----------------------------- version 1.34.12pr1 ------------------------------
Added collecting of server<-> client clock synchronization info and commad
/*tinfo to view it.

Removed printing of XXX killed by YYY to server console

Removed updating of LastUsedStamp for spawn cfg files

New cfg variable: <ship>:Radius. It specifies ship radius in pixels. In old
Subspace all ships have fixed radius 14 pixels. This means that ships will fit
through 2 tile holes, will take damage from weapons 14 pixels away from ship
center etc. Changing the radius will make ships smaller or bigger from game
play aspect, you can also change visual aspect to players by specifying custom
level graphics and also sounds [Continuum 0.37+]

New command: *objon <object id> - shows objects on map/screen with specified
id. Can be sent to player privately or to whole arena. See BuildLevel
documentation for more info. [Continuum 0.37+]

New command: *objoff <object id> - hides objects on map/screen with specified
id. Can be sent to player privately or to whole arena. [Continuum 0.37+]

New cfg variable: Misc:LevelFiles. Comma separated list of level files built
with BuildLevel.exe (lvz files). These files contain screen and map object
definitions and graphics, custom shipsets, sounds, help texts, etc. See
BuildLevel documentation for more info. [Continuum 0.37+]

New server.ini variable: Misc:AllowVIEClients. When set to 0 Subspace client
users are not allowed to enter zone. (It was actually added a while ago but
I forgot to document it)

Added vip.txt. Players listed in vip.txt can enter zone with old Subspace
client when zone is set to Misc:AllowVIEClients:0 and can play in arenas that
have Misc:ContinuumOnly set to 1 in config. Also players listed can enter zone
with Continuum 0.37 pre-release versions. When billing server is down vip.txt
is ignored, naturally

----------------------------- version 1.34.11 ---------------------------------
New command: /*warpto xcoord ycoord - privately sent to player will warp player
to given position. Coordinates are given in tiles (1-1023), when there is wall
at specified location, random position is chosen. [Continuum 0.35+]

Modified /*watchgreen to show negative prizes

New cfg variable: Spectator:HideFlags. When set dropped flags are not shown to
spectators. [Continuum 0.36+]

New cfg variable: Spectator:NoXRadar. When set spectators won't have X-Radar
[Continuum 0.36+]

New cfg variable: Bullet:ExactDamage. When set bullet damage is exact, not
random [Continuum 0.36+]

New cfg variable: Misc:SlowFrameRate. Specifies minimum frame rate for client.
When frame rate falls below specified rate for 10 seconds, client is
disconnected. 0 - disable check, maximum is 35 [Continuum 0.36+]

New cfg variable: <ship>:SeeBombLevel. 1=see all bombs on radar, 2=see bombs
greater than level 1 on radar, 3=see bombs greater than level 2 on radar,
0 = no bombs are shown on radar [Continuum 0.36+]

New cfg variable: <ship>:DisableFastShooting. When set firing bullets, bombs
and thors is disabled when using afterburner [Continuum 0.36+]

Fixed a bug in Continuum communcation protocol that caused connection to get
stuck infrequently

Added confirmation message to /*warn command

New server.ini variable: Misc:NoFlagRewardLimit. If set non-zero reward
multiplier limit is removed in FlagRewardMode 1. Multiplier is
(maximumAllowedPerTeam / numberOfTeamMembers), if NoFlagRewardLimit is set 0
multiplier is limited by 2.

Fixed bug causing infrequent server crashes (Access violation at
address 41d006)

Fixed another crash bug (Access violation at address 428e20)

Fixed security hole that allows anybody to upload moderate.txt and permit.txt

Fixed 'shadow KOTH' bug. When entering arena other players sometimes see that
entered player has KOTH, while he doesn't. Happends very seldom, but when it is
triggered all players entering had KOTH and only server shutdown/start would
fix that

Fixed problem of public teams becoming uneven when there are private teams in
arena.

New cfg variable: Misc:ContinuumOnly. When set to 1 non-Continuum players are
locked to spec and get message to use Continuum to play

New cfg variables: Latency:C2SNoDataAction and Latency:C2SNoDataTime. If
C2SNoDataAction is set to non-zero and there is no data coming from player for
C2SNoDataTime (in 1/100th seconds) follwing action is performed:
C2SNoDataAction=1: Report it using sysop message
C2SNoDataAction=2: Put player to spec mode
C2SNoDataAction=4; Kick player.
C2SNoDataAction can be combination (sum) of above actions.

Added new ArenaMode 5 (Custom:ArenaMode in server.ini). In arena mode 1-4
arenaname.cfg is created (copied from server.cfg) every time a user enters a
spawn. This means that over time cfg files are piling up in server directory
and changes in server.cfg are not reflected in spawns, makeing maintenance of
settings pain in the ass. In ArenaMode 5 if arenaname.cfg is not found, server
will use spawn.cfg.

Fixed bug in server that allowed sending cross-arena private messages so that
they appear to come from user without name.

New command: *relkills <0 or 1> - toggles sending kills reliably on and off.
Normally server sends kill messages as non-reliable messages if killed player's
bounty is less than 200 (teamkills are always non-reliable). Setting
*relkills 1 will make server send kill messages reliably,

New command: /*bandwidth <bandwidth> - allow to set cutback watermark per
player, overriding arena's Latency:CutbackWatermark setting

----------------------------- version 1.34.10 ---------------------------------
New command: *warn <text> - privately sent to player will display moderator
warning using red font to player

Fixed problem with keepalive. After sending large amouts of data, such as
voice messages, settings, etc players got often kicked with low keepalive
values.

Added client version display to /*einfo

Fixed 3 buffer length checking/overflow bugs in lowlevel protocol

Added ability to disable *shutdown command as sysops can execute arbitrary
commands with it and it is potential threat to host security. To disable
*shutdown create noshutdown directory to server directory. Don't forget to
set file permissions of that directory if sysops have FTP access

Tons of continuum client releated changes

----------------------------- version 1.34.9 ----------------------------------
Fixed protection against IP spoofed packet floods. Made a simple mistake and
left it open to smart flooders. Smack me

New command: *flags - displays locations of uncarried flags

New command: /*greeninfo - displays how many particular prizes player has
picked up and it's difference from normal distribution

Added displaying of client type to /*einfo to distinquish between VIE and
Continuum clients

----------------------------- version 1.34.8 ----------------------------------
Added protection against IP spoofed packet floods

Fix against another DoS attack (voice sending with incomplete packet)

New sysop command: *lag: shows average lag of all players in zone

?getnews is now available only in spectator mode

----------------------------- version 1.34.7 ----------------------------------
Added fix against Catid's zone flooder. When flood is detected IP address is
added to blacklist and all traffic from that IP is ignored for time relative
to amount of flood received. Flooder's IP is reported once using sysop alert

Added fastbombing detection. To enable it set Misc:CheckFastBombing in
server.ini as combination (sum) of following values:
1 - Send sysop alert when fastbombing is detected
2 - Filter out fastbombs
4 - Kick fastbombing player off
There is Misc:FastBombingThreshold variable in server.ini to tune detection.
Default and recommended value for that variable is 30. Bomb/mine is considered
for fastbombing if delay between 2 bombs/mines is less than
ship:BombFireDelay - Misc:FastBombingThreshold

Added support for multiple alert commands. Misc:AlertCommand is now comma
separated list of player alert commands (f.ex. cheater,help,illegal)

Alert commands are now logged to server log

Added support for zone local chats. To use local chats set Misc:LocalChat in
server.ini to comma separated chat name list

Added ability to force obscene checking on for all clients. To enable it set
Misc:ForceObsceneCheck in server.ini to 1. Users can toggle obscenity blocking
by ?obscene command

Added new player command: ?find <player name>. Tells in what arena specified
player is if not in private arena (starting with #). Moderators can find
players in private arenas too

Players with name ^Banned are silenced and locked to spec

Added feature to limit player's screen resolution. To enable set in an arena
cfg file Misc:MaxXRes and Misc:MaxYRes variables. 0 = no limit

Added scorereset support without need to recycle zone (needs same functionality
to be added to billing server before it can be used)

----------------------------- version 1.34.6 ----------------------------------
Fix against Sage386's DoS attack (At least one that crashed Trench Wars and
I have crash dump about). It is a simple buffer overflow bug in login code

New sysop command *version. Tells version for the server

Added weapons server to client packetloss to /*lag command

----------------------------- version 1.34.5 ----------------------------------
Added weapons checking. To enable it set in server.ini Misc:CheckWeapons:1
If enabled follwing checks are preformed:
* Bullet fired with level > [ship]MaxGuns + [Flag]FlaggerGunUpgrade
* Boucning bullet fired and [PrizeWeight]BouncingBullets is 0 and [Cost]Bounce
is 0
* Bomb fired with level > [ship]MaxBombs + [Flag]FlaggerBombUpgrade
* Prox bomb fired and [PrizeWeight]Proximity is 0 and [Cost]Prox is 0
* Bomb fired with shrap > [ship]ShrapnelMax
* Bomb fired with bouncing shrap and [PrizeWeight]BouncingBullets is 0 and
[Cost]Bounce is 0
* Mine is fired and [ship]MaxMines is 0
* A prize is picked up and [PrizeWeight] of that prize is 0
* Stealth is turned on and [ship]StealthStatus is 0
* Cloak is turned on and [ship]CloakStatus is 0
* XRadar is turned on and [ship]XRadarStatus is 0
* Anti-Warp is turned on and [ship]AntiWarpStatus is 0
* Player uses ufo

If one of the above conditions is true red sysop alert message is triggered and
that weapon packet is ignored. If [security]SecurityKickoff is 1 in server.cfg
file player is kicked out too. Check is deactiveded for smod+

Added functinality to enable mod/smod/sysop commands only in certain arenas.
Access is controlled via moderate.txt/smod.txt/sysop.txt. To restrict access
append to moderate.txt/smod.txt/sysop.txt:
+playername:arenaname
If arenaname is empty access is granted in main (public) arenas. If arenaname
is @ access is granted in all private (not main) arenas. Here is an example of
smod.txt to grant smod access to PriitK in all arenas, to Foobar in public
arenas only, to Poophead in all private arenas and to Lagger in elim and super
arena
------smod.txt------
PriitK
Foobar
Poophead
Lagger
+Foobar:
+Poophead:@
+Lagger:elim
+Lagger:super

New cfg variable: Misc:MaxPlayers. Overrides server.ini's Arena:ArenaMaxPlayers
variable for a spawn

New server.ini variable: Misc:ShipTypeSwitchResetPeriod. If set non-zero player
shipchange counters are reset in given period. It allows to set
Security:MaxShipTypeSwitchCount low to kick out players that use ship changes
to get good configuration or spawning spot

New cfg variable: Misc:GreetMessage. It is sent to player when s/he enters
spawn

New cfg variables: Misc:PeriodicMessage0-PeriodicMessage4. Value must have
following syntax: <period> <delay> [*]<text>
If set and players are in spawn <text>s starting with * are sent out as zone
messages and without * as arena messages. <period> <delay> are in minutes,
<delay> indicates when first message is sent after arena creation.

New command: /*watchgreen. Toggles player green pickup logging on/off for
selected player. Then turned on, moderator who did it will receive notification
message every time when that player picks up green

New command: /*einfo. Displays player billing user id and screen resolution

New command: /*lag. Displays player ping and packetloss

New command: ?lag. Displays ping and packetloss

New commads: *getfile, *putfile and *delfile. Allow sysop to get/put/delete
files from server directory. exe, com, dll, bat and cmd files are offlimits.
Following commands were removed: get/putsysoplist, get/putsmodlist,
get/putnews, get/putobscene

New command: *listban. Lists all active /*kill <minutes> bans with machine id,
time in seconds since ban was made, ban length in seconds

New command: *removeban <machineid>. Removes a /*kill <minutes> ban

----------------------------- version 1.34.4 ----------------------------------
New command: /*ufo

New command: /*super. If player isn't smod+ server will give data checksum
warnings

New command: ?scorereset and 2 server.ini settings: Misc:AllowPubScorereset and
Misc:AllowPvtScorereset

New command: *listmod - lists all mods+ in zone. SMod+ access is required for
this commad

Fixed flag neuting: New server.ini setting Misc:TimerDropFlagTerritoryRadius
same as Flag:FlagTerritoryRadius, but will used only if flags are dropped when
timer expires. So, if you set Flag:FlagTerritoryRadius to 0 and
Misc:TimerDropFlagTerritoryRadius to 8 flags will be respawned on freq/ship
change

Removed /*setfreq restrictions

Fixed bug that caused occasional zone crashes

----------------------------- version 1.34.3 ----------------------------------
? commands flooding protection (?chat macro)

freq change flooding protection (=%freq macro in spec)

New command: *specall - puts all players in arena to spec, but doesn't lock
them. Usual access restrictions apply: mods and smods cant spec sysops and mods

New server.ini variable: Misc:NoAntiInSafe. If set to non-zero antiwarp is
disabled in safe zones

New server.ini variable: Misc:LockFreqs. If set to non-zero freq changing when
arena is locked is disabled

New server.ini variable: Misc:PositionDataAccess. Extra position data is really
information about the player ship. It is displayed to spectators in the top of
screen (energy, rockets, walls, portals, etc). Normally only sysops see it, but
it can be configured in server.cfg via Misc:ExtraPositionData so, that all
players see it. It is not recommended, because it increases bandwidth players
use about 50% thus increasing ping/packetloss. This variable controls, who see
extra data. 0 - only sysops, 1 - smod+, 2 - mod+. It is meaningful only if
Misc:ExtraPositionData is 0 in server.cfg

New server.ini variable: Misc:AlertCommand. Replacement to BanG ?cheater
command. Players can type ?<Misc:AlertCommand> <text>, that <text> is sent to
all mods+ who are in the zone. Command is disabled, if value of this variable
is empty.

Negative bounty fix. Negative bounty is ignored and will trigger red sysop
messages
</pre>

[[Category: Subgame]]
[[Category: Servers]]

Talk:TCP Billing FAQ

2007-02-10T12:33:09Z

Doc flabby:

just noticed this is the protocol faq, someone (read, pests) can split this into general faq --[[User:Smong|Smong]]

The part about the Biller being unable to restart/shutdown zones is incorrect. Catid's biller is capable of doing so. -L.C.

CatId's biller is a UDP Biller. This is the TCP Billing page - Doc Flabby

Zone.dat

2007-01-10T21:28:25Z

Doc flabby: /* Zone.dat format */

[[Category:Category Formats]]

== Zone.dat format ==

For each zone an entry like this must exist.

The last field indicates that [[Continuum]] will not warn you are entering a non-[[SSC]] zone. This is changed to 1 if you tick the box do not warn me again in Continuum. The unknown field often seems to contain a dns name for some zones such as "server.trenchwars.org" for Trench Wars.
<Warn non-SSC zone> value is ignored by Continuum if the zone is an SSC zone.

<pre>
<Zone name>,<Zone ip>,<Zone port>,<unknown dns (can be left blank)>,<Warn non-SSC zone>
#<description>
</pre>

Example:

<pre>
SSCU Trench Wars,66.36.241.110,5400,server.trenchwars.org,0
#SSCU Trench Wars - Sysops: DoCk> and PriitK - http://www.trenchwars.org ss://server.trenchwars.org
</pre>

Zone.dat

2007-01-10T21:27:37Z

Doc flabby: edited example to make it more relivent :P

[[Category:Category Formats]]

== Zone.dat format ==

For each zone an entry like this must exist.

The last field indicates that [[Continuum]] will not warn you are entering a non-[[SSC]] zone. This is changed to 1 if you tick the box do not warn me again in Continuum. The unknown field often seems to contain a dns name for some zones such as "server.trenchwars.org" for Trench Wars.

<pre>
<Zone name>,<Zone ip>,<Zone port>,<unknown dns (can be left blank)>,<Warn non-SSC zone>
#<description>
</pre>

Example:

<pre>
SSCU Trench Wars,66.36.241.110,5400,server.trenchwars.org,0
#SSCU Trench Wars - Sysops: DoCk> and PriitK - http://www.trenchwars.org ss://server.trenchwars.org
</pre>

Zone.dat

2007-01-10T21:26:10Z

Doc flabby: Description of zone.dat format

[[Category:Category Formats]]

== Zone.dat format ==

For each zone an entry like this must exist.

The last field indicates that [[Continuum]] will not warn you are entering a non-[[SSC]] zone. This is changed to 1 if you tick the box do not warn me again in Continuum. The unknown field often seems to contain a dns name for some zones such as "server.trenchwars.org" for Trench Wars.

<pre>
<Zone name>,<Zone ip>,<Zone port>,<unknown dns (can be left blank)>,<Warn non-SSC zone>
#<description>
</pre>

Example:

<pre>
PSSF Kitty Girls!!!,64.79.194.184,5000,,1
#Kitty Girls for all!
</pre>

User:Grelminar

2007-01-10T21:13:17Z

Doc flabby: updated url to correct one

Creator and Lead Developer of [[ASSS]] and its associated software (such as [[CCC]]).

Homepage: http://asss.yi.org/

To learn more about Grelminar, read the [[User:Grelminar/Interview.txt|interview]] between him and Fallen Angel done in October 2003.

[[Category: People]]

Directory Game Server Protocol

2007-01-10T00:11:32Z

Doc flabby: another correction 8+2 isnt 14 as i have found out :P

== Introduction ==
[[Zone|Game Servers]] such as [[subgame2]] and [[ASSS]] register their prescence on [[Directory server|Directory Servers]]. This page describes the portion of the '''directory server protocol''' that game servers use.

This system uses UDP packets, most commonly over port 4991. Maximum length of the packet is only limited to the directory server software itself, so it varies from each application. The specific lengths of most fields are static, with the zone description field being the only value that varies its length.

== Protocol ==
<pre>
g2d

register game server
offset size comment
0 4 ip (leave this set to 0?)
4 2 port
6 2 player count
8 2 saving scores? (boolean)
10 4 version (set this to 134)
14 32 zone name (null terminated)
46 16 password (null terminated)
62 32 reserved (suggested to set this to 0)
94 ? description (must be null terminated)
</pre>

== Notes on Priit's dirserv ==
Descriptions are recorded to the stats file with a max length of 490 bytes. The reserved field can be filled with any random data, as the directory server ignores this field completely.

== Notes on Catid's dirserv ==

=== Validating the packet ===
* The length of the packet must be greater than 95/0Ã—5F bytes. Basically this means the description can be blank but must be null terminated.
* The first 4 bytes (the IP field) must be zeroed.
* The reserved field must be zeroed.
* The name, password and description must be null terminated.
* The "save scores" field must be either 0 or 1.

=== Validating the zone name ===
* Name must be at least one character long.
* First and last characters must cannot be a space.
* No more than one space in a row.
* Only ASCII characters between â€˜ â€˜ [0x20] and â€˜~â€™ [0x7E], inclusive.

== Notes on zone.dat ==
Due to the format of zone.dat used to store your favourite zones, zone names should not begin with '#' [0x23] or contain any ',' [0x2C].

== See also ==
* [http://cypherjf.sscentral.com/articles/game-server-to-directory-server/ CypherJF's original document]
* [http://web.archive.org/web/*/http://www4.ncsu.edu/~rniyenga/subspace/old/dprotocol.html Hammuravi's page]
* [http://asss.yi.org/asss/ ASSS Source]: src/directory.c
* [[Directory Client Protocol]]

[[Category: Protocol]]

Directory Game Server Protocol

2007-01-10T00:08:43Z

Doc flabby: 62 + 32 is 94 and not 92 as i have just found out

== Introduction ==
[[Zone|Game Servers]] such as [[subgame2]] and [[ASSS]] register their prescence on [[Directory server|Directory Servers]]. This page describes the portion of the '''directory server protocol''' that game servers use.

This system uses UDP packets, most commonly over port 4991. Maximum length of the packet is only limited to the directory server software itself, so it varies from each application. The specific lengths of most fields are static, with the zone description field being the only value that varies its length.

== Protocol ==
<pre>
g2d

register game server
offset size comment
0 4 ip (leave this set to 0?)
4 2 port
6 2 player count
8 2 saving scores? (boolean)
12 4 version (set this to 134)
14 32 zone name (null terminated)
46 16 password (null terminated)
62 32 reserved (suggested to set this to 0)
94 ? description (must be null terminated)
</pre>

== Notes on Priit's dirserv ==
Descriptions are recorded to the stats file with a max length of 490 bytes. The reserved field can be filled with any random data, as the directory server ignores this field completely.

== Notes on Catid's dirserv ==

=== Validating the packet ===
* The length of the packet must be greater than 95/0Ã—5F bytes. Basically this means the description can be blank but must be null terminated.
* The first 4 bytes (the IP field) must be zeroed.
* The reserved field must be zeroed.
* The name, password and description must be null terminated.
* The "save scores" field must be either 0 or 1.

=== Validating the zone name ===
* Name must be at least one character long.
* First and last characters must cannot be a space.
* No more than one space in a row.
* Only ASCII characters between â€˜ â€˜ [0x20] and â€˜~â€™ [0x7E], inclusive.

== Notes on zone.dat ==
Due to the format of zone.dat used to store your favourite zones, zone names should not begin with '#' [0x23] or contain any ',' [0x2C].

== See also ==
* [http://cypherjf.sscentral.com/articles/game-server-to-directory-server/ CypherJF's original document]
* [http://web.archive.org/web/*/http://www4.ncsu.edu/~rniyenga/subspace/old/dprotocol.html Hammuravi's page]
* [http://asss.yi.org/asss/ ASSS Source]: src/directory.c
* [[Directory Client Protocol]]

[[Category: Protocol]]

Talk:Core Protocol

2007-01-09T17:31:01Z

Doc flabby: /* Note on 0x0a00 packet */

Door Settings

2006-10-04T18:43:31Z

Doc flabby: /* DoorMode */ was missing some info added it from complete settings page

[Door] Settings for [[door]]s in an arena.

=== DoorDelay ===

''Datatype:'' Hundredths of seconds.

How often doors attempt to switch their state.

=== DoorMode ===

''Datatype:'' Bitfield.

Each bit of this field determines whether its represented door is open or not. The 8 bits, from left to right, represent the 8 door tiles in the tileset, from left to right.

Special values:
* -2 = all doors completely random
* -1 = weighted random (some doors open more often than others)
* 0-255 = fixed doors (1 bit of byte for each door specifying whether it is open or not)

[[Category: Settings]]

ASSS Commands Cheatsheet

2006-10-04T10:23:16Z

Doc flabby:

==ASSS Commands Cheat Sheet==
* Sep 30 2006 smong: initial version

* This is a rough guide to the new/most used commands in [[ASSS]].
* If you are already familar with [[Subgame2]] this should help you make the change.

===Just a quick health warning about arenas===
* when creating arenas try not to put a number on the end. the reason for this is because asss can spawn many arenas of the same type, just like there can be many pubs. for example ?go elim, ?go elim1 and ?go elim2 will all read the same settings and scores from arenas/elim.

=== Why aren't any staff commands working #$%@!? ===
* You need to be in conf/staff.conf and if you don't have billing setup you also need to use ?passwd.

----

===The Cheatsheet===

Naming convention's in this document:
* <blah> - you must replace <blah> with some text.
* [blah] - blah is an optional.
* filter - filter text doesn't have to be a whole name, for example you can do ?reloadconf ar to reload all arena.conf's and ?quickfix decoy to see all related decoy settings (MaxDecoy, InitialDecoy, PrizeWeight:Decoy, etc).

====Player Commands====

* ?listmod - show logged in staff.
* ?passwd <usual ss password> - if the biller goes down asss will use this is used to make sure you are not an imposter.
* /?sendfile <filename> - pm this to another player to send them a file thats in your continuum directory.
* ?arena -a -t - print all arenas in the server to the chat.

====Mod Commands====

* ?recyclearena - reloads everything in the arena. use this if you changed the map/lvz or UPLOADED new settings. there is no need to use this if you changed settings ingame.
* ?resetturrets - removes all "fake players"/server-side bots. you have to do this before you can recycle an arena.
* ?flagreset - reset the flag game.
* ?ballcount <balls> - set the ball count for the arena. so if there are no balls and you type ?ballcount 1 a ball will be added.
* ?flaginfo - show location/owner of each flag.
* ?timer A:B - where A is minutes and B is seconds, set to 0:0 to stop it.
* ?setjackpot <pts> - change the jackpot to pts.
* ?prize <prizes> - grant prizes to everyone, or whoever you pm. note you can say stuff like "?prize 3 bomb 4 shrap prox bounce"
* ?a <msg> - arena message
* ?z <msg> - zone message

====Smod Commands====

* ?putmap <mapname> - the map must be in your continuum folder. this will replace the map of the arena you are currently in (it will upload the map and change the general:map= setting).
* esc + c / ?getsettings - the usual, change an arenas settings.
* ?quickfix <filter> - change an arenas settings, but this time only show settings that contain "filter". this is the preferred way of changing settings while logged in since you don't have to scroll around them so much.
* ?attmod [-d] <name> - attach a module to an arena, use -d flag to detach it.

====Sysop Commands====

* ?lsmod [-a] [<filter>] - show currently loaded modules. use -a flag to see what's attached to the current arena. use filter to only show matching modules.
* ?insmod [<loader>] <name> - for python modules use "<py>" as the loader, otherwise leave it out.
* ?rmmod <name> - unloads a module from the server.
* ?lastlog [<max lines>] [<filter>] - shows the recent server logs.
* ?shutdown -r - kicks everyone out and restarts the entire zone.
* ?reloadconf [<filter>] - force reload of open conf files. you can use a partial file name as the filter.
* ?pwd - show where uploaded files will go.
* ?cd <dir. name> - change directory of where uploaded files will go. leave dirname blank to go back to the root (only news.txt is stored at the root).
* ?putfile <file name> - upload a file from your continuum directory to the server (see also ?cd).
* ?makearena <name> - create a new arena based off the default arena. note: do not use arena names that end in a number.

sample directories to ?cd to:
arenas/(public)
arenas/(default)
arenas/duel
conf
conf/groupdef.dir
maps
bin
log

[[Category:ASSS]]
[[Category:Guides]]

ASSS Commands Cheatsheet

2006-10-04T10:20:31Z

Doc flabby: added smongs cheat sheet

==ASSS Commands Cheat Sheet==
* Sep 30 2006 smong: initial version

* This is a rough guide to the new/most used commands in asss.

===Just a quick health warning about arenas===
* when creating arenas try not to put a number on the end. the reason for this is because asss can spawn many arenas of the same type, just like there can be many pubs. for example ?go elim, ?go elim1 and ?go elim2 will all read the same settings and scores from arenas/elim.

=== Why aren't any staff commands working #$%@!? ===
* You need to be in conf/staff.conf and if you don't have billing setup you also need to use ?passwd.

----

===The Cheatsheet===

Naming convention's in this document:
* <blah> - you must replace <blah> with some text.
* [blah] - blah is an optional.
* filter - filter text doesn't have to be a whole name, for example you can do ?reloadconf ar to reload all arena.conf's and ?quickfix decoy to see all related decoy settings (MaxDecoy, InitialDecoy, PrizeWeight:Decoy, etc).

====Player Commands====

* ?listmod - show logged in staff.
* ?passwd <usual ss password> - if the biller goes down asss will use this is used to make sure you are not an imposter.
* /?sendfile <filename> - pm this to another player to send them a file thats in your continuum directory.
* ?arena -a -t - print all arenas in the server to the chat.

====Mod Commands====

* ?recyclearena - reloads everything in the arena. use this if you changed the map/lvz or UPLOADED new settings. there is no need to use this if you changed settings ingame.
* ?resetturrets - removes all "fake players"/server-side bots. you have to do this before you can recycle an arena.
* ?flagreset - reset the flag game.
* ?ballcount <balls> - set the ball count for the arena. so if there are no balls and you type ?ballcount 1 a ball will be added.
* ?flaginfo - show location/owner of each flag.
* ?timer A:B - where A is minutes and B is seconds, set to 0:0 to stop it.
* ?setjackpot <pts> - change the jackpot to pts.
* ?prize <prizes> - grant prizes to everyone, or whoever you pm. note you can say stuff like "?prize 3 bomb 4 shrap prox bounce"
* ?a <msg> - arena message
* ?z <msg> - zone message

====Smod Commands====

* ?putmap <mapname> - the map must be in your continuum folder. this will replace the map of the arena you are currently in (it will upload the map and change the general:map= setting).
* esc + c / ?getsettings - the usual, change an arenas settings.
* ?quickfix <filter> - change an arenas settings, but this time only show settings that contain "filter". this is the preferred way of changing settings while logged in since you don't have to scroll around them so much.
* ?attmod [-d] <name> - attach a module to an arena, use -d flag to detach it.

====Sysop Commands====

* ?lsmod [-a] [<filter>] - show currently loaded modules. use -a flag to see what's attached to the current arena. use filter to only show matching modules.
* ?insmod [<loader>] <name> - for python modules use "<py>" as the loader, otherwise leave it out.
* ?rmmod <name> - unloads a module from the server.
* ?lastlog [<max lines>] [<filter>] - shows the recent server logs.
* ?shutdown -r - kicks everyone out and restarts the entire zone.
* ?reloadconf [<filter>] - force reload of open conf files. you can use a partial file name as the filter.
* ?pwd - show where uploaded files will go.
* ?cd <dir. name> - change directory of where uploaded files will go. leave dirname blank to go back to the root (only news.txt is stored at the root).
* ?putfile <file name> - upload a file from your continuum directory to the server (see also ?cd).
* ?makearena <name> - create a new arena based off the default arena. note: do not use arena names that end in a number.

sample directories to ?cd to:
arenas/(public)
arenas/(default)
arenas/duel
conf
conf/groupdef.dir
maps
bin
log

[[Category:ASSS]]

Main Page

2006-10-04T10:06:43Z

Doc flabby: added reference to commands cheat sheet

<div style="border: 1px solid #c6c9ff; background-color: #f0f0ff; text-align: center; font-variant: small-caps;">
Quicklinks:
[[:Category:ASSS|ASSS Documents]] | [[:Category:FAQ|Frequently Asked Questions]] | [[:Category:Guides|Guides]] | [[:Category:Definitions|Glossary]] | [[:Category:Utilities|Utilities]] | [[Special:Categories|More...]]
</div>

<table cellspacing=10><tr valign="top"><td>
<h3>What is ASSS?</h3>
[[ASSS]] (A Small Subspace Server) was created by [[User:grelminar|grelminar]]. Its an open source server designed to allow [[Continuum]] users to connect with. Its a replacement, not a clone, of [[Subgame]], which was created by [[VIE]] and later upgraded by [[PriitK|Priit Kasesalu]], a freelance [[Subspace]] programmer who also wrote Continuum with the assistance of [[Mr Ekted]].

ASSS allows many advanced features never before offered by Subgame nor user-made [[Bots]]. Within, you'll find documentions about how to use some of these advanced features, and documentation about how to create your own extensions to the server software. There is also a [[ASSS Commands Cheatsheet]] to help you get started.

To start finding answers try the quicklinks (above) or check out the [[Special:Categories|Categories]]. If you're having problems with your server, try reading the [[Server Troubleshooting]] guide. If you would like to contribute see [[ASSS_Wiki:Community Portal|Community Portal]]. For further assistance or questions, please visit the [http://forums.minegoboom.com Server Help Forums] where other users will be able to respond to your questions.

<h3>External Links</h3>

*[http://asss.yi.org/asss/ Official ASSS Site]
*[http://www.shanky.com/server/ Server Help]
*[http://forums.minegoboom.com/ Server Help Forums]

</td><td style="width: 30%; border: 1px solid #c6c9ff; padding: 5px">
<h3>Current Events</h3>

ASSS version 1.4.3 has been released as of June 8, 2006. As of September 9, 2006, the version control server has been updated. ''I've upgraded the monotone server at asss.yi.org to 0.29. The is incompatible with the previous version (0.24) in several ways. You will need to create a new database and fetch everything again, and then create a new working copy.''

'''Download'''
*[http://asss.yi.org/asss/files/asss-1.4.3.tar.gz Linux]
*[http://asss.yi.org/asss/files/asss-1.4.3-srconly.tar.gz Source Only]
*[http://asss.yi.org/asss/files/asss-1.4.3.zip Windows]
*[http://asss.yi.org/viewmtn/branch.psp?branch=asss.asss.main Change Log]

[[Current events|More Events...]]
</tr></table>

Server Configuration Faq

2006-06-25T18:42:40Z

Doc flabby:

Here are some answers to basic questions that most people unfamiliar with each server usually have. More info can usually be found on the specific [[settings]] pages.

==ASSS==

=== Using the latest version of ASSS but can't connect to a CatId biller using the ssc_billing module ===
You need to add a ScoreID and ServerID value to the [billing] section of global.conf. These CANNOT be zero to work with the catid biller.

for example:
<pre>
[billing]
ScoreID = 1
ServerID = 1
</pre>

=== I've added myself to the [(global)] section of staff.conf, but it doesn't set me as staff! ===

There are a number of things that could be happening here. Firstly if you were in the zone at the same time as you were editing staff.conf you should now re-enter. If you are not using a biller you must add a passwd.conf entry for your alias and make sure you have the module auth_file loaded. The easiest way to do this is to log in and type ?passwd <subspace login password>. You can then log out and back in.

=== How do I add LVZ files? ===

Add LVZ files through the same setting as in Server.cfg in your [[arena.conf]]:
<pre>
[Misc]
LevelFiles=mylvz.lvz
</pre>
Then add your lvzs to the maps/ directory located in the main ASSS directory. You can also add HLP files this way.

=== Where is my *arena? ===

With ASSS there is no distinction between ? and * commands. Since ?arena is hardcoded into the client (esc + a) and cannot be changed a compromise had to be made. Subgame style *arena and *zone are now ?a and ?z respectively. Alternatively you can load the sgcompat module which will restore the * style commands.

=== There's something weird about my arena, it ends with a number ===

Arena names cannot end with a number since ASSS supports multiple subarenas of the same type, just like there can be many public arenas sharing the same settings. If your arena is named elim, then elim1, elim2, etc use the same settings.

==Subgame==

=== What does the ss://some.dns mean in zone description? ===
This allows users who host on a dynamic IP address to have Continuum always find the server, even if it changes its location. A good service to use is [http://www.dyndns.org/ DynDNS], [http://www.no-ip.com No-IP]. From there, you can create an address such as myzonename.game-server.cc or any of their other [http://www.dyndns.org/services/dyndns/domains.html domains]. Then, in your Server.ini file, under the Directory:Description, add ss://myzonename.game-server.cc to the end of your description. Then, whenever you get a new IP address and your DynDNS client updates, users can automatically find your new address and will see it online again, without having to search through the zone list.

[[Category: ASSS]]
[[Category: FAQ]]