ASSS Wiki - User contributions [en]

Writing Advanced Modules In C

2015-07-06T00:07:06Z

Cheese: wrote callback tutorial and interface tutorial

This tutorial explains how to write advanced modules in C.
It is assumed you know how to code and are familiar with how the ASSS code works.

This tutorial is a continuation of [[Writing Modules In C]].

Some useful references:

http://qnxcs.unomaha.edu/help/product/neutrino/lib_ref/summary.html

http://www.cplusplus.com/reference/

http://www.cprogramming.com/tutorial.html

== Passing Data To Timers ==

<pre>
typedef struct ThisIsData
{
Player *p;
int number;
} ThisIsData;

local int timerfunc(void *vp) //vp is void pointer, just an address that can point anywhere
{
ThisIsData *tid=(ThisIsData*)vp; //we know it points to our data

if(tid->number == 10)
{
//if it worked anything in here will work too
}

int returnValue=0; //return 1 if you want timer to run again, or 0 if you want it to be removed
if(!returnValue) afree(tid); //if zero, free the data we have previously allocated
return returnValue;
}

anotherfunction()
{
ThisIsData *tid=amalloc(sizeof(ThisIsData)); //we must allocate memory because anything in this function is destroyed when it ends

tid->number=10

//now set timer to activate in 1000 centiseconds, then repeat every 100.
//we are also sending the address of the memory we just allocated.
ml->SetTimer(timerfunc,1000,100,tid,0);
}
</pre>

== Passing Multiple Arguments To Commands ==

Since the words are read one by one against the whole list, they can be in any order!

<pre>
// define macros for comparing strings that work on linux
#ifndef WIN32
//a case insensitive comparison that returns 0 if both are the same
#define stricmp(x,y) (strcasecmp(x,y) == 0)
//a case insensitive comparison that returns 0 if both are the same for the first N letters
#define strnicmp(x,y,n) (strncasecmp(x,y,n) == 0)
#endif

local void examplecommand(const char *command, const char *params, Player *p, const Target *t)
{
chat->SendMessage(p,"Sentence: %s",params);

char buf[255];
char *word=NULL;
const char *tmp=NULL;
while(strsplit(params," ,:",buf,sizeof(buf),&tmp))
{
word=buf; //move start of word to beginning
chat->SendMessage(p,"Word: %s",word); //the word currently being reviewed

if(strnicmp(word,"a=",2)) //remember, the N means it is checking only first 2 letters
{
//do stuff if first 2 letters of word are 'a' then '='

word+=2; //like move start of word 2 letters forward
int check=atoi(word); //then read a number
}
else if(strnicmp(word,"bc=",3)) //3 this time
{
//do stuff if first 3 letters of word are 'b' then 'c' then '='

word+=3; //make sure you move it 3 letters and not 2
int check=atoi(word); //then read a number
}
else if(stricmp(word,"-de")) //no N, it just checks the whole thing
{
//do stuff if word is "-de"
}
}
}
</pre>

== Creating Callbacks ==

In a header somewhere public, you will want to declare your callback constant so people writing modules that use it can compile properly.
An acceptable solution to this is distributing a whatever.h file with your module if your module is closed source.
At a minimum, you should have a comment describing your callback, the callback constant definition, and a function prototype the caller will need to match.
You can pass variables to the calling functions.

<pre>

//in whatever.h

//when u load my module
#define CB_MY_MODULE_JUST_ATTACHED "mymodulejustattached-1"
typedef void (*MyModuleJustAttachedFunc)(Arena *a, int num);

</pre>

You will then need to use the DO_CBS macro in your code to call the callback functions other people have written.
You can find the definition of this macro at the end of module.h

<pre>

//in whatever.c

local Imodman *mm;
local Ilogman *lm;

int bestnumber=42;

EXPORT int MM_cbstest(int action, Imodman *mm2, Arena *a)
{
if(action == MM_LOAD)
{
mm=mm2;
lm=mm->GetInterface(I_LOGMAN,ALLARENAS);
if(!lm) return MM_FAIL;

lm->Log(L_ERROR,"<cbstest> Callback Test Module has loaded.");

return MM_OK;
}
else if(action == MM_ATTACH)
{
lm->LogA(L_ERROR,"cbstest",a,"Callback Test Module has attached to the arena.");

//this triggers registered callback functions to all arenas with a pointer to the arena you just attached to and a number
DO_CBS(CB_MY_MODULE_JUST_ATTACHED, ALLARENAS, MyModuleJustAttachedFunc, (a, bestnumber));

return MM_OK;
}
else if(action == MM_DETACH)
{
lm->LogA(L_ERROR,"cbstest",a,"Callback Test Module has detached from the arena.");

return MM_OK;
}
else if(action == MM_UNLOAD)
{
lm->Log(L_ERROR,"<cbstest> Callback Test Module has unloaded.");

mm->ReleaseInterface(lm);

return MM_OK;
}
return MM_FAIL;
}

</pre>

== Creating Interfaces ==

The alternative to creating callbacks for other modules to use is creating an interface.<br>
In callbacks, you run their code. In interfaces, they run your code.<br>
Just like in callback writing, you will need to have a public header to compile code against.<br>
In this header you will need an interface constant defined and a prototype struct of function prototypes.<br>
It is good practice to have easy to read, clear function names and a comment describing what each function does.<br>

<pre>

//in whatever.h

#define I_BANANAS "bananas-1"

//the bananas interface struct
typedef struct Ibananas
{
INTERFACE_HEAD_DECL

//say bananas in chat
void (*SayBananas)(void);

//count bananas
int (*CountBananas)(int howmany);

//say player is bananas
int (*PlayerIsBananas)(Player *p);
} Ibananas;

</pre>

You will then need to create the functions that the interface will call.
After that, you will need to create the actual interface struct.

<pre>

//in whatever.c

local Imodman *mm;
local Ilogman *lm;

local void SayBananas(void)
{
lm->Log(L_ERROR,"<inttest> bananas!");
}

local void CountBananas(int howmany)
{
lm->Log(L_ERROR,"<inttest> %u bananas!",howmany);
}

local void PlayerIsBananas(Player *p)
{
lm->Log(L_ERROR,"<inttest> %s is bananas!",p->name);
}

local Ibananas bananasint=
{
INTERFACE_HEAD_INIT(I_BANANAS,"bananas")
SayBananas, CountBananas, PlayerIsBananas
};

EXPORT int MM_inttest(int action, Imodman *mm2, Arena *a)
{
if(action == MM_LOAD)
{
mm=mm2;
lm=mm->GetInterface(I_LOGMAN,ALLARENAS);
if(!lm) return MM_FAIL;

lm->Log(L_ERROR,"<inttest> Interface Test Module has loaded.");

return MM_OK;
}
else if(action == MM_ATTACH)
{
lm->LogA(L_ERROR,"inttest",a,"Interface Test Module has attached to the arena.");

return MM_OK;
}
else if(action == MM_DETACH)
{
lm->LogA(L_ERROR,"inttest",a,"Interface Test Module has detached from the arena.");

return MM_OK;
}
else if(action == MM_UNLOAD)
{
lm->Log(L_ERROR,"<inttest> Interface Test Module has unloaded.");

mm->ReleaseInterface(lm);

return MM_OK;
}
return MM_FAIL;
}

</pre>

== Sending Packets To Players ==

Cover position packets, weapon packets, clientset stuff, etc.
Write me!

<pre>
//example code goes here
</pre>

== Using Advisors ==

Write me!

<pre>
//example code goes here
</pre>

== Creating Advisors ==

Write me!

<pre>
//example code goes here
</pre>

[[Category:Module]]
[[Category:Guides]]

Peer Protocol

2015-02-16T19:57:07Z

Cheese:

This protocol is UDP and bi-directional. It is used by [[Subgame]] and the VIE servers.<br>
SubSpace game servers can communicate with each other via the SubSpace Peer protocol.<br>
Unlike most other protocols in SubSpace, the peer protocol does not make use of the SubSpace Control Protocol.<br>
Rather, it uses lightweight datagrams and accepts packets based on a whitelist of the datagram source's (IP, port) pair.<br>
Player lists/player count packets are sent at approximately 250ms intervals.<br>

===SendTo Command===
<pre>
sendto command example usage:
/*sendto zone ip, zone port
full subgame syntax is:
*sendto IP,port,arenaname
does not work for staff members being sent with staff password appended to their password
</pre>

===Settings===
<pre>
Go request (GR) definition:
Any time a client asks to go to a new arena. In Cont, when a zone is first entered, it asks to go to a NULL arena (i.e. no arena name is given). This is the same as typing "?go" in subgame (no arena name). Other clients (bots, chatnet clients, etc.) can and do sometimes ask to go to specific arenas on zone entry.

server.ini sections:
[Peers]
//must include port and be valid hostname or entire entry is ignored.
MyArenas=<ARENA SPEC>
// see below for ARENA SPEC

// maximum number of peers is 8 and # starts at 0: Peer0, Peer1, ... Peer7
[Peer<#>]
//location of peer
Address=<IP>:<PORT>
// passwords explained below
Password=testpw
//arenas to route, players will be sent upon ?go
Arenas=<ARENA SPEC>
//see below
SendOnly=0
//if least one player is in the zone, send player list packet
SendPlayerList=1

<ARENA SPEC>: A comma-separated list of arena names to match. It may not be longer than 511 characters. No more than 32 different arenas may be given. No whitespace is allowed, unless it's meant as part of the arena name. 2 special arena names are recognized, "$pub" and "$pvt". $pub matches any time no arena name is given in a GR. $pvt is the converse of $pub; it _always_ matches unless no arena name is given.

SendOnly: SendOnly could have something to do with *zone and ?alert messages. Both of these are sent in the peering protocol. SendOnly could be a boolean saying you don't want your instance of subgame to broadcast *zone and ?alert if they come from other peers, or an enum for various combinations. This should be easily testable. It could also have something to do with the sending of private (#-prefixed) arena names. edit: it could also be an <ARENASPEC>, to send player lists for only matched arenas.

GR Matching:
When a GR is issued in a zone (or more accurately, subgame instance), it first consults the list Peer:MyArenas, if it exists. If a match is found, the GR is processed normally (as if there were no peers). The purpose appears to be for use with $pvt. If you have a $pvt rule in a [Peer<#>] section to send people to another zone whenever they go to a named arena, this acts as a mask, a list of the arenas you explicitly want this subgame instance to manage.

If no match is found in Peer:MyArenas, each Peer<#>:Arenas list is consulted in order (by number, not the order they appear in the file). On the first match found, the player is transparently redirected to the address for that peer. Note that the arena name will be part of the initial GR issued when the client enters that zone. If after consulting all available peers no match is found, the request is handled normally.

Passwords:
If you decide to have 2 subgame instances peer, they must agree on a password. The password must agree in each INI [Peer<#>] entry which refers to the other zone.

Example: 2 zones running on localhost, subgame-A on port 5000 and subgame-B on port 7777

in subgame-A's ini:
[Misc]
Port=5000

[Peer3]
Address=127.0.0.1:7777
Password=hackme

and in subgame-B's ini:
[Misc]
Port=7777

[Peer1]
Address=127.0.0.1:5000
Password=hackme
</pre>

===Packets===
<pre>
All packets have the following form:
00 01 <passwordHash (4)> FF <type (1)> <timestamp (4)> <payload>
The passwordHash is a CRC32 of the peer password in server.ini.
The payload depends on the type field and their formats are described below.

0x01: Player List

This packet is sent if SendPlayerList=1 and at least one player is in the zone.
It lists all arenas in the zone with a list of all players in each arena.
The list of players for a given arena is null terminated as indicated by the 00 field below.
The arenaID field is a random 32-bit integer that is associated with each arena at the time of its creation.
An arena maintains its arenaID until the arena gets re-created or manually recycled.
{
<arenaID (4)>
<arenaName (asciiZ)>
{
<playerName (asciiZ)>
}
00
} (repeated until end of packet)

0x02: Chat Message

When a peer receives this packet, it broadcasts it as if it were a zone-wide message (*zone).
<type:0 (1)> //currently ignored by subgame, can be anything
<message (asciiZ)>

0x03: ?alert messages

Technically exactly the same as the 0x02 packet, but as this is the result of ?help, ?cheater, etc it should be restricted to the appropriate staff members.
<type:0 (1)> //currently ignored by subgame, can be anything
<message (asciiZ)>

0x04: Player Count

This packet is sent if SendPlayerList=0 or there are no players in the zone. The player count is the total number of players in the zone.
<playerCount (2)>
</pre>

===Subgame internal data structs===
<pre>
struct s2c_sendto
{
BYTE type; // 0x3B
DWORD ip_addr; // IP Address (little endian)
WORD port_num; // Port number (little endian)
WORD join_type; // Same as the arena login packet
char arena_name[16]; // Arena Name
DWORD loginid;
};
</pre>

[[Category: Protocol]]

Core Protocol

2015-02-16T17:59:23Z

Cheese: moved Core protocol to Core Protocol over redirect

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 recursively)

<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 (see reliable packet addendum below)
offset size comment
0 1 type 0x00
1 1 type 0x03
2 4 packet id (ie: ACK_ID)
6 ? payload (514 bytes max)

0x04 reliable acknowledge (see reliable packet addendum below)
offset size comment
0 1 type 0x00
1 1 type 0x04
2 4 packet id (ie: ACK_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

0x10 Continuum alternate encryption response (s2c)?
offset size comment
0 1 type 0x00
1 1 type 0x10
2 10 ??

0x11 Continuum alternate encryption response response (c2s)?
offset size comment
0 1 type 0x00
1 1 type 0x11
2 6 ??
</pre>

----

'''Reliable Packet Handling Addendum'''

Here are some tips when implementing a reliable packet handler stack.

For outgoing traffic:
1. All outgoing traffic must be put into a send list until an ACKnowledgement (0x04) is received with
the same ACK_ID as the traffic.
2. Sometimes double-sending reliable messages is warranted, given high-bandwidth and high-packetloss.
3. ACK's (0x04) should cause disconnection if you have not sent a message with that ACK_ID yet.
4. ACK_ID starts at 0 for both client and server, ACK_ID is incremented by one every time.

For incoming traffic:
1. ACK (0x04) all incoming Reliable traffic no matter what. ACK the traffic twice if it makes you feel happy.
2. All incoming traffic must be processed in the order of the ACK_ID's.
3. If a packet is lost, all traffic stamped with an ACK_ID higher than the next expected ACK_ID
must be placed on a backlog list of packets until the packet in sequence is finally received.
4. If an incoming reliable message's ACK_ID has already been processed, ignore the packet.

<h3>External Links</h3>
* [http://mervbot.com/files/addendum.txt Catid's Subspace Addendum]

[[Category: Protocol]]

Talk:Core Protocol

2015-02-16T17:59:23Z

Cheese: moved Talk:Core protocol to Talk:Core Protocol

== 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

2015-02-16T17:59:23Z

Cheese: moved Core protocol to Core Protocol over redirect

#REDIRECT [[Core Protocol]]

Talk:Core protocol

2015-02-16T17:59:23Z

Cheese: moved Talk:Core protocol to Talk:Core Protocol

#REDIRECT [[Talk:Core Protocol]]

Peering Protocol

2015-02-16T17:56:52Z

Cheese: Redirected page to Peer Protocol

#REDIRECT [[Peer Protocol]]

Peer Protocol

2015-02-16T17:56:45Z

Cheese: Created page with "This protocol is UDP and bi-directional. It is used by Subgame and the VIE servers.<br> SubSpace game servers can communicate with each other via the SubSpace Peer protocol.<..."

This protocol is UDP and bi-directional. It is used by [[Subgame]] and the VIE servers.<br>
SubSpace game servers can communicate with each other via the SubSpace Peer protocol.<br>
Unlike most other protocols in SubSpace, the peer protocol does not make use of the SubSpace Control Protocol.<br>
Rather, it uses lightweight datagrams and accepts packets based on a whitelist of the datagram source's (IP, port) pair.<br>
Player lists/player count packets are sent at approximately 250ms intervals.<br>

===SendTo Command===
<pre>
sendto command example usage:
/*sendto zone ip, zone port
full syntax is:
*sendto IP,port,arenaname
does not work for staff members being sent with staff password appended to their password
</pre>

===Settings===
<pre>
Go request (GR) definition:
Any time a client asks to go to a new arena. In Cont, when a zone is first entered, it asks to go to a NULL arena (i.e. no arena name is given). This is the same as typing "?go" in subgame (no arena name). Other clients (bots, chatnet clients, etc.) can and do sometimes ask to go to specific arenas on zone entry.

server.ini sections:
[Peers]
//must include port and be valid hostname or entire entry is ignored.
MyArenas=<ARENA SPEC>
// see below for ARENA SPEC

// maximum number of peers is 8 and # starts at 0: Peer0, Peer1, ... Peer7
[Peer<#>]
//location of peer
Address=<IP>:<PORT>
// passwords explained below
Password=testpw
//arenas to route, players will be sent upon ?go
Arenas=<ARENA SPEC>
//see below
SendOnly=0
//if least one player is in the zone, send player list packet
SendPlayerList=1

<ARENA SPEC>: A comma-separated list of arena names to match. It may not be longer than 511 characters. No more than 32 different arenas may be given. No whitespace is allowed, unless it's meant as part of the arena name. 2 special arena names are recognized, "$pub" and "$pvt". $pub matches any time no arena name is given in a GR. $pvt is the converse of $pub; it _always_ matches unless no arena name is given.

SendOnly: SendOnly could have something to do with *zone and ?alert messages. Both of these are sent in the peering protocol. SendOnly could be a boolean saying you don't want your instance of subgame to broadcast *zone and ?alert if they come from other peers, or an enum for various combinations. This should be easily testable. It could also have something to do with the sending of private (#-prefixed) arena names. edit: it could also be an <ARENASPEC>, to send player lists for only matched arenas.

GR Matching:
When a GR is issued in a zone (or more accurately, subgame instance), it first consults the list Peer:MyArenas, if it exists. If a match is found, the GR is processed normally (as if there were no peers). The purpose appears to be for use with $pvt. If you have a $pvt rule in a [Peer<#>] section to send people to another zone whenever they go to a named arena, this acts as a mask, a list of the arenas you explicitly want this subgame instance to manage.

If no match is found in Peer:MyArenas, each Peer<#>:Arenas list is consulted in order (by number, not the order they appear in the file). On the first match found, the player is transparently redirected to the address for that peer. Note that the arena name will be part of the initial GR issued when the client enters that zone. If after consulting all available peers no match is found, the request is handled normally.

Passwords:
If you decide to have 2 subgame instances peer, they must agree on a password. The password must agree in each INI [Peer<#>] entry which refers to the other zone.

Example: 2 zones running on localhost, subgame-A on port 5000 and subgame-B on port 7777

in subgame-A's ini:
[Misc]
Port=5000

[Peer3]
Address=127.0.0.1:7777
Password=hackme

and in subgame-B's ini:
[Misc]
Port=7777

[Peer1]
Address=127.0.0.1:5000
Password=hackme
</pre>

===Packets===
<pre>
All packets have the following form:
00 01 <passwordHash (4)> FF <type (1)> <timestamp (4)> <payload>
The passwordHash is a CRC32 of the peer password in server.ini.
The payload depends on the type field and their formats are described below.

0x01: Player List

This packet is sent if SendPlayerList=1 and at least one player is in the zone.
It lists all arenas in the zone with a list of all players in each arena.
The list of players for a given arena is null terminated as indicated by the 00 field below.
The arenaID field is a random 32-bit integer that is associated with each arena at the time of its creation.
An arena maintains its arenaID until the arena gets re-created or manually recycled.
{
<arenaID (4)>
<arenaName (asciiZ)>
{
<playerName (asciiZ)>
}
00
} (repeated until end of packet)

0x02: Chat Message

When a peer receives this packet, it broadcasts it as if it were a zone-wide message (*zone).
<type:0 (1)> - currently ignored by subgame, can be anything
<message (asciiZ)>

0x03: ?alert messages

The format of this packet is unknown. Perhaps the action associated with this packet is disabled in the current release of subgame.
player
arena
msg

0x04: Player Count

This packet is sent if SendPlayerList=0 or there are no players in the zone. The player count is the total number of players in the zone.
<playerCount (2)>
</pre>

===Subgame internal data structs===
<pre>
struct s2c_sendto
{
BYTE type; // 0x3B
DWORD ip_addr; // IP Address (little endian)
WORD port_num; // Port number (little endian)
WORD join_type; // Same as the arena login packet
char arena_name[16]; // Arena Name
DWORD loginid;
};
</pre>

[[Category: Protocol]]

Main Page

2014-04-10T22:33:18Z

Cheese: added fast access links

<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) is an open source server, created by [[User:grelminar|grelminar]], that facilitates games among [[Continuum]] users. It's a replacement, not a clone, of [[Subgame]], which was the old server 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 this wiki, you'll find documents about how to use some of these advanced features, and documentation on how to create your own extensions to the server software. There is also an [[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>Fast Access Links</h3>

*[[:Category:Guides]]
*[[:Category:Module]]
*[[:Category:Settings]]
*[[:Category:Protocol]]
*[[Graphics files]]
*[[Special:MostLinkedCategories]]

<h3>External Links</h3>

*[http://asss.minegoboom.com/ Official ASSS Site]
*[http://www.shanky.com/server/ Server Help]
*[http://forums.minegoboom.com/ Server Help Forums]
*[https://bitbucket.org/grelminar/asss/wiki/Development_Reference/ Bitbucket Wiki]

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

<h3>Current Events</h3>

ASSS version 1.4.4 has been released as of September 7, 2007. This version addresses several bug fixes, and now requires Continuum 0.40.

'''Download'''
*[http://asss.yi.org/files/asss-1.4.4.tar.gz Linux]
*[http://asss.yi.org/files/asss-1.4.4-srconly.tar.gz Source Only]
*[http://asss.yi.org/files/asss-1.4.4.zip Windows]
*[http://bitbucket.org/grelminar/asss/overview/ Change Log]

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

[[Category: Wiki]]

Troubleshooting ASSS

2011-05-31T11:59:47Z

Cheese:

This page deals with the troubleshooting of the ASSS installation.
<br>
If you need help with writing a module, you should read [[Troubleshooting Modules]].
<br>
If you need help with configuring your server, you should read [[Server Setup]].
<br>
If you need help with arena settings, you should read [[Complete Settings]].

==Potential issues==
<pre>
I <cmod> loading C module 'capman' from 'internal'
W <config> Can't find file for arena '(null)', name 'groupdef/mod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/smod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/default.txt'
I <cmod> loading C module 'mapnewsdl' from 'internal'
</pre>
OR
<pre>
W <mapdata> {0} error finding or reading level file
W <mapnewsdl> {0} can't load level file, falling back to tinymap.lvl
</pre>
OR
<pre>
W <mapnewsdl> news file 'news.txt' not found in current directory
</pre>
If you are seeing the above, it is possible that the files do not exist.
However, it is also possible that you have a file permissions error, in which you can check with ls -l.
If it is a permissions error, you can fix it using chmod.
<br>

<pre>
I <cmod> loading C module 'persist' from 'scoring'
db_env_create: Permission denied
E <cmod> error loading module 'persist'
Unrecoverable error (5): Error in loading module 'scoring:persist'
*** ASSS exited: Error loading modules
</pre>
If you are seeing the above, it is possible that you have accidentally copied over your win32 database files into your linux setup, or that the files have become corrupted.
This can be fixed by simply deleting all the files in the /data folder.

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

Troubleshooting ASSS

2011-05-31T11:59:25Z

Cheese:

This page deals with the troubleshooting of the ASSS installation.
<br>
If you need help with writing a module, you should read [[Troubleshooting Modules]].
<br>
If you need help with configuring your server, you should read [[Server Setup]].
<br>
If you need help with arena settings, you should read [[Complete Settings]].

==Potential issues==
<pre>
I <cmod> loading C module 'capman' from 'internal'
W <config> Can't find file for arena '(null)', name 'groupdef/mod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/smod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/default.txt'
I <cmod> loading C module 'mapnewsdl' from 'internal'
</pre>
OR
<pre>
W <mapdata> {0} error finding or reading level file
W <mapnewsdl> {0} can't load level file, falling back to tinymap.lvl
</pre>
OR
<pre>
W <mapnewsdl> news file 'news.txt' not found in current directory
</pre>
If you are seeing the above, it is possible that the files do not exist.
However, it is also possible that you have a file permissions error, in which you can check with ls -l.
If it is a permissions error, you can fix it using chmod.

<pre>
I <cmod> loading C module 'persist' from 'scoring'
db_env_create: Permission denied
E <cmod> error loading module 'persist'
Unrecoverable error (5): Error in loading module 'scoring:persist'
*** ASSS exited: Error loading modules
</pre>
If you are seeing the above, it is possible that you have accidentally copied over your win32 database files into your linux setup, or that the files have become corrupted.
This can be fixed by simply deleting all the files in the /data folder.

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

Installing ASSS on Linux

2011-05-30T13:12:27Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
<br>
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
<br>
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
<br>
If you have MySQL, Python, or BerkleyDB installed, you must point the compiler at them.
*vim system.mk
Find the following lines and change them to their respective locations
*DB_HOME = /usr
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
<br>
If you do NOT have MySQL, Python, or BerkleyDB installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
<br>
Then build the files.
*make
You will then get to watch a nice wall of spam.
<br>
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
<br>
Since the security module does not exist yet, you will have to go into modules.conf
*comment out security:security
*comment out security:enc_cont
*uncomment enc_null
<br>
Since the scoring module apparently does not exist yet, you will have to copy scoring.so from a preexisting server into your bin directory.
*new server owners are screwed
*all scoring:* are already commented out
*hope you don't like points
<br>
Update ASSSHOME with the path to your ASSS root directory.
*cd scripts
*vim run-asss
For ease of access, you may want to move the run-asss script to the root directory.
*mv run-asss ../run [optional, update ASSSHOME]
<br>
After you have completed the installation, you must now configure your server.
<br>
[[Server Setup]]

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

Installing ASSS on Linux

2011-05-30T04:58:51Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
<br>
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
<br>
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
<br>
If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and change them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
<br>
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
<br>
Then build the files.
*make
You will then get to watch a nice wall of spam.
<br>
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
<br>
Since the security module does not exist yet, you will have to go into modules.conf
*comment out security:security
*comment out security:enc_cont
*uncomment enc_null
<br>
Since the scoring module apparently does not exist yet, you will have to copy scoring.so from a preexisting server into your bin directory.
*new server owners are screwed
*all scoring:* are already commented out
*hope you don't like points
<br>
Update ASSSHOME with the path to your ASSS root directory.
*cd scripts
*vim run-asss
For ease of access, you may want to move the run-asss script to the root directory.
*mv run-asss ../run [optional, update ASSSHOME]
<br>
After you have completed the installation, you must now configure your server.
<br>
[[Server Setup]]

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

Installing ASSS on Linux

2011-05-30T04:12:28Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
<br>
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
<br>
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
<br>
If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and change them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
<br>
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
<br>
Then build the files.
*make
You will then get to watch a nice wall of spam.
<br>
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
<br>
Since the security module does not exist yet, you will have to go into modules.conf
*comment out security:security
*comment out security:enc_cont
*uncomment enc_null
<br>
Since the scoring module apparently does not exist yet, you will have to copy scoring.so from a preexisting server into your bin directory.
*new server owners are screwed
*all scoring:* are already commented out
*hope you don't like points
<br>
Update ASSSHOME with the path to your ASSS root directory.
*cd scripts
*vim run-asss
For ease of access, you may want to move the run-asss script to the root directory.
*mv run-asss ../run [optional]
<br>
After you have completed the installation, you must now configure your server.
<br>
[[Server Setup]]

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

Installing ASSS on Linux

2011-05-29T15:26:06Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
<br>
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
<br>
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
<br>
If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and change them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
<br>
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
<br>
Then build the files.
*make
You will then get to watch a nice wall of spam.
<br>
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
<br>
Since the security module does not exist yet, you will have to go into modules.conf
*comment out security:security
*comment out security:enc_cont
*uncomment enc_null
<br>
Since the scoring module apparently does not exist yet, you will have to copy scoring.so from a preexisting server into your bin directory.
*new server owners are screwed
*all scoring:* are already commented out
*hope you don't like points
<br>
For ease of access, you may want to move the run-asss script to the root directory.
*cd scripts
Update ASSSHOME with the path to your ASSS root directory.
*vim run-asss
*mv run-asss ../run [optional]
<br>
After you have completed the installation, you must now configure your server.
<br>
[[Server Setup]]

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

Installing ASSS on Linux

2011-05-29T15:15:17Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
<br>
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
<br>
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
<br>
If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and change them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
<br>
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
<br>
Then build the files.
*make
You will then get to watch a nice wall of spam.
<br>
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
<br>
Since the security module does not exist yet, you will have to go into modules.conf
*comment out security:security
*comment out security:enc_cont
*uncomment enc_null
<br>
Since the scoring module apparently does not exist yet, you will have to copy scoring.so from a preexisting server into your bin directory.
*new server owners are screwed
*uncomment out all scoring:*
*hope you don't like points
<br>
For ease of access, you may want to move the run-asss script to the root directory.
*cd scripts
Update ASSSHOME with the path to your ASSS root directory.
*vim run-asss
*mv run-asss ../run [optional]
<br>
After you have completed the installation, you must now configure your server.
<br>
[[Server Setup]]

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

Troubleshooting ASSS

2011-05-29T15:14:29Z

Cheese:

This page deals with the troubleshooting of the ASSS installation.
<br>
If you need help with writing a module, you should read [[Troubleshooting Modules]].
<br>
If you need help with configuring your server, you should read [[Server Setup]].
<br>
If you need help with arena settings, you should read [[Complete Settings]].

==Potential issues==
<pre>
I <cmod> loading C module 'capman' from 'internal'
W <config> Can't find file for arena '(null)', name 'groupdef/mod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/smod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/default.txt'
I <cmod> loading C module 'mapnewsdl' from 'internal'
</pre>
If you are seeing the above, it is possible that the files do not exist.
However, it is also possible that you have a file permissions error, in which you can check with ls -l.
If it is a permissions error, you can fix it using chmod.

<pre>
I <cmod> loading C module 'persist' from 'scoring'
db_env_create: Permission denied
E <cmod> error loading module 'persist'
Unrecoverable error (5): Error in loading module 'scoring:persist'
*** ASSS exited: Error loading modules
</pre>
If you are seeing the above, it is possible that you have accidentally copied over your win32 database files into your linux setup, or that the files have become corrupted.
This can be fixed by simply deleting all the files in the /data folder.

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

Installing ASSS on Linux

2011-05-29T15:11:10Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
----
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
----
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
----
If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and change them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
----
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
----
Then build the files.
*make
You will then get to watch a nice wall of spam.
----
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
*cd ..
----
Since the security module does not exist yet, you will have to go into modules.conf
*comment out security:security
*comment out security:enc_cont
*uncomment enc_null
----
Since the scoring module apparently does not exist yet, you will have to copy scoring.so from a preexisting server into your bin directory.
*new server owners are screwed
*uncomment out all scoring:*
*hope you don't like points
----
For ease of access, you may want to move the run-asss script to the root directory.
*cd scripts
Update ASSSHOME with the path to your ASSS root directory.
*vim run-asss
*mv run-asss ../run [optional]
----
After you have completed the installation, you must now configure your server.
----
[[Server Setup]]

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

Installing ASSS on Linux

2011-05-29T15:06:30Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
----
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
----
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
----
If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and change them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
----
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
----
Then build the files.
*make
You will then get to watch a nice wall of spam.
----
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
*cd ..
----
Since the security module does not exist yet, you will have to go into modules.conf
*comment out security:security
*comment out security:enc_cont
*uncomment enc_null
----
Since the scoring module apparently does not exist yet, you will have to copy scoring.so from a preexisting server into your bin directory.
*new server owners are screwed
*uncomment out all scoring:*
*hope you dont like points
----
For ease of access, you may want to move the run-asss script to the root directory.
[optional]
*cd scripts
*mv run-asss run
----
After you have completed the installation, you must now configure your server.
----
[[Server Setup]]

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

Troubleshooting ASSS

2011-05-29T08:39:06Z

Cheese:

This page deals with the troubleshooting of the ASSS installation.
If you need help with writing a module, you should read [[Troubleshooting Modules]].
If you need help with configuring your server, you should read [[Server Setup]].
If you need help with arena settings, you should read [[Complete Settings]].

==Potential issues==
<pre>
I <cmod> loading C module 'capman' from 'internal'
W <config> Can't find file for arena '(null)', name 'groupdef/mod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/smod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/default.txt'
I <cmod> loading C module 'mapnewsdl' from 'internal'
</pre>
If you are seeing the above, it is possible that the files do not exist.
However, it is also possible that you have a file permissions error, in which you can check with ls -l.
If it is a permissions error, you can fix it using chmod.

<pre>
I <cmod> loading C module 'persist' from 'scoring'
db_env_create: Permission denied
E <cmod> error loading module 'persist'
Unrecoverable error (5): Error in loading module 'scoring:persist'
*** ASSS exited: Error loading modules
</pre>
If you are seeing the above, it is possible that you have accidentally copied over your win32 database files into your linux setup, or that the files have become corrupted.
This can be fixed by simply deleting all the files in the /data folder.

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

Troubleshooting ASSS

2011-05-29T08:37:28Z

Cheese: Created page with "This page deals with the troubleshooting of the ASSS installation. If you need help with writing a module, you should read Troubleshooting Modules. If you need help with conf..."

This page deals with the troubleshooting of the ASSS installation.
If you need help with writing a module, you should read [[Troubleshooting Modules]].
If you need help with configuring your server, you should read [[Server Setup]].
If you need help with arena settings, you should read [[Complete Settings]].

==Potential issues==
<nowiki>
I <cmod> loading C module 'capman' from 'internal'
W <config> Can't find file for arena '(null)', name 'groupdef/mod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/smod.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/sysop.txt'
W <config> Can't find file for arena '(null)', name 'groupdef/default.txt'
I <cmod> loading C module 'mapnewsdl' from 'internal'
</nowiki>
If you are seeing the above, it is possible that the files do not exist.
However, it is also possible that you have a file permissions error, in which you can check with ls -l.
If it is a permissions error, you can fix it using chmod.

<nowiki>
I <cmod> loading C module 'persist' from 'scoring'
db_env_create: Permission denied
E <cmod> error loading module 'persist'
Unrecoverable error (5): Error in loading module 'scoring:persist'
*** ASSS exited: Error loading modules
</nowiki>
If you are seeing the above, it is possible that you have accidentally copied over your win32 database files into your linux setup, or that the files have become corrupted.
This can be fixed by simply deleting all the files in the /data folder.

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

Server General Faq

2011-05-29T08:26:28Z

Cheese:

== What is ASSS and why is it better than subgame? ==
A Small Subspace Server (ASSS) is a replacement, and not simply a clone of [[subgame]]. It allows a Server Administrator to customize the server by adding and removing [[Modules]], changing the moderator heirarchy, and much, much more. Additionally, ASSS is developed to be open source making it easier for additional developers to fix [[Bugs]], add features, and add custom [[Modules]].

I expect it uses less system resources to run as well (unlike cpu hogging subgame).

== Does it run on Windows? ==

Yes. Grelminar maintains a Windows build in addition to his Linux build.

== Does it run on Linux? ==

Yes. ASSS was designed primarily for Linux and therefore works wonderfully on it.

== How hard is it to install? ==
Dead simple if you know what you are doing. But it can be like moving a mountain if you don't know how to double click.

== Why not just use a bot? ==

ASSS can simply do more than bots can.

*Because modules are a direct part of the server, things like stats and points can be easily manipulated using ASSS.
*New game types can be added so that they mesh seamlessly with everything else.
*Spawning new bots for every new subarena is not only a pain, it is sometime impractical. ASSS modules are there as soon as the new subarena is created.
*You can use server side commands. You won't ever have to cycle through your recent private message list to PM a bot again.

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

Delete this

2011-05-29T08:24:59Z

Cheese: moved Module-settings to Delete this: useless page

delete this

Module-settings

2011-05-29T08:24:59Z

Cheese: moved Module-settings to Delete this: useless page

#REDIRECT [[Delete this]]

Delete this

2011-05-29T08:24:45Z

Cheese:

delete this

Installing ASSS on Linux

2011-05-29T08:19:41Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
----
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
----
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
----
If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and change them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
----
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
----
Then build the files.
*make
You will then get to watch a nice wall of spam.
----
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
*cd ..
----
For ease of access, you may want to move the run-asss script to the root directory.
[optional]
*cd scripts
*mv run-asss run
----
After you have completed the installation, you must now configure your server.
----
[[Server Setup]]

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

Installing ASSS on Linux

2011-05-29T08:18:46Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.
----
First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss
----
Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk
----
If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and cnange them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr
----
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes
----
Then build the files.
*make
You will then get to watch a nice wall of spam.
----
Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
*cd ..
----
For ease of access, you may want to move the run-asss script to the root directory.
[optional]
*cd scripts
*mv run-asss run
----
After you have completed the installation, you must now configure your server.
----
[[Server Setup]]

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

Installing ASSS on Linux

2011-05-29T08:16:59Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.

First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss

Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk

If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and cnange them to their respective locations
*MYSQL_HOME = /opt/mysql
*PYTHON_HOME = /usr

If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes

Then build the files.
*make
You will then get to watch a nice wall of spam.
If you do '''not''' see "Error" or any problems with the build, continue reading this guide.

Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
*cd ..

For ease of access, you may want to move the run-asss script to the root directory.
[optional]
*cd scripts
*mv run-asss run

After you have completed the installation, you must now configure your server.
[[Server Setup]]

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

Installing ASSS on Linux

2011-05-29T08:16:19Z

Cheese:

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.

First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss

Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk

If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and cnange them to their respective locations
*MYSQL_HOME = /opt/mysql
PYTHON_HOME = /usr
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes

Then build the files.
*make
You will then get to watch a nice wall of spam.
If you do '''not''' see "Error" or any problems with the build, continue reading this guide.

Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.
*cd dist
*mv arenas ../arenas
*mv clients ../clients
*mv conf ../conf
*mv maps ../maps
*mv news.txt ../news.txt
*mv scrty ../scrty
*mv scrty1 ../scrty1
*cd ..

For ease of access, you may want to move the run-asss script to the root directory.
[optional]
*cd scripts
*mv run-asss run

After you have completed the installation, you must now configure your server.
[[Server Setup]]

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

Installing ASSS

2011-05-29T07:59:34Z

Cheese:

Installation of an ASSS server will differ on the type of server you are running.

Before beginning, you should probably read the '''userguide''' located in /doc. It's probably most important to read the "File Layout" section, which explains where the important files reside when you extract the ASSS package.

If you are having issues installing ASSS, you may want to read [[Troubleshooting ASSS]].

==Platform==
* [[Installing ASSS on Windows]]
* [[Installing ASSS on Linux]]
* [[Installing ASSS on Apple]]

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

Server Setup

2011-05-29T07:56:56Z

Cheese:

This page will guide you through the process of configuring an [[ASSS]] server. This page is a continuance of [[Installing ASSS|the installation instructions]].

== Configuring ASSS ==

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

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

=== Changing Zone Name and Description ===
The zone name and description are both defined in the /conf/[[global.conf]] file. Edit this file to set your zone's name and description. Set both Billing:ServerName and Directory:Name to your desired zone name, and set Directory:Description to the description you want listed on the [[directory server]]. You'll also want to set the current directory servers in Server1, Server2, etc. At this time the following directory servers work: ''sscentral.sscuservers.net'' and ''sscentral.subspacehq.com''.

To have ASSS send its info to the directory servers, uncomment (remove the semicolon preceding) the ''directory'' module in [[modules.conf]]:
<pre>
directory
;billing
</pre>

When you run ASSS you should see the following output on module load:
<pre>
I <cmod> loading C module 'directory' from 'internal'
I <directory> server on port 5000 using name 'YOUR ZONE NAME HERE'
I <directory> using 'sscentral.sscuservers.net' at 62.65.37.101 as a directory server
I <directory> using 'sscentral.subspacehq.com' at 199.232.158.5 as a directory server
</pre>
and the following during normal ASSS operation:
<pre>
D <directory> sending information to directory servers
</pre>

=== Configuring Staff ===
Your staff is defined in /conf/[[staff.conf]].

In order to give yourself sysop you would change it to:
<pre>
[GroupPasswords]
; this section is just "group-name = password"
; groups that aren't listed can't be logged into by password.

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

[(global)]
; these are "playername = group"
_YOURNAME_ = Sysop
</pre>

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

Notice that you have given yourself access to group Sysop in (global). This means that you will have Sysop privileges in all arenas. To limit a player to have only access in a single arena, put the player in the section pertaining to that arena. For example, to only have sysop powers in arena basketball you would do:

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

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

basketball:_YOURNAME_ = Sysop

[(global)]
; these are "playername = group"
</pre>

Also note that Sysop is an arbitrary group that can have any number or privileges. You can make up your own groups, too, and limit their special abilities and commands. Say we wanted to add a group called SettingChanger, who could change the settings in a single arena (let's say basketball), but not use arena messages or spec other players. First we'll add the players (in this case, Priitk) to the appropriate group in staff.conf:

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

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

basketball:Priitk = SettingChanger

[(global)]
; these are "playername = group"
</pre>

Then, in groupdef.conf we'll add the group and it's privileges.

<pre>
; conf/groupdef.conf
; don't edit this file, edit the ones in groupdef.dir

[SettingChanger]
#include groupdef.dir/default
cmd_quickfix
cmd_getsettings

changesettings

[default]
#include groupdef.dir/default
...
</pre>

And now the Priitk should be able to change the settings by using ?getsettings or ?quickfix, but only in arena basketball. Editing groupdef.conf directly is not recommended, so it's much cleaner to do something like

<pre>
; conf/groupdef.conf
; don't edit this file, edit the ones in groupdef.dir

[SettingChanger]
#include groupdef.dir/default
#include groupdef.dir/setchanger

[default]
#include groupdef.dir/default
...
</pre>

and then create a file in groupdef.dir called setchanger which contains the privileges and commands:

<pre>
cmd_quickfix
cmd_getsettings

changesettings
</pre>

You've probably noticed that lines prefixed with cmd_ enable a player to use that command. Also, a line prefixed with privcmd_ allows a player to use a private command (one that can be messaged to a player). There are other capabilities, such as changesettings above, that a player needs in order to perform some actions, such as change the settings. Here's a complete list of the non-command capabilities (from [[grelminar]]'s [http://asss.yi.org/asss/files/userguide.html User Guide]):

* <tt>seeprivarena</tt> controls whether private arena names are sent to a player for the ?arena command.
* <tt>seeprivfreq</tt> determines if a player sees private freqs in the freq listing.
* <tt>findinprivs</tt> is needed by a player running ?find for the server to report the names of private arenas. (Not implemented yet.)
* <tt>seeepd</tt> allows players to see other ship's energy and specials from spectator mode. (''epd'' stands for extra position data.)
* <tt>seesysoplogall</tt> allows a player to see all important log messages in the zone.
* <tt>seesysoplogarena</tt> only allows a player to see only important log messages having to do with the arena he is currently in.
* <tt>seemodchat</tt> allows players to see the moderator chat.
* <tt>sendmodchat</tt> controls who can send moderator chat messages. Usually, these two capabilities would be given to the same people.
* <tt>uploadfile</tt> allows a player to upload files. Note that the player must also have the cmd_putfile to upload a file using that command.
* <tt>bypasslock</tt> allows players to switch ships even though the arena or themselves have been locked into a ship or into spectator mode by a staff member.
* <tt>bypasssecurity</tt> lets players use unauthorized clients, or prevents kicking off for security checksum failures.
* <tt>invisiblespectator</tt> makes players not show up on the list given when the person they are spectating uses the ?spec command.
* <tt>unlimitedchat</tt> allows a player (e.g., a bot) to bypass chat flooding checks.
* <tt>changesettings</tt> lets clients use the settings change packet (required for ?quickfix/?getsettings).
* <tt>isstaff makes</tt> players show up in ?listmod output.
* <tt>seeallstaff</tt> allows a player to see all non-default-group players, even if they lack isstaff.

Also see: http://sscx.net/asss/userguide.html#%_sec_4

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

=== Editing Arena Settings ===

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

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

[General]
Map = mymap.lvl
</pre>

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

<pre>
MyModules:FreqWatcher
</pre>

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

== Running ASSS ==

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

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

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

Server Setup

2011-05-29T07:55:45Z

Cheese:

This page will guide you through the process of configuring an [[ASSS]] server. This page is a continuance of [[Installing ASSS|The installation instructions]].

== Configuring ASSS ==

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

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

=== Changing Zone Name and Description ===
The zone name and description are both defined in the /conf/[[global.conf]] file. Edit this file to set your zone's name and description. Set both Billing:ServerName and Directory:Name to your desired zone name, and set Directory:Description to the description you want listed on the [[directory server]]. You'll also want to set the current directory servers in Server1, Server2, etc. At this time the following directory servers work: ''sscentral.sscuservers.net'' and ''sscentral.subspacehq.com''.

To have ASSS send its info to the directory servers, uncomment (remove the semicolon preceding) the ''directory'' module in [[modules.conf]]:
<pre>
directory
;billing
</pre>

When you run ASSS you should see the following output on module load:
<pre>
I <cmod> loading C module 'directory' from 'internal'
I <directory> server on port 5000 using name 'YOUR ZONE NAME HERE'
I <directory> using 'sscentral.sscuservers.net' at 62.65.37.101 as a directory server
I <directory> using 'sscentral.subspacehq.com' at 199.232.158.5 as a directory server
</pre>
and the following during normal ASSS operation:
<pre>
D <directory> sending information to directory servers
</pre>

=== Configuring Staff ===
Your staff is defined in /conf/[[staff.conf]].

In order to give yourself sysop you would change it to:
<pre>
[GroupPasswords]
; this section is just "group-name = password"
; groups that aren't listed can't be logged into by password.

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

[(global)]
; these are "playername = group"
_YOURNAME_ = Sysop
</pre>

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

Notice that you have given yourself access to group Sysop in (global). This means that you will have Sysop privileges in all arenas. To limit a player to have only access in a single arena, put the player in the section pertaining to that arena. For example, to only have sysop powers in arena basketball you would do:

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

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

basketball:_YOURNAME_ = Sysop

[(global)]
; these are "playername = group"
</pre>

Also note that Sysop is an arbitrary group that can have any number or privileges. You can make up your own groups, too, and limit their special abilities and commands. Say we wanted to add a group called SettingChanger, who could change the settings in a single arena (let's say basketball), but not use arena messages or spec other players. First we'll add the players (in this case, Priitk) to the appropriate group in staff.conf:

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

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

basketball:Priitk = SettingChanger

[(global)]
; these are "playername = group"
</pre>

Then, in groupdef.conf we'll add the group and it's privileges.

<pre>
; conf/groupdef.conf
; don't edit this file, edit the ones in groupdef.dir

[SettingChanger]
#include groupdef.dir/default
cmd_quickfix
cmd_getsettings

changesettings

[default]
#include groupdef.dir/default
...
</pre>

And now the Priitk should be able to change the settings by using ?getsettings or ?quickfix, but only in arena basketball. Editing groupdef.conf directly is not recommended, so it's much cleaner to do something like

<pre>
; conf/groupdef.conf
; don't edit this file, edit the ones in groupdef.dir

[SettingChanger]
#include groupdef.dir/default
#include groupdef.dir/setchanger

[default]
#include groupdef.dir/default
...
</pre>

and then create a file in groupdef.dir called setchanger which contains the privileges and commands:

<pre>
cmd_quickfix
cmd_getsettings

changesettings
</pre>

You've probably noticed that lines prefixed with cmd_ enable a player to use that command. Also, a line prefixed with privcmd_ allows a player to use a private command (one that can be messaged to a player). There are other capabilities, such as changesettings above, that a player needs in order to perform some actions, such as change the settings. Here's a complete list of the non-command capabilities (from [[grelminar]]'s [http://asss.yi.org/asss/files/userguide.html User Guide]):

* <tt>seeprivarena</tt> controls whether private arena names are sent to a player for the ?arena command.
* <tt>seeprivfreq</tt> determines if a player sees private freqs in the freq listing.
* <tt>findinprivs</tt> is needed by a player running ?find for the server to report the names of private arenas. (Not implemented yet.)
* <tt>seeepd</tt> allows players to see other ship's energy and specials from spectator mode. (''epd'' stands for extra position data.)
* <tt>seesysoplogall</tt> allows a player to see all important log messages in the zone.
* <tt>seesysoplogarena</tt> only allows a player to see only important log messages having to do with the arena he is currently in.
* <tt>seemodchat</tt> allows players to see the moderator chat.
* <tt>sendmodchat</tt> controls who can send moderator chat messages. Usually, these two capabilities would be given to the same people.
* <tt>uploadfile</tt> allows a player to upload files. Note that the player must also have the cmd_putfile to upload a file using that command.
* <tt>bypasslock</tt> allows players to switch ships even though the arena or themselves have been locked into a ship or into spectator mode by a staff member.
* <tt>bypasssecurity</tt> lets players use unauthorized clients, or prevents kicking off for security checksum failures.
* <tt>invisiblespectator</tt> makes players not show up on the list given when the person they are spectating uses the ?spec command.
* <tt>unlimitedchat</tt> allows a player (e.g., a bot) to bypass chat flooding checks.
* <tt>changesettings</tt> lets clients use the settings change packet (required for ?quickfix/?getsettings).
* <tt>isstaff makes</tt> players show up in ?listmod output.
* <tt>seeallstaff</tt> allows a player to see all non-default-group players, even if they lack isstaff.

Also see: http://sscx.net/asss/userguide.html#%_sec_4

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

=== Editing Arena Settings ===

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

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

[General]
Map = mymap.lvl
</pre>

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

<pre>
MyModules:FreqWatcher
</pre>

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

== Running ASSS ==

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

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

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

Server Setup

2011-05-29T07:54:36Z

Cheese:

This page will guide you through the process of configuring an [[ASSS]] server. This page is a continuance of [[Installing ASSS|The installation instructions]].

Before beginning, you should probably read the '''userguide''' located in /docs ]. It's probably most important to read the "File Layout" section, which explains where the important files reside when you extract the ASSS package.

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

== Configuring ASSS ==

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

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

=== Changing Zone Name and Description ===
The zone name and description are both defined in the /conf/[[global.conf]] file. Edit this file to set your zone's name and description. Set both Billing:ServerName and Directory:Name to your desired zone name, and set Directory:Description to the description you want listed on the [[directory server]]. You'll also want to set the current directory servers in Server1, Server2, etc. At this time the following directory servers work: ''sscentral.sscuservers.net'' and ''sscentral.subspacehq.com''.

To have ASSS send its info to the directory servers, uncomment (remove the semicolon preceding) the ''directory'' module in [[modules.conf]]:
<pre>
directory
;billing
</pre>

When you run ASSS you should see the following output on module load:
<pre>
I <cmod> loading C module 'directory' from 'internal'
I <directory> server on port 5000 using name 'YOUR ZONE NAME HERE'
I <directory> using 'sscentral.sscuservers.net' at 62.65.37.101 as a directory server
I <directory> using 'sscentral.subspacehq.com' at 199.232.158.5 as a directory server
</pre>
and the following during normal ASSS operation:
<pre>
D <directory> sending information to directory servers
</pre>

=== Configuring Staff ===
Your staff is defined in /conf/[[staff.conf]].

In order to give yourself sysop you would change it to:
<pre>
[GroupPasswords]
; this section is just "group-name = password"
; groups that aren't listed can't be logged into by password.

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

[(global)]
; these are "playername = group"
_YOURNAME_ = Sysop
</pre>

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

Notice that you have given yourself access to group Sysop in (global). This means that you will have Sysop privileges in all arenas. To limit a player to have only access in a single arena, put the player in the section pertaining to that arena. For example, to only have sysop powers in arena basketball you would do:

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

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

basketball:_YOURNAME_ = Sysop

[(global)]
; these are "playername = group"
</pre>

Also note that Sysop is an arbitrary group that can have any number or privileges. You can make up your own groups, too, and limit their special abilities and commands. Say we wanted to add a group called SettingChanger, who could change the settings in a single arena (let's say basketball), but not use arena messages or spec other players. First we'll add the players (in this case, Priitk) to the appropriate group in staff.conf:

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

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

basketball:Priitk = SettingChanger

[(global)]
; these are "playername = group"
</pre>

Then, in groupdef.conf we'll add the group and it's privileges.

<pre>
; conf/groupdef.conf
; don't edit this file, edit the ones in groupdef.dir

[SettingChanger]
#include groupdef.dir/default
cmd_quickfix
cmd_getsettings

changesettings

[default]
#include groupdef.dir/default
...
</pre>

And now the Priitk should be able to change the settings by using ?getsettings or ?quickfix, but only in arena basketball. Editing groupdef.conf directly is not recommended, so it's much cleaner to do something like

<pre>
; conf/groupdef.conf
; don't edit this file, edit the ones in groupdef.dir

[SettingChanger]
#include groupdef.dir/default
#include groupdef.dir/setchanger

[default]
#include groupdef.dir/default
...
</pre>

and then create a file in groupdef.dir called setchanger which contains the privileges and commands:

<pre>
cmd_quickfix
cmd_getsettings

changesettings
</pre>

You've probably noticed that lines prefixed with cmd_ enable a player to use that command. Also, a line prefixed with privcmd_ allows a player to use a private command (one that can be messaged to a player). There are other capabilities, such as changesettings above, that a player needs in order to perform some actions, such as change the settings. Here's a complete list of the non-command capabilities (from [[grelminar]]'s [http://asss.yi.org/asss/files/userguide.html User Guide]):

* <tt>seeprivarena</tt> controls whether private arena names are sent to a player for the ?arena command.
* <tt>seeprivfreq</tt> determines if a player sees private freqs in the freq listing.
* <tt>findinprivs</tt> is needed by a player running ?find for the server to report the names of private arenas. (Not implemented yet.)
* <tt>seeepd</tt> allows players to see other ship's energy and specials from spectator mode. (''epd'' stands for extra position data.)
* <tt>seesysoplogall</tt> allows a player to see all important log messages in the zone.
* <tt>seesysoplogarena</tt> only allows a player to see only important log messages having to do with the arena he is currently in.
* <tt>seemodchat</tt> allows players to see the moderator chat.
* <tt>sendmodchat</tt> controls who can send moderator chat messages. Usually, these two capabilities would be given to the same people.
* <tt>uploadfile</tt> allows a player to upload files. Note that the player must also have the cmd_putfile to upload a file using that command.
* <tt>bypasslock</tt> allows players to switch ships even though the arena or themselves have been locked into a ship or into spectator mode by a staff member.
* <tt>bypasssecurity</tt> lets players use unauthorized clients, or prevents kicking off for security checksum failures.
* <tt>invisiblespectator</tt> makes players not show up on the list given when the person they are spectating uses the ?spec command.
* <tt>unlimitedchat</tt> allows a player (e.g., a bot) to bypass chat flooding checks.
* <tt>changesettings</tt> lets clients use the settings change packet (required for ?quickfix/?getsettings).
* <tt>isstaff makes</tt> players show up in ?listmod output.
* <tt>seeallstaff</tt> allows a player to see all non-default-group players, even if they lack isstaff.

Also see: http://sscx.net/asss/userguide.html#%_sec_4

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

=== Editing Arena Settings ===

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

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

[General]
Map = mymap.lvl
</pre>

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

<pre>
MyModules:FreqWatcher
</pre>

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

== Running ASSS ==

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

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

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

Installing ASSS on Linux

2011-05-29T07:53:52Z

Cheese: Created page with "If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin. First, you need to clone the files from the ASSS repository. *hg clon..."

If installed, you should find the locations of your Python, MySQL, and other dependencies before you begin.

First, you need to clone the files from the ASSS repository.
*hg clone https://bitbucket.org/grelminar/asss ../asss

Then, after the files have transferred, you will need to build the program files from source code.
*cd src
*mv system.mk.dist system.mk

If you have Python or MySQL installed, you must point the compiler at them.
*vim system.mk
Find the following lines and cnange them to their respective locations
*MYSQL_HOME = /opt/mysql
PYTHON_HOME = /usr
If you do NOT have Python or MySQL installed, you must comment out the following lines, by adding a # in front of them:
*have_bdb := yes
*have_mysql := yes
*have_python := yes

Then build the files.
*make
You will then get to watch a nice wall of spam.
If you do '''not''' see "Error" or any problems with the build, continue reading this guide.

Because the developers wanted to be able to update everything on a server already running ASSS, you must now copy all the files into their proper locations.

For ease of access, you may want to move the run-asss script to the root directory.
[optional]
*cd scripts
*mv run-asss run

After you have completed the installation, you must now configure your server.
[[Server Setup]]

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

Installing ASSS

2011-05-29T07:28:11Z

Cheese: Created page with "Installation of an ASSS server will differ on the type of server you are running. ==Platform== * Installing ASSS on Windows * Installing ASSS on Linux * [[Installing ASS..."

Installation of an ASSS server will differ on the type of server you are running.

==Platform==
* [[Installing ASSS on Windows]]
* [[Installing ASSS on Linux]]
* [[Installing ASSS on Apple]]

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

Category:Guides

2011-05-29T07:27:32Z

Cheese:

These tutorials should guide you in whatever Subspace/Continuum related task you are having problems with.

You can request tutorials either using the [[Category_talk:Tutorial|discussions]] page or at [http://forums.minegoboom.com/ Server Help forums].

The online version of the ASSS user guide can be found [http://www.sscx.net/asss/userguide.html here]:

[[Category: ASSS]]

ASSS

2011-05-29T07:20:13Z

Cheese:

A Small Subspace Server (ASSS) is a replacement, and not simply a clone of [[subgame]] written by [[grelminar]]. It allows a Server Administrator to customize the server by adding and removing [[module]]s, changing the moderator heirarchy, and much, much more. Additionally, ASSS is developed to be open source making it easier for additional developers to fix bugs, add features, and add custom [[module]]s. It runs on both Linux and Windows, but runs better on Linux as grelminar originally designed it solely for Linux.

It uses less system resources to run as well (unlike cpu-hogging [[Subgame]]).

For instructions on how to install the ASSS server, go to [[Installing ASSS]].

==External links==
*[http://pineapple.vg/download/Pages/ASSS_Userguide.pdf ASSS Userguide / Command Reference]

[[Category: ASSS]]
[[Category: Servers]]

Graphics files

2011-02-02T03:27:10Z

Cheese: added pic

The following are all files in Continuum's \Graphics directory which control most of the graphics used by Continuum in-game.

[[Image:Colors.png]] [[:Image:Colors.png|colors.bm2]] - Controls the colors of the interface, including background color and borders, as well as all color details of the radar.

[[Image:gradient.jpg]] [[:Image:gradient.jpg|gradient.bm2]] - Controls color gradients for the energy bar and bullet trails.

[[Image:Bombs.png]] [[:Image:Bombs.png|bombs.bm2]] - Controls animation for bombs and thor's hammers.

[[Image:Bullets.png]] [[:Image:Bullets.png|bullets.bm2]] - Controls animation for guns and bursts.

== Graphic file names and short description ==

*bg01.bm2 - this is a random planet in the background
*bg02.bm2 - this is a random planet in the background
*bg03.bm2 - this is a random planet in the background
*bg04.bm2 - this is a random planet in the background
*bg05.bm2 - this is a random planet in the background
*bg06.bm2 - this is a random planet in the background
*bg07.bm2 - this is a random planet in the background
*bg08.bm2 - this is a random planet in the background
*bg09.bm2 - this is a random planet in the background
*bg10.bm2 - this is a random planet in the background
*bg11.bm2 - this is a random planet in the background
*bg12.bm2 - this is a random planet in the background
*bg13.bm2 - this is a random planet in the background
*bg14.bm2 - this is a random planet in the background
*bombflsh.bm2 - This is the flash that comes out of the front of your ship when you fire a bomb
*[[:Image:Bombs.png|bombs.bm2]] - These are the bombs themselves, they animate from the left to the right
*bullets.bm2 - These are the bullets themselves, they go through the frames left to right
*[[:Image:Colors.png|colors.bm2]] - These are an assortment of lines and each color means a different color of a certain object in '''continuum'''.
*damage.bm2 - This is the graphic for when a ship has been hit and shows damage
*disp.bm2 - This is the background to the display in the upper right
*dropflag.bm2 - This is the animation that will show in the upper right when you have a flag and how much time is left until it drops
*empburst.bm2 - This is the explosion that a EMP bomb will make
*engyfont.bm2 - This is the amount of energy your ship has, it will show on the upper right display
*exhaust.bm2 - This is what your ship propels itself with, this graphic will appear behind your ship depending on which way you are flying
*explode0.bm2 - This is the image that will appear after your bullets hit something
*explode1.bm2 - This is the image that will appear when a ship has been destroyed
*explode2.bm2 - This is the image that will appear when a bomb or thor hits something
*[[:Image:Flag.png|flag.bm2]] - This is the animated graphic of both owned and unowned flags
*[[:Image:Goal.png|goal.bm2]] - This is the graphic that appears as a goal
*[[:Image:gradient.jpg|gradient.bm2]] - This image controls the colors of bullet trails and the energy bar
*hlthbar.bm2 - This is the image that will appear over your health bar on the top of the screen
*hugefont.bm2 - This is the font displayed when Extra Large is selected on the Font Size menu ('''continuum 0.??+''')
*hugefontf.bm2 - This is the foreign font displayed when Extra Large is selected on the Font Size menu ('''continuum 0.??+''')
*icondoor.bm2 - This is the image that will appear to show how many of a certain item you have (bursts, etc)
*icons.bm2 - These are what will show up for your items (lvl 1 bullets, etc)
*junkjv.bm2 - This is the image that will fly off of the Javelin after it has been killed
*junklv.bm2 - This is the image that will fly off of the Leviathan after it has been killed
*junknw.bm2 - This is the image that will fly off of the Lancaster after it has been killed
*junksh.bm2 - This is the image that will fly off of the Shark after it has been killed
*junksp.bm2 - This is the image that will fly off of the Spider after it has been killed
*junkte.bm2 - This is the image that will fly off of the Terrier after it has been killed
*junkwb.bm2 - This is the image that will fly off of the Warbird after it has been killed
*junkwe.bm2 - This is the image that will fly off of the Weasel after it has been killed
*king.bm2 - This is the image that will appear when you are still a player in the king of the hill game
*kingex.bm2 - This is the image that appears with the time left in the king of the hill
*largefont.bm2 - This is the font displayed when Large is selected on the Font Size menu ('''continuum 0.??+''')
*largefontf.bm2 - This is the foreign font displayed when Large is selected on the Font Size menu ('''continuum 0.??+''')
*led.bm2 - This is the font for the digits that appear in the top right display
*menutext.bm2 - This is the font that is used on the main menu only (never in-game)
*mines.bm2 - These are the mines that appear after a ship lays them
*over1.bm2 - This is the image that will show up for one of the two kinds of small rocks that spin
*over2.bm2 - This is the image that will show up for the big rocks that spin
*over3.bm2 - This is the image that will show up for the second small rock
*over4.bm2 - This will show for the 'space station' image that spins
*over5.bm2 - This image is the graphic for the wormhole spinning
*[[:Image:Powerb.png|powerb.bm2]] - This is the animation that will appear as the powerball which you can shoot into goals to score points
*prizes.bm2 - These are the green things that are dropped from a ship after it is killed
*radarh.bm2 - This is the horizontal line under the radar (not used in continuum '''0.??'''+)
*radarv.bm2 - This is the vertical line to the right of the radar (not used in continuum '''0.??'''+)
*[[:Image:Repel.png|repel.bm2]] - This is the image that will be shown when a player releases a repel
*rocket.bm2 - This is the image that will be shown when a player uses a rocket
*shield.bm2 - This is the image that will appear when you have a shield, and what percent your shields strength is at
*shrapnel.bm2 - This is the little piece of bombs that fly off your bomb explosion
*shrtfont.bm2 - This is the font displayed when Small is selected on the Font Size menu
*shrtfontf.bm2 - This is the foreign font displayed when Small is selected on the Font Size menu
*spark.bm2 - This image will appear when you are EMP'd (your energy is not refilling)
*ssshield.bm2 - This is the spinning subspace logo that appears next to a name of the player with the most points in the arena
*star01.bm2 - This is one of the random stars in the background
*star02.bm2 - This is one of the random stars in the background
*star03.bm2 - This is one of the random stars in the background
*star04.bm2 - This is one of the random stars in the background
*star05.bm2 - This is one of the random stars in the background
*star06.bm2 - This is one of the random stars in the background
*star07.bm2 - This is one of the random stars in the background
*super.bm2 - This stores frames for the animation that appears on the right when you have super
*tallfont.bm2 - This is the font displayed when Medium is selected on the Font Size menu
*tallfontf.bm2 - This is the foreign font displayed when Medium is selected on the Font Size menu
*trail.bm2 - These are the trails for the bombs fired by a ship
*turret.bm2 - This is what you look like when you are a turret
*turret2.bm2 - This is what everyone else looks like when they are a turret
*wall.bm2 - This is the image that will appear when a player lays a brick
*warp.bm2 - This is the animation that will appear when a player warps
*warppnt.bm2 - This is the image that will appear where your portal is after you lay one
*ships.bm2 - These are the ships, you can also have them in seperate files as ship1.bm2, ship2.bm2, etc

[[Category:Game Intricacies]]

Cfg file

2011-02-02T03:22:15Z

Cheese: knocked it up a notch

[[Subgame]] stores all the settings for an arena in a .cfg file, with the filename matching the arena name.
It stores the following settings:
*[[Bomb Settings]]
*[[Brick Settings]]
*[[Bullet Settings]]
*[[Burst Settings]]
*[[Cost Settings]]
*[[Custom Settings]]
*[[Door Settings]]
*[[Flag Settings]]
*[[Kill Settings]]
*[[King Settings]]
*[[Latency Settings]]
*[[Message Settings]]
*[[Mine Settings]]
*[[Misc Settings]]
*[[Owner Settings]]
*[[Packetloss Settings]]
*[[Periodic Settings]]
*[[Prize Settings]]
*[[Prizeweight Settings]]
*[[Radar Settings]]
*[[Repel Settings]]
*[[Rocket Settings]]
*[[Routing Settings]]
*[[Security Settings]]
*[[Shrapnel Settings]]
*[[Spawn Settings]]
*[[Soccer Settings]]
*[[Team Settings]]
*[[Territory Settings]]
*[[Toggle Settings]]
*[[Wormhole Settings]]
*[[Ship Settings]]

These settings can be modified by editing the .cfg file itself (directly, using FTP, putfile, etc.), using the ?set [[commands|command]], or using the ?setsettings command. [[Subgame]] uses the template.sss file to format settings for in-game modification using ?setsettings. It also stores the settings for public (default) arenas in server.cfg.

[[Category:Subgame Settings]]

Troubleshooting Modules

2011-01-23T08:09:34Z

Cheese: /* My module crashes whenever I try to use an interface! */ fix'd

Here are some general solutions to help you solve a problem with a module that you just wrote.
Keep in mind that these are suggestions, and may not always be correct.

== My module works when I put it in modules.conf, but the zone crashes when I use ?insmod, why? ==

Chances are, you are doing something in the CB_ARENAACTION callback, and are doing something in the AA_PRECREATE or AA_CREATE states.
Simply do this when the module loads:

<pre>
Arena *a;
Link *link;
aman->Lock();
FOR_EACH_ARENA(a)
{
ArenaAction(a,AA_PRECREATE);
ArenaAction(a,AA_CREATE);
}
aman->Unlock();
</pre>

== When my module is in modules.conf, players can not enter the zone, or when I use ?insmod, players can not switch arenas and I get errors about player states! ==

You may be using arena data improperly.
Be sure you have gotten the I_ARENAMAN interface and have used AllocateArenaData() properly.

== My module keeps failing to load! ==

Be sure you have all the necessary modules needed for your module to run.
Make sure your module loads after the modules it is dependant on are already loaded.

== My module crashes whenever I try to use an interface! ==

Make sure you have gotten the interface by using <tt>GetInterface()</tt> properly, that the assigned interface variable is unique, and that you verify whether or not the interface is valid by checking to see if it is not defined. The latter is typically done in the entry point, as shown [[Writing Modules In C#Using Interfaces|here]], by adding an if-statement and returning <tt>MM_FAIL</tt> on failure. If the interface is being called at some other point in the code, make sure to verify if it is defined and to handle cases throughout your code where it may not be valid.

Also note that if a parent interface does not check to see if it is still being used by other modules before unloading, it may cause instability in your zone and eventually result in a crash when a module calls that interface again.

== My module will not compile! Why can't my compiler find certain things? ==

Sometimes, #include asss.h is not enough.
Only the core header files are in asss.h, and you will need to manually include any others.
This may also be true if you are using a custom interface.

== Why does my module keep crashing when a player leaves the zone? ==

You may be saving the player pointer somewhere, and then are trying to access it after the player leaves.
This does not work because the pointer becomes invalid when the player leaves.
Your module is informed when this happens by the CB_NEWPLAYER callback.

[[Category:Module]]
[[Category:Guides]]

Troubleshooting Modules

2011-01-22T23:23:04Z

Cheese: Undo revision 6185 by Hakaku (Talk) yet in english

Here are some general solutions to help you solve a problem with a module that you just wrote.
Keep in mind that these are suggestions, and may not always be correct.

== My module works when I put it in modules.conf, but the zone crashes when I use ?insmod, why? ==

Chances are, you are doing something in the CB_ARENAACTION callback, and are doing something in the AA_PRECREATE or AA_CREATE states.
Simply do this when the module loads:

<pre>
Arena *a;
Link *link;
aman->Lock();
FOR_EACH_ARENA(a)
{
ArenaAction(a,AA_PRECREATE);
ArenaAction(a,AA_CREATE);
}
aman->Unlock();
</pre>

== When my module is in modules.conf, players can not enter the zone, or when I use ?insmod, players can not switch arenas and I get errors about player states! ==

You may be using arena data improperly.
Be sure you have gotten the I_ARENAMAN interface and have used AllocateArenaData() properly.

== My module keeps failing to load! ==

Be sure you have all the necessary modules needed for your module to run.
Make sure your module loads after the modules it is dependant on are already loaded.

== My module crashes whenever I try to use an interface! ==

Make sure you have gotten the interface by using <tt>GetInterface()</tt> properly, that the assigned interface variable is unique, and that you verify whether or not the interface is valid by checking to see if it is not defined. The latter is typically done in the entry point, as shown [[Writing Modules In C#Using Interfaces|here]], by adding an if-statement and returning <tt>MM_FAIL</tt> on failure. If the interface is being called at some other point in the code, make sure to verify if it is defined and to handle cases throughout your code where it may not be valid.

Note that also that if a parent interface does not check to see if it is still being used by other modules before unloading, it may cause instability in your zone and eventually result in a crash when a module calls that interface again.

== My module will not compile! Why can't my compiler find certain things? ==

Sometimes, #include asss.h is not enough.
Only the core header files are in asss.h, and you will need to manually include any others.
This may also be true if you are using a custom interface.

== Why does my module keep crashing when a player leaves the zone? ==

You may be saving the player pointer somewhere, and then are trying to access it after the player leaves.
This does not work because the pointer becomes invalid when the player leaves.
Your module is informed when this happens by the CB_NEWPLAYER callback.

[[Category:Module]]
[[Category:Guides]]

List of Custom Modules

2011-01-21T00:20:09Z

Cheese: spiced things up a bit

Provided below is a list of custom modules and projects for ASSS which have been released for public use. Although several of them were designed for previous versions of ASSS, most of them still work when recompiled against the most recent release of ASSS, often with with little to no modifications necessary.

For help on how to compile C modules, see [[Installing New Modules]] for more details.

= Open Source =
== ASSS 1.5.0 ==
* '''C'''
** [http://forums.minegoboom.com/viewtopic.php?t=8425 ASSS Command List Module] - Cheese
** [http://forums.minegoboom.com/viewtopic.php?t=8673 ASSS Files/Quickfix Module Combo Pack] - Cheese
** [http://forums.minegoboom.com/viewtopic.php?t=8429 ASSS Multipub Module] - Cheese
** [http://forums.minegoboom.com/viewtopic.php?t=8773 LVZHUD] - Samapico
** [http://forums.minegoboom.com/viewtopic.php?t=8690 Small module to help testing other modules] - D1st0rt

* '''Projects'''
** [http://forums.minegoboom.com/viewtopic.php?t=8629 ACE -- ASSS C Enricher (beta)] - Arnk Kilo Dylie

== ASSS 1.4.4 ==
* '''C'''
** [http://forums.minegoboom.com/viewtopic.php?t=8676 ASSS Flags Module] - Cheese
** [http://forums.minegoboom.com/viewtopic.php?t=8470 ball_motion] - Goldeye
** [http://forums.minegoboom.com/viewtopic.php?t=8384 Colors] - Cheese
** [http://forums.minegoboom.com/viewtopic.php?t=8425 Command List] - Cheese
** [http://forums.minegoboom.com/viewtopic.php?t=8714 Deanti] - Hakaku
** [http://forums.minegoboom.com/viewtopic.php?t=8716 ?doors] - Hakaku
** [http://forums.minegoboom.com/viewtopic.php?t=8715 Flag Statistics] - Hakaku
** [http://forums.minegoboom.com/viewtopic.php?t=7469 fm_shiplimits] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=8095 Fuschia] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?p=78585#78585 Goal Callback example]
** [http://forums.minegoboom.com/viewtopic.php?t=8092 hs_util] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?p=79093#79093 Jackpot Music Lock] - Hakaku
** [http://forums.minegoboom.com/viewtopic.php?t=7560 King of the Hill] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=8530 Multinews] - JoWie
** [http://forums.minegoboom.com/viewtopic.php?t=8640 Setting banners (example)] - Hakaku
** [http://forums.minegoboom.com/viewtopic.php?t=8431 Sql Query] - Cheese
** [http://forums.minegoboom.com/viewtopic.php?t=7757 Staff Message of the Day] - JoWie

* '''Python'''
** [http://forums.minegoboom.com/viewtopic.php?t=8171 Automated Team Picking] - D1st0rt
** [http://forums.minegoboom.com/viewtopic.php?t=3975 Bounty Rabbit] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=8402 Optparser] - D1st0rt
** [http://forums.minegoboom.com/viewtopic.php?p=82108#82108 Region-activated LVZ popup (example)] - JoWie

* '''Projects'''
** [http://forums.minegoboom.com/viewtopic.php?t=8382 Hosted Game Core] - D1st0rt
** [http://forums.minegoboom.com/viewtopic.php?p=80108#80108 Paintball Modules] - Bak

== ASSS 1.4.2 - 1.4.3 ==
* '''C'''
** [http://toktok.sscentral.com/ss-asss.html Autobrick] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=6567 Chatmenu] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=4882 Controllable doors] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=3758 CTF flag game] - Smong
** [http://toktok.sscentral.com/ss-asss.html Digithud] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=6187 hs_ufo] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?t=7059 Initial] - Bak
** [http://forums.minegoboom.com/viewtopic.php?t=7614 Jpcounter2] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7609 Per ship lvz] - JoWie
** [http://forums.minegoboom.com/viewtopic.php?t=6984 radarzoom - per ship MapZoomFactor] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7399 Region Triggers] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7563 Spree] - Smong, JoWie
** [http://forums.minegoboom.com/viewtopic.php?t=7507 Swappable game interface] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7608 Thor Level] - JoWie
** [http://forums.minegoboom.com/viewtopic.php?t=7055 Vehicles] - Bak
** [http://forums.minegoboom.com/viewtopic.php?t=7462 Zombie] - Animate Dreams

* '''Python'''
** [http://forums.minegoboom.com/viewtopic.php?t=3564 Autoprize] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7506 Craters] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=6117 Dodgeball] - xsp0rtsfanx, Chambahs
** [http://forums.minegoboom.com/viewtopic.php?t=7614 fg_wz_spawns] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7454 Goal Spree] - BDwinsAlt
** [http://forums.minegoboom.com/viewtopic.php?t=7361 Kill lvz] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7391 Noise upon entering] - BDwinsAlt
** [http://forums.minegoboom.com/viewtopic.php?t=7724 ShipFX] - Jonus
** [http://toktok.sscentral.com/ss-asss.html Soundenter2] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7718 Staff Application] - Jonus
** [http://forums.minegoboom.com/viewtopic.php?t=7732 SubSpace Casino] - Jonus
** [http://toktok.sscentral.com/ss-asss.html Suggest] - Smong

* '''Projects'''
** [http://forums.minegoboom.com/viewtopic.php?t=5629 CNC Generals] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=6035 Direct ASSS Web Stats] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=7409 Hyperspace Core Modules] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?t=5629 Unreal Tournament] - Chambahs, Smong, others

== ASSS 1.3.6 - 1.4.0 ==
* '''C'''
** [http://forums.minegoboom.com/viewtopic.php?t=4776 Cmdalias] - Bak
** [http://forums.minegoboom.com/viewtopic.php?t=4817 Drone] - Bak
** [http://toktok.sscentral.com/ss-asss.html Nomysql] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=4159 Poll] - Bak
** [http://forums.minegoboom.com/viewtopic.php?t=4279 Prize Management System] - 50% Packetloss
** [http://forums.minegoboom.com/viewtopic.php?t=4777 Togglespec] - Bak

* '''Python'''
** [http://toktok.sscentral.com/ss-asss.html Autowarp3] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=4865 Elim] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=4262 Guessing game] - Chambahs, Smong
** [http://toktok.sscentral.com/ss-asss.html Note] - Smong
** [http://toktok.sscentral.com/ss-asss.html To do] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=5426 Turretwar] - D1st0rt
** [http://toktok.sscentral.com/ss-asss.html Wipeout] - Smong

== ASSS 1.2.x - 1.3.5 ==
* '''C'''
** [http://forums.minegoboom.com/viewtopic.php?t=3690 Afk] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=3306 hs_antiwarp] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?t=3305 hs_listnewb] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?t=3229 %macro expander] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=3004 Moveto] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=3228 Race] - Smong, i88gerbils

* '''Python'''
** [http://forums.minegoboom.com/viewtopic.php?t=3974 Blackjack] - Chambahs

== ASSS 0.9.x - 1.1.x ==
* '''C'''
** [http://toktok.sscentral.com/ss-asss.html autowarp2] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=3162 Flag neuter] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?t=1888 No anti in center] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=2467 Putmap] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?t=3163 Simple region tools] - Dr Brain
** [http://forums.minegoboom.com/viewtopic.php?t=801 Teamkill] - Smong
** [http://forums.minegoboom.com/viewtopic.php?t=801 Triggers] - Smong
** [http://toktok.sscentral.com/ss-asss.html Warper] - Smong

= Closed Source =
* '''Projects'''
** [http://forums.minegoboom.com/viewtopic.php?t=6757 Bot with Damage] - Smong
** [http://toktok.sscentral.com/ss-asss.html Cheat Detection] - Smong

[[Category:Custom Modules]]

Troubleshooting Modules

2011-01-21T00:08:40Z

Cheese: /* My module crashes whenever I try to use an interface! */

Here are some general solutions to help you solve a problem with a module that you just wrote.
Keep in mind that these are suggestions, and may not always be correct.

== My module works when I put it in modules.conf, but the zone crashes when I use ?insmod, why? ==

Chances are, you are doing something in the CB_ARENAACTION callback, and are doing something in the AA_PRECREATE or AA_CREATE states.
Simply do this when the module loads:

<pre>
Arena *a;
Link *link;
aman->Lock();
FOR_EACH_ARENA(a)
{
ArenaAction(a,AA_PRECREATE);
ArenaAction(a,AA_CREATE);
}
aman->Unlock();
</pre>

== When my module is in modules.conf, players can not enter the zone, or when I use ?insmod, players can not switch arenas and I get errors about player states! ==

You may be using arena data improperly.
Be sure you have gotten the I_ARENAMAN interface and have used AllocateArenaData() properly.

== My module keeps failing to load! ==

Be sure you have all the necessary modules needed for your module to run.
Make sure your module loads after the modules it is dependant on are already loaded.

== My module crashes whenever I try to use an interface! ==

Make sure you have gotten the interface by using <tt>GetInterface()</tt> properly, that the assigned interface variable is unique, and that you verify whether or not the interface is valid by checking to see if it is not defined. The latter is typically done in the entry point, as shown [[Writing Modules In C#Using Interfaces|here]], by adding an if-statement and returning <tt>MM_FAIL</tt> on failure. If the interface is being called at some other point in the code, make sure to verify if it is defined and to handle cases throughout your code where it may not be valid.

Note that also that if a parent interface does not check to see if it is still being used by other modules before unloading, it may cause instability in your zone and eventually result in a crash when a module calls that interface again.

== My module will not compile! Why can't my compiler find certain things? ==

Sometimes, #include asss.h is not enough.
Only the core header files are in asss.h, and you will need to manually include any others.
This may also be true if you are using a custom interface.

== Why does my module keep crashing when a player leaves the zone? ==

You may be saving the player pointer somewhere, and then are trying to access it after the player leaves.
This does not work because the pointer becomes invalid when the player leaves.
Your module is informed when this happens by the CB_NEWPLAYER callback.

[[Category:Module]]
[[Category:Guides]]

Writing Advanced Modules In C

2011-01-19T04:10:14Z

Cheese: /* Passing Multiple Arguments To Commands */ cleaned up

Writing Advanced Modules In C

2011-01-09T20:25:31Z

Cheese: added link

Main Page

2011-01-08T21:09:19Z

Cheese: added link

<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) is an open source server, created by [[User:grelminar|grelminar]], that facilitates games among [[Continuum]] users. It's a replacement, not a clone, of [[Subgame]], which was the old server 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 this wiki, you'll find documents about how to use some of these advanced features, and documentation on how to create your own extensions to the server software. There is also an [[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.minegoboom.com/ Official ASSS Site]
*[http://www.shanky.com/server/ Server Help]
*[http://forums.minegoboom.com/ Server Help Forums]
*[https://bitbucket.org/grelminar/asss/wiki/Development_Reference/ Bitbucket Wiki]

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

<h3>Current Events</h3>

ASSS version 1.4.4 has been released as of September 7, 2007. This version addresses several bug fixes, and now requires Continuum 0.40.

'''Download'''
*[http://asss.yi.org/files/asss-1.4.4.tar.gz Linux]
*[http://asss.yi.org/files/asss-1.4.4-srconly.tar.gz Source Only]
*[http://asss.yi.org/files/asss-1.4.4.zip Windows]
*[http://bitbucket.org/grelminar/asss/overview/ Change Log]

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

[[Category: Wiki]]

Writing Advanced Modules In C

2011-01-08T01:22:07Z

Cheese: minor details

Writing Advanced Modules In C

2011-01-08T00:46:24Z

Cheese: now its easier for the newbies :D

Troubleshooting Modules

2011-01-06T23:37:27Z

Cheese:

Here are some general solutions to help you solve a problem with a module that you just wrote.
Keep in mind that these are suggestions, and may not always be correct.

== My module works when I put it in modules.conf, but the zone crashes when I use ?insmod, why? ==

Chances are, you are doing something in the CB_ARENAACTION callback, and are doing something in the AA_PRECREATE or AA_CREATE states.
Simply do this when the module loads:

<pre>
Arena *a;
Link *link;
aman->Lock();
FOR_EACH_ARENA(a)
{
ArenaAction(a,AA_PRECREATE);
ArenaAction(a,AA_CREATE);
}
aman->Unlock();
</pre>

== When my module is in modules.conf, players can not enter the zone, or when I use ?insmod, players can not switch arenas and I get errors about player states! ==

You may be using arena data improperly.
Be sure you have gotten the I_ARENAMAN interface and have used AllocateArenaData() properly.

== My module keeps failing to load! ==

Be sure you have all the necessary modules needed for your module to run.
Make sure your module loads after the modules it is dependant on are already loaded.

== My module crashes whenever I try to use an interface! ==

Make sure you have gotten the interface by using GetInterface().
You may have forgotten to check if your interface is valid. (''like if(!iface) return MM_FAIL;'')

== My module will not compile! Why can't my compiler find certain things? ==

Sometimes, #include asss.h is not enough.
Only the core header files are in asss.h, and you will need to manually include any others.
This may also be true if you are using a custom interface.

== Why does my module keep crashing when a player leaves the zone? ==

You may be saving the player pointer somewhere, and then are trying to access it after the player leaves.
This does not work because the pointer becomes invalid when the player leaves.
Your module is informed when this happens by the CB_NEWPLAYER callback.

[[Category:Module]]
[[Category:Guides]]

Troubleshooting Modules

2010-12-30T08:41:21Z

Cheese: added knowledge