https://wiki.kag2d.com/api.php?action=feedcontributions&feedformat=atom&user=EchoLynxKing Arthur's Gold Wiki - User contributions [en]2026-04-14T19:05:47ZUser contributionsMediaWiki 1.23.14//wiki.kag2d.com/wiki/ServerServer2012-02-22T19:22:44Z<p>EchoLynx: Fixed Numbering Error</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server isn't designed to work on computers without an Internet connection. It is, however, [http://kagforum.com/index.php?threads/lan-no-internet-server.4135/ still possible] to run it without one.</p><br />
<p>The KAG server uses three ports:<br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=2><pre><br />
global sv_allow_globals_mods = 0;<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via <code>chmod +x sconfig.py</code> and run with <code>./sconfig.py</code> . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
<pre>./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
<pre>KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
</p><br />
<br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
<br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
==Daily Server Restarts==<br />
<p>If a KAG server is running in a keepalive script, a scheduled task/cronjob that kills the server once a day is, effectively, a daily restart because the keepalive script will automatically restart the server.</p><br />
===For Linux - Cronjob===<br />
<p>This script will kill all instances of KAGdedi at 3 AM.</p><br />
<p><br />
# Use <code>crontab -e</code> to create a new cronjob. This will open your default text editor.<br />
# In the text editor, type:<pre>0 3 * * * pkill -1 KAGdedi</pre><br />
# Close editor. Cronjob installed!<br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T19:15:14Z<p>EchoLynx: Added section on daily server restarts and creating a cronjob.</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server isn't designed to work on computers without an Internet connection. It is, however, [http://kagforum.com/index.php?threads/lan-no-internet-server.4135/ still possible] to run it without one.</p><br />
<p>The KAG server uses three ports:<br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=2><pre><br />
global sv_allow_globals_mods = 0;<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via <code>chmod +x sconfig.py</code> and run with <code>./sconfig.py</code> . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
<pre>./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
<pre>KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
</p><br />
<br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
<br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
==Daily Server Restarts==<br />
<p>If a KAG server is running in a keepalive script, a scheduled task/cronjob that kills the server once a day is, effectively, a daily restart because the keepalive script will automatically restart the server.</p><br />
===For Linux - Cronjob===<br />
<p>This script will kill all instances of KAGdedi at 3 AM.</p><br />
<p><br />
# Use <code>crontab -e</code> to create a new cronjob. This will open your default text editor.<br />
# In the text editor, type:<br />
<pre>0 3 * * * pkill -1 KAGdedi</pre><br />
# Close editor. Cronjob installed!<br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:57:11Z<p>EchoLynx: Added note about internet connection requirement.</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server isn't designed to work on computers without an Internet connection. It is, however, [http://kagforum.com/index.php?threads/lan-no-internet-server.4135/ still possible] to run it without one.</p><br />
<p>The KAG server uses three ports:<br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=2><pre><br />
global sv_allow_globals_mods = 0;<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via <code>chmod +x sconfig.py</code> and run with <code>./sconfig.py</code> . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
<pre>./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
<pre>KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
</p><br />
<br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
<br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:52:38Z<p>EchoLynx: Changed text style for consistency.</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=2><pre><br />
global sv_allow_globals_mods = 0;<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via <code>chmod +x sconfig.py</code> and run with <code>./sconfig.py</code> . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
<pre>./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
<pre>KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
</p><br />
<br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
<br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:51:47Z<p>EchoLynx: Changed text formatting for consistency.</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=2><pre><br />
global sv_allow_globals_mods = 0;<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
<pre>./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
<pre>KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm</pre><br />
</p><br />
<br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
<br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:50:08Z<p>EchoLynx: Added Semicolon, Reduced Font Size</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=2><pre><br />
global sv_allow_globals_mods = 0;<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
<br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:48:42Z<p>EchoLynx: Reduced Font Size</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:48:18Z<p>EchoLynx: Reduced Font Size</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:47:31Z<p>EchoLynx: Reduced Font Size</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:34:51Z<p>EchoLynx: Fixed <br /></p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.)<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:34:20Z<p>EchoLynx: Closed Parenthesis</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.<br />)<br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
<br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T18:33:49Z<p>EchoLynx: Finished Managing Instability</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
<p>As Alpha software frequently is, the KAG server is very unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice run the server in a keepalive script, which will restart it whenever it crashes. (In addition, many people restart their server once a day, during the hours of least usage, to help decrease the risk of a crash while the server is being played upon.)</p><br />
==Trelawny's Keepalive Script for Linux==<br />
<p>This script, <code>dedi.sh</code>, will restart the KAG server 5 seconds after it crashes. Download it [http://dl.dropbox.com/u/23114384/files/dedi.sh here].<br /><br />
If retyping/using copy and paste, make sure word wrapping is turned off in you text editor. (In nano, use <code> nano -w dedi.sh </code>.<br /><br />
Once created, be sure to make the script executable with <code>chmod +x dedi.sh</code>.</p><br />
<pre><br />
#!/bin/bash<br />
echo "Running KAG dedicated server"<br />
echo "TO SET IP/PORT/SLOTS/PASSWORD ADD THESE COMMAND PARAMS: ip 127.0.0.1 port 50213 slots 32 password pass123"<br />
mv KAGdedi.tmp KAGdedi<br />
chmod +x KAGdedi<br />
until ./KAGdedi nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm; do<br />
echo "KAG server running"<br />
sleep 5<br />
done<br />
</pre><br />
<p>To use, run the script: <code>./dedi.sh</code></p><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p><br />
==The Beaz's Keepalive Script for Windows==<br />
<p>This script, <code>dedi.bat</code>, will restart the KAG server 5 seconds after it crashes. To use, create a text file, paste/type in the script below, and save it as <code>dedi.bat</code>.</p><br />
<pre><br />
@ECHO off<br />
<br />
:restart<br />
echo (%time%) Server Started - close this window to prevent restart.<br />
<br />
start /wait KAG.exe nolauncher autostart Scripts/dedicated_autostart.gm autoconfig Scripts/dedicated_autoconfig.gm<br />
<br />
echo (%time%) WARNING: Server closed or crashed, restarting.<br />
<br />
goto restart<br />
</pre><br />
===Adapting for Maqq's Configuration Tool===<br />
<p>To use a configuration generated by Maqq's Configuration Tool, replace line 6 in the above script with: <br />
<pre><br />
start /wait KAG.exe nolauncher autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm<br />
</pre><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T16:58:03Z<p>EchoLynx: </p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p><br />
=Managing Instability=<br />
As Alpha software frequently is, the KAG server is highly unstable. Recent builds have been especially prone to crashing whenever left running for more than 24 hours. As such, it is recommended practice to run the server in a keepalive script, which will restart it whenever it crashes.</div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T04:56:53Z<p>EchoLynx: Added Blacklisting & Whitelisting</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p><br />
=Blacklisting & Whitelisting=<br />
<p>A player blacklists is the list of players who are not allowed to play on a given server. A whitelist is the inverse of a blacklist; if enabled, only those on the whitelist will be allowed to play.</p><br />
==How to Create a Blacklist or Whitelist==<br />
<p>Create the following file and save it as <code>securitysetup.cfg</code> in <code>kagServer/Base/Scripts</code>, where kagServer is the path to the kagServer's directory.</p><br />
<pre><br />
# set this to 1 to allow only the names in whitelist<br />
whitelist_active = 0;<br />
whitelist = name1; name2;<br />
# set this to 1 to ban the names in blacklist<br />
blacklist_active = 0;<br />
blacklist = name1; name2;<br />
</pre><br />
<p>Note: The whitelist overrides the blacklist.</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T04:00:54Z<p>EchoLynx: </p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
'''Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.'''<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/Talk:ServerTalk:Server2012-02-22T03:19:31Z<p>EchoLynx: </p>
<hr />
<div>* I don't have much time to sit and format it nicely. I'll just write down what I know about setting up server. --[[User:Furai|Furai]] 20:52, 15 September 2011 (UTC)<br />
* I'm done for today. Feel free to leave here any comments, suggestions. --[[User:Furai|Furai]] 22:31, 15 September 2011 (UTC)<br />
** Did some small cleanup. --[[User:Illu|Illu]] 23:59, 15 September 2011 (UTC)<br />
* This needs a major update!!! It is not even close to what is written in the readme.txt!<br />
<br />
* Overhauled entire page. --[[User:EchoLynx|EchoLynx]] 20:52, 21 February 2012 (EST)<br />
* Added RCON commands from server readme.--[[User:EchoLynx|EchoLynx]] 22:19, 21 February 2012 (EST)<br />
* Does a KAG server need an internet connection? (Can it run on a local network only?) --[[User:EchoLynx|EchoLynx]] 22:19, 21 February 2012 (EST)</div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T03:17:53Z<p>EchoLynx: </p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p><br />
=Remote Control=<br />
<p>A server can be controlled in-game. While connected to the server, press the HOME key to open the console. Typing "/rcon password", where password is the RCON password set by sv_rconpassword, will allow the current user to send commands to the server. These commands must be prefixed by "/rcon". For example, to use the /list command, type. "/rcon /list".</p><br />
==Remote Server Commands==<br />
<p><br />
\list - list all commands and variables<br /><br />
\kick [playername] [minutes]<br /><br />
\kickid [id] [minutes]<br /><br />
\kickhost [host] [minutes] - kicks and/or bans host (host number can be found in logs when player joins)<br /><br />
\unbanhost [host] \unban; \unbanhost; \unbanhid commands<br /><br />
\swapid [player id] - swaps the players team<br /><br />
\players<br /><br />
\restartmap<br /><br />
\loadmap [name]<br /><br />
\savemap [name]<br /><br />
\msg [text]<br /><br />
\rcon [password]<br /><br />
addBotX - addBotX( team, class, name ); eg. addBotX( 1, 0, `St. John` );<br /><br />
</p></div>EchoLynx//wiki.kag2d.com/wiki/Royal_GuardRoyal Guard2012-02-22T02:47:11Z<p>EchoLynx: </p>
<hr />
<div><p>The Royal Guard (also known as global moderators) is a group of players who have the extra responsibility of ensuring a fair and enjoyable play experience on most public and gold servers. They are hand picked by the KAG development team. A current list of guards can be found [http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-08-02-2012.1128/ here].</p><br />
=Privileges of the Guard=<br />
A member of the Royal Guard, when logged into a server that acknowledges their authority, will have administrative privileges on that server. They can be identified by the green color of their name. (Unfortunately, they cannot be distinguished from normal Administrators - people who own/run a given server.)<br />
=Appeals=<br />
Players banned by Guards can appeal their ban on the [http://kagforum.com/index.php?threads/ban-appeals.1713/ appeals thread].<br />
=Becoming a Guard=<br />
New guards are selected behind closed doors. There is no defined path to becoming a guard. Players who become active members of the KAG community are most likely to be selected, although new guards are only selected if the player population becomes more than the existing Guard can handle.<br /></div>EchoLynx//wiki.kag2d.com/wiki/Royal_GuardRoyal Guard2012-02-22T02:30:45Z<p>EchoLynx: /* Guard Powers */</p>
<hr />
<div><p>The Royal Guard (also known as global moderators) is a group of players who have the extra responsibility of ensuring a fair and enjoyable play experience on most public and gold servers. They are hand picked by the KAG development team. A current list of guards can be found [http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-08-02-2012.1128/ here].</p><br />
=Privileges of the Guard=<br />
A member of the Royal Guard, when logged into a server that acknowledges their authority, will have administrative privileges on that server. They can be identified by the green color of their name. (Unfortunately, they cannot be distinguished from normal Administrators - people who own/run a given server.)</div>EchoLynx//wiki.kag2d.com/wiki/Royal_GuardRoyal Guard2012-02-22T02:30:21Z<p>EchoLynx: </p>
<hr />
<div><p>The Royal Guard (also known as global moderators) is a group of players who have the extra responsibility of ensuring a fair and enjoyable play experience on most public and gold servers. They are hand picked by the KAG development team. A current list of guards can be found [http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-08-02-2012.1128/ here].</p><br />
=Guard Powers=<br />
A member of the Royal Guard, when logged into a server that acknowledges their authority, will have administrative privileges on that server. They can be identified by the green color of their name. (Unfortunately, they cannot be distinguished from normal Administrators - people who own/run a given server.)</div>EchoLynx//wiki.kag2d.com/wiki/Royal_GuardRoyal Guard2012-02-22T02:25:41Z<p>EchoLynx: </p>
<hr />
<div><p>The Royal Guard (also known as global moderators) is a group of players who have the extra responsibility of ensuring a fair and enjoyable play experience on most public and gold servers. They are hand picked by the KAG development team. A current list of guards can be found [http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-08-02-2012.1128/ here].</p><br />
<br />
<p>A guard can usually be identified in-game, by their green colored name (although a server's administrator will be green also). If you need help - feel free to ask them questions, as guards are encouraged to be friendly and helpful members of the KAG community. The current roster of Royal Guards can be found here.</p></div>EchoLynx//wiki.kag2d.com/wiki/Royal_GuardRoyal Guard2012-02-22T02:24:26Z<p>EchoLynx: Created page with "The Royal Guard (also known as global moderators) is a group of players who have the extra responsibility of ensuring a fair and enjoyable play experience on most public and gold..."</p>
<hr />
<div>The Royal Guard (also known as global moderators) is a group of players who have the extra responsibility of ensuring a fair and enjoyable play experience on most public and gold servers. They are hand picked by the KAG development team. A current list of guards can be found [http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-08-02-2012.1128/ here]</div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T02:20:00Z<p>EchoLynx: /* Windows */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T02:19:43Z<p>EchoLynx: /* Linux */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. (The default port is 50301.) Note that domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T02:18:52Z<p>EchoLynx: /* Hosting on Residential Connections */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To complicate hosting a server, they may block certain ports and dynamically assign IP addresses. <br />
*It is highly unlikely that they would block the ports used by the KAG server. (A local router's firewall is most likely the culprit for connectivity issues when hosting on a residential connection.)<br />
*[http://ip4.me This] site displays the IP address of the current visitor. It can be used to determine the currently assigned public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T02:13:27Z<p>EchoLynx: /* Generator.cfg */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To discourage this, they may block certain ports and dynamically assign an IP addresses. It is highly unlikely that they would block the ports used by the KAG server, and [http://ip4.me this] site displays the IP address of the current visitor.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===*-generator.cfg===<br />
<p>Generators use [http://libnoise.sourceforge.net/tutorials/tutorial4.html "libnoise"-library].</p><br />
<br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T02:11:20Z<p>EchoLynx: /* Network */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
===Hosting on Residential Connections===<br />
<p>For those hosting on residential internet connections, keep in mind that many ISPs forbid running any kind of server, including a KAG server. To discourage this, they may block certain ports and dynamically assign an IP addresses. It is highly unlikely that they would block the ports used by the KAG server, and [http://ip4.me this] site displays the IP address of the current visitor.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T02:05:43Z<p>EchoLynx: /* Network */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
<p>For those hosting on a residential internet connection, keep in mind that your ISP may or may not tolerate running as server. Most ISPs will dynamically assign an IP address. Use [http://ip4.me this] site to find your public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T02:05:12Z<p>EchoLynx: /* Network */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
<p>The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.</p><p><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.</p><br />
<p>For those hosting on a residential internet connection, keep in mind that your ISP may or may not tolerate running as server. Most ISPs will dynamically assign an IP address. Use [http://ipv4.me this] site to find your public IP address.</p><br />
<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T02:00:32Z<p>EchoLynx: /* Windows */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.<br /><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T01:59:59Z<p>EchoLynx: /* Linux */</p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.<br /><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />To connect, either find it in the server list or connect directly using the IPaddress:PortNumber format. Domain names will not work in place of the IP address.<br />
</p><br />
<br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />
</p><br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/Talk:ServerTalk:Server2012-02-22T01:52:06Z<p>EchoLynx: </p>
<hr />
<div>* I don't have much time to sit and format it nicely. I'll just write down what I know about setting up server. --[[User:Furai|Furai]] 20:52, 15 September 2011 (UTC)<br />
* I'm done for today. Feel free to leave here any comments, suggestions. --[[User:Furai|Furai]] 22:31, 15 September 2011 (UTC)<br />
** Did some small cleanup. --[[User:Illu|Illu]] 23:59, 15 September 2011 (UTC)<br />
* This needs a major update!!! It is not even close to what is written in the readme.txt!<br />
<br />
* Overhauled entire page. --[[User:EchoLynx|EchoLynx]] 20:52, 21 February 2012 (EST)</div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T01:50:02Z<p>EchoLynx: </p>
<hr />
<div>{{Build<br />
|Version = 281<br />
}}<br />
The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.<br /><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />
</p><br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />
</p><br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-22T01:44:06Z<p>EchoLynx: /* Server */</p>
<hr />
<div>The King Arthur's Gold Server is a relatively lightweight, 32-bit command line application. Freely distributed, this program allows anybody with an internet connection and a computer to host their own King Arthur's Gold server.<br />
<br />
Note: There is very little official documentation for the KAG server. As a result, the majority of this document was created from observation, trial and error. Use at your own risk.<br />
=Features=<br />
*All servers are added to the official server list to be seen by anybody who chooses the "Pick a Server" option in-game.<br />
*Servers can be remotely controlled in game by anybody with the server's Remote Control (RCON) password.<br />
*Servers can be password protected. (This is separate from the RCON password.)<br />
=Requirements=<br />
==Hardware==<br />
The hardware requirements for a KAG server are minimal. If a computer can run the full KAG game, it can run the KAG server.<br />
==Software==<br />
The KAG server can run on Linux, Windows, or Mac. The recommended operating system is Linux, specifically Debian.<br />
==Network==<br />
The KAG server uses three ports. <br />
{|border="1" cellpadding="5" cellspacing="0" <br />
|-<br />
|<br />
! scope="col" style="background:#efefef;" | Description<br />
! scope="col" style="background:#efefef;" | Modifiable?<br />
! scope="col" style="background:#efefef;" | Firewall Tolerant?<br />
|-<br />
! scope="row" style="background:#efefef;" | 50301<br />
|Used to listen for connections.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#E83131;"|no<br />
|-<br />
! scope="row" style="background:#efefef;" | 50328<br />
|Used to communicate with clients.<br />
!scope="row" style="background:#31E831;"|yes<br />
!scope="row" style="background:#31E831;"|yes<br />
|-<br />
! scope="row" style="background:#efefef;" | 51308<br />
|Used to communicate with the master server.<br />
!scope="row" style="background:#E83131;"|no<br />
!scope="row" style="background:#31E831;"|yes<br />
|}<br />
Firewall tolerant means that a typical connection-oriented ([http://en.wikipedia.org/wiki/Stateful_firewall SPI]) firewall will allow that port through. Depending on the firewall, all ports may need to be forwarded.<br /><br />
The internet connection is typically the bottleneck that determines the number of users a server can support. Hosting more users than a connection can support will cause a high ping time and significant lag.<br />
=Installation=<br />
==Linux==<br />
<p>This guide is written for 32-bit Debian Linux. To run on 64-bit Debian Linux, the <code>ia32-libs</code> package must be installed.</p><br />
<p><br />
# First, download the server: <br /> <pre>wget http://kag2d.com/downloads/kag_linux.tar.gz</pre><br />
# Next, decompress the archive. <br /> <pre>tar -zxf kag_linux.tar.gz</pre><br />
# Change to the new directory: <br /> <pre>cd kag_linux</pre><br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server: <br /> <pre>./dedicatedserver.sh</pre><br />
</p><br />
==Windows==<br />
<p><br />
# First, download the server: http://kag2d.com/downloads/ <br /> Note: The downloads page only lists a linux server. Even though the server is intended to run on Linux, it will run on Windows.<br />
# Next, decompress the archive. This can be done with many different programs, including [http://peazip.sourceforge.net/ PeaZip].<br />
# Open the folder the archive was extracted into.<br />
# [[Server#Configuration|Configure]] your server.<br />
# Run your server by clicking <code>dedicatedserver.bat</code>.<br />
</p><br />
==Mac==<br />
Due to their similarities, the installation instructions for Linux should apply for Macs.<br />
=Configuration=<br />
<p>The KAG server is configured using text files. Customizing a KAG server installation involves modifying the variables in these files. There are two ways to do this: manually and using Maqq's Configuration Tool. Of the two, Maqq's Tool is by far the fastest and easiest method.</p><br />
<p>'''One of the most important decisions a server administrator must make is whether or not to allow the [[Royal Guard]] to police their server. Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''</p><br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
==Manual Configuration==<br />
Of the many editable configuration files that the KAG server depends upon, most customization is done in the <code>dedicated_autoconfig.gm</code>, <code>dedicated_autostart.gm</code>, <code>mapcycle.cfg</code>, and <code>*-generator.cfg</code> files. These are all in the kagServer/Base/Scripts directory, where kagServer is the directory the server was extracted into.<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>Of the many modifiable variables, these are some of the most important:<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
==Maqq's Server Configuration Tool==<br />
<p>Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:</p><br />
<p><br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this program</p><br />
===Reusing Generated Configs===<br />
<p>These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]</p><br />
<p><br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
</p><br />
===Download Maqq's Server Config Tool===<br />
<p><br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</p></div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-21T23:24:47Z<p>EchoLynx: /* 64bit Kernel */</p>
<hr />
<div>{{Build<br />
|Version = Not Up-to-date <br />
}}<br />
A simple guide for hosting a KAG server on Linux and Windows. This guide will be growing gradually over time.<br /><br />
Currently the ''suggested'' operating system for hosting a KAG server is Linux.<br />
<br />
==Linux==<br />
<br />
''In this example we use the Debian distribution. For other distributions, please modify accordingly.''<br />
<br />
To begin with you need to download the [http://kag2d.com/download server files] (linux server). You can unpack it locally (it's in "tar.gz" format so only thing you need to do is to unpack it twice, assuming you're using Windows) on your machine and upload it to your server via FTP/SFTP using programmes like "WinSCP", "FileZilla", etc.<br />.<br />
Otherwise, and via SSH type: ''wget http://kag2d.com/downloads/kag_linux.tar.gz'' to download from the kag2d.com website.<br />
<br />
To decompress type:<br />
<code><br />
tar zxf kag_linux.tar.gz<br />
</code><br />
change into kag_linux directory by:<br />
<code><br />
cd kag_linux<br />
</code><br />
<p>Assuming you've edited all [[Server#Configuration|configuration files]] to your liking, only thing that left to do is running your server:<br /><br />
<br />
<br />
./KAGdedi<br />
</p><br />
<br />
<p>As you can see all the output from the server is going straight onto your screen. You can use some multiplexer e.g. "GNU Screen", "nohup", etc. I'll cover in detail how to run it later. For now you can issue the following command:<br /><br />
<br />
<br />
./dedicatedserver.sh > /dev/null<br />
</p><br />
<br />
It will output "everything" to "nowhere". It's a temporary solution.<br /><br />
<br />
<p>If you are using SSH and you want the server to keep running after you close the SSH connection use this command:<br /><br />
<code><br />
nohup dedicatedserver.sh &<br />
</code> </p><br /><br />
How to restart the server:<br /><br />
If you wish to restart the server this is simple type top then find the PID then type kill <PID of the KAG service><br />
<br />
<br />
===64bit Kernel===<br />
<p>If you're using a 64bit kernel then you need to install additional 32-bit libraries.<br /><br />
<br />
<code><br />
apt-get install ia32-libs<br />
</code></p><br />
<br />
<p>If you're not sure which kernel you're running, type:<br /><br />
<br />
<code><br />
uname -m<br />
</code><br /><br />
<br />
This will either return ''i686'' (32bit) or ''x86_64'' (64bit).</p><br />
<br />
==Windows==<br />
Locate "dedicatedserver.bat" in the root directory of your KAG installation (default location: C:\KAG). <br />
<br />
Edit the files mentioned in the following section ([[Server#Configuration|Configuration]]) (default location: C:\KAG\Base\Scripts\ etc).<br />
<br />
Once you're done editing the configuration files to match your server's needs, double click on the batchfile (dedicatedserver.bat) to run.<br />
<br />
==Configuration==<br />
'''A ''vital'' consideration for your server is whether you will allow global moderators (a.k.a. "[[guards]]"). Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''<br />
<br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>When you edit this file you need to take a closer look at these lines (comments are from MM himself, I've tweaked it here and there to make it more clear):<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
<br />
===Maqq's Server Configuration Tool===<br />
Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:<br />
<br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this programme<br />
;Reusing Generated Configs<br />
<br />
These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]<br />
<br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br /><br /><br />
<br />
==Download Maqq's Server Config Tool==<br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-21T23:24:25Z<p>EchoLynx: /* 64bit Kernel */</p>
<hr />
<div>{{Build<br />
|Version = Not Up-to-date <br />
}}<br />
A simple guide for hosting a KAG server on Linux and Windows. This guide will be growing gradually over time.<br /><br />
Currently the ''suggested'' operating system for hosting a KAG server is Linux.<br />
<br />
==Linux==<br />
<br />
''In this example we use the Debian distribution. For other distributions, please modify accordingly.''<br />
<br />
To begin with you need to download the [http://kag2d.com/download server files] (linux server). You can unpack it locally (it's in "tar.gz" format so only thing you need to do is to unpack it twice, assuming you're using Windows) on your machine and upload it to your server via FTP/SFTP using programmes like "WinSCP", "FileZilla", etc.<br />.<br />
Otherwise, and via SSH type: ''wget http://kag2d.com/downloads/kag_linux.tar.gz'' to download from the kag2d.com website.<br />
<br />
To decompress type:<br />
<code><br />
tar zxf kag_linux.tar.gz<br />
</code><br />
change into kag_linux directory by:<br />
<code><br />
cd kag_linux<br />
</code><br />
<p>Assuming you've edited all [[Server#Configuration|configuration files]] to your liking, only thing that left to do is running your server:<br /><br />
<br />
<br />
./KAGdedi<br />
</p><br />
<br />
<p>As you can see all the output from the server is going straight onto your screen. You can use some multiplexer e.g. "GNU Screen", "nohup", etc. I'll cover in detail how to run it later. For now you can issue the following command:<br /><br />
<br />
<br />
./dedicatedserver.sh > /dev/null<br />
</p><br />
<br />
It will output "everything" to "nowhere". It's a temporary solution.<br /><br />
<br />
<p>If you are using SSH and you want the server to keep running after you close the SSH connection use this command:<br /><br />
<code><br />
nohup dedicatedserver.sh &<br />
</code> </p><br /><br />
How to restart the server:<br /><br />
If you wish to restart the server this is simple type top then find the PID then type kill <PID of the KAG service><br />
<br />
<br />
=64bit Kernel=<br />
<br />
<p>If you're using a 64bit kernel then you need to install additional 32-bit libraries.<br /><br />
<br />
<code><br />
apt-get install ia32-libs<br />
</code></p><br />
<br />
<p>If you're not sure which kernel you're running, type:<br /><br />
<br />
<code><br />
uname -m<br />
</code><br /><br />
<br />
This will either return ''i686'' (32bit) or ''x86_64'' (64bit).</p><br />
<br />
==Windows==<br />
Locate "dedicatedserver.bat" in the root directory of your KAG installation (default location: C:\KAG). <br />
<br />
Edit the files mentioned in the following section ([[Server#Configuration|Configuration]]) (default location: C:\KAG\Base\Scripts\ etc).<br />
<br />
Once you're done editing the configuration files to match your server's needs, double click on the batchfile (dedicatedserver.bat) to run.<br />
<br />
==Configuration==<br />
'''A ''vital'' consideration for your server is whether you will allow global moderators (a.k.a. "[[guards]]"). Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''<br />
<br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>When you edit this file you need to take a closer look at these lines (comments are from MM himself, I've tweaked it here and there to make it more clear):<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
<br />
===Maqq's Server Configuration Tool===<br />
Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:<br />
<br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this programme<br />
;Reusing Generated Configs<br />
<br />
These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]<br />
<br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br /><br /><br />
<br />
==Download Maqq's Server Config Tool==<br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-21T23:23:20Z<p>EchoLynx: /* Configuration */</p>
<hr />
<div>{{Build<br />
|Version = Not Up-to-date <br />
}}<br />
A simple guide for hosting a KAG server on Linux and Windows. This guide will be growing gradually over time.<br /><br />
Currently the ''suggested'' operating system for hosting a KAG server is Linux.<br />
<br />
==Linux==<br />
<br />
''In this example we use the Debian distribution. For other distributions, please modify accordingly.''<br />
<br />
To begin with you need to download the [http://kag2d.com/download server files] (linux server). You can unpack it locally (it's in "tar.gz" format so only thing you need to do is to unpack it twice, assuming you're using Windows) on your machine and upload it to your server via FTP/SFTP using programmes like "WinSCP", "FileZilla", etc.<br />.<br />
Otherwise, and via SSH type: ''wget http://kag2d.com/downloads/kag_linux.tar.gz'' to download from the kag2d.com website.<br />
<br />
To decompress type:<br />
<code><br />
tar zxf kag_linux.tar.gz<br />
</code><br />
change into kag_linux directory by:<br />
<code><br />
cd kag_linux<br />
</code><br />
<p>Assuming you've edited all [[Server#Configuration|configuration files]] to your liking, only thing that left to do is running your server:<br /><br />
<br />
<br />
./KAGdedi<br />
</p><br />
<br />
<p>As you can see all the output from the server is going straight onto your screen. You can use some multiplexer e.g. "GNU Screen", "nohup", etc. I'll cover in detail how to run it later. For now you can issue the following command:<br /><br />
<br />
<br />
./dedicatedserver.sh > /dev/null<br />
</p><br />
<br />
It will output "everything" to "nowhere". It's a temporary solution.<br /><br />
<br />
<p>If you are using SSH and you want the server to keep running after you close the SSH connection use this command:<br /><br />
<code><br />
nohup dedicatedserver.sh &<br />
</code> </p><br /><br />
How to restart the server:<br /><br />
If you wish to restart the server this is simple type top then find the PID then type kill <PID of the KAG service><br />
<br />
<br />
===64bit Kernel===<br />
<br />
<p>If you're using a 64bit kernel then you need to install additional 32-bit libraries.<br /><br />
<br />
<code><br />
apt-get install ia32-libs<br />
</code></p><br />
<br />
<p>If you're not sure which kernel you're running, type:<br /><br />
<br />
<code><br />
uname -m<br />
</code><br /><br />
<br />
This will either return ''i686'' (32bit) or ''x86_64'' (64bit).</p><br />
<br />
==Windows==<br />
Locate "dedicatedserver.bat" in the root directory of your KAG installation (default location: C:\KAG). <br />
<br />
Edit the files mentioned in the following section ([[Server#Configuration|Configuration]]) (default location: C:\KAG\Base\Scripts\ etc).<br />
<br />
Once you're done editing the configuration files to match your server's needs, double click on the batchfile (dedicatedserver.bat) to run.<br />
<br />
==Configuration==<br />
'''A ''vital'' consideration for your server is whether you will allow global moderators (a.k.a. "[[guards]]"). Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''<br />
<br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>When you edit this file you need to take a closer look at these lines (comments are from MM himself, I've tweaked it here and there to make it more clear):<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
<br />
===Maqq's Server Configuration Tool===<br />
Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:<br />
<br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this programme<br />
;Reusing Generated Configs<br />
<br />
These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]<br />
<br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br /><br /><br />
<br />
==Download Maqq's Server Config Tool==<br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-20T22:06:28Z<p>EchoLynx: /* Maqq's Server Configuration Tool */</p>
<hr />
<div>{{Build<br />
|Version = Not Up-to-date <br />
}}<br />
A simple guide for hosting a KAG server on Linux and Windows. This guide will be growing gradually over time.<br /><br />
Currently the ''suggested'' operating system for hosting a KAG server is Linux.<br />
<br />
==Linux==<br />
<br />
''In this example we use the Debian distribution. For other distributions, please modify accordingly.''<br />
<br />
To begin with you need to download the [http://kag2d.com/download server files] (linux server). You can unpack it locally (it's in "tar.gz" format so only thing you need to do is to unpack it twice, assuming you're using Windows) on your machine and upload it to your server via FTP/SFTP using programmes like "WinSCP", "FileZilla", etc.<br />.<br />
Otherwise, and via SSH type: ''wget http://kag2d.com/downloads/kag_linux.tar.gz'' to download from the kag2d.com website.<br />
<br />
To decompress type:<br />
<code><br />
tar zxf kag_linux.tar.gz<br />
</code><br />
change into kag_linux directory by:<br />
<code><br />
cd kag_linux<br />
</code><br />
<p>Assuming you've edited all [[Server#Configuration|configuration files]] to your liking, only thing that left to do is running your server:<br /><br />
<br />
<br />
./KAGdedi<br />
</p><br />
<br />
<p>As you can see all the output from the server is going straight onto your screen. You can use some multiplexer e.g. "GNU Screen", "nohup", etc. I'll cover in detail how to run it later. For now you can issue the following command:<br /><br />
<br />
<br />
./dedicatedserver.sh > /dev/null<br />
</p><br />
<br />
It will output "everything" to "nowhere". It's a temporary solution.<br /><br />
<br />
<p>If you are using SSH and you want the server to keep running after you close the SSH connection use this command:<br /><br />
<code><br />
nohup dedicatedserver.sh &<br />
</code> </p><br /><br />
How to restart the server:<br /><br />
If you wish to restart the server this is simple type top then find the PID then type kill <PID of the KAG service><br />
<br />
<br />
===64bit Kernel===<br />
<br />
<p>If you're using a 64bit kernel then you need to install additional 32-bit libraries.<br /><br />
<br />
<code><br />
apt-get install ia32-libs<br />
</code></p><br />
<br />
<p>If you're not sure which kernel you're running, type:<br /><br />
<br />
<code><br />
uname -m<br />
</code><br /><br />
<br />
This will either return ''i686'' (32bit) or ''x86_64'' (64bit).</p><br />
<br />
==Windows==<br />
Locate "dedicatedserver.bat" in the root directory of your KAG installation (default location: C:\KAG). <br />
<br />
Edit the files mentioned in the following section ([[Server#Configuration|Configuration]]) (default location: C:\KAG\Base\Scripts\ etc).<br />
<br />
Once you're done editing the configuration files to match your server's needs, double click on the batchfile (dedicatedserver.bat) to run.<br />
<br />
==Configuration==<br />
<br />
'''Note: Following configuration files are common in both windows and linux servers; they ''must'' be edited for your server to work.'''<br />
<br />
<br />
'''Additional note: A ''vital'' consideration for your server is whether you will allow global moderators (a.k.a. "[[guards]]"). Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''<br />
<br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>When you edit this file you need to take a closer look at these lines (comments are from MM himself, I've tweaked it here and there to make it more clear):<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
<br />
===Maqq's Server Configuration Tool===<br />
Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:<br />
<br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this programme<br />
;Reusing Generated Configs<br />
<br />
These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]<br />
<br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br /><br /><br />
<br />
==Download Maqq's Server Config Tool==<br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</div>EchoLynx//wiki.kag2d.com/wiki/ServerServer2012-02-20T22:06:02Z<p>EchoLynx: /* Maqq's CLI Server Configuration tool */</p>
<hr />
<div>{{Build<br />
|Version = Not Up-to-date <br />
}}<br />
A simple guide for hosting a KAG server on Linux and Windows. This guide will be growing gradually over time.<br /><br />
Currently the ''suggested'' operating system for hosting a KAG server is Linux.<br />
<br />
==Linux==<br />
<br />
''In this example we use the Debian distribution. For other distributions, please modify accordingly.''<br />
<br />
To begin with you need to download the [http://kag2d.com/download server files] (linux server). You can unpack it locally (it's in "tar.gz" format so only thing you need to do is to unpack it twice, assuming you're using Windows) on your machine and upload it to your server via FTP/SFTP using programmes like "WinSCP", "FileZilla", etc.<br />.<br />
Otherwise, and via SSH type: ''wget http://kag2d.com/downloads/kag_linux.tar.gz'' to download from the kag2d.com website.<br />
<br />
To decompress type:<br />
<code><br />
tar zxf kag_linux.tar.gz<br />
</code><br />
change into kag_linux directory by:<br />
<code><br />
cd kag_linux<br />
</code><br />
<p>Assuming you've edited all [[Server#Configuration|configuration files]] to your liking, only thing that left to do is running your server:<br /><br />
<br />
<br />
./KAGdedi<br />
</p><br />
<br />
<p>As you can see all the output from the server is going straight onto your screen. You can use some multiplexer e.g. "GNU Screen", "nohup", etc. I'll cover in detail how to run it later. For now you can issue the following command:<br /><br />
<br />
<br />
./dedicatedserver.sh > /dev/null<br />
</p><br />
<br />
It will output "everything" to "nowhere". It's a temporary solution.<br /><br />
<br />
<p>If you are using SSH and you want the server to keep running after you close the SSH connection use this command:<br /><br />
<code><br />
nohup dedicatedserver.sh &<br />
</code> </p><br /><br />
How to restart the server:<br /><br />
If you wish to restart the server this is simple type top then find the PID then type kill <PID of the KAG service><br />
<br />
<br />
===64bit Kernel===<br />
<br />
<p>If you're using a 64bit kernel then you need to install additional 32-bit libraries.<br /><br />
<br />
<code><br />
apt-get install ia32-libs<br />
</code></p><br />
<br />
<p>If you're not sure which kernel you're running, type:<br /><br />
<br />
<code><br />
uname -m<br />
</code><br /><br />
<br />
This will either return ''i686'' (32bit) or ''x86_64'' (64bit).</p><br />
<br />
==Windows==<br />
Locate "dedicatedserver.bat" in the root directory of your KAG installation (default location: C:\KAG). <br />
<br />
Edit the files mentioned in the following section ([[Server#Configuration|Configuration]]) (default location: C:\KAG\Base\Scripts\ etc).<br />
<br />
Once you're done editing the configuration files to match your server's needs, double click on the batchfile (dedicatedserver.bat) to run.<br />
<br />
==Configuration==<br />
<br />
'''Note: Following configuration files are common in both windows and linux servers; they ''must'' be edited for your server to work.'''<br />
<br />
<br />
'''Additional note: A ''vital'' consideration for your server is whether you will allow global moderators (a.k.a. "[[guards]]"). Please read the opening posts in these threads ([http://kagforum.com/index.php?threads/in-game-moderators-aka-royal-guard-updated-25-12-2011.1128/ In-game moderators (AKA Royal Guard)] & [http://kagforum.com/index.php?threads/the-royal-guard-frequently-asked-questions-public-policy.1714/ The Royal Guard - FAQ & Public Policy]) so you can make an informed decision.'''<br />
<br />
<p>If you decide you don't want guards to moderate on your server, ''please ensure they are turned off'' in your dedicated_autoconfig.gm file like this:<br />
<br />
<font size=3><pre><br />
global sv_allow_globals_mods = 0<br />
</pre></font></p><br />
<br />
===dedicated_autoconfig.gm===<br />
<br />
<p>When you edit this file you need to take a closer look at these lines (comments are from MM himself, I've tweaked it here and there to make it more clear):<br />
<br />
<font size=3><pre><br />
global m_width = 600; // Map generator width. Affects RAM usage.<br />
global m_height = 250; // Map generator height. Affects RAM usage.<br />
global m_seed = 0; // Map generator seed. Pick a random number.<br />
global g_kickvote_percent = 33; // Percentage of players needed for a kick vote to pass.<br />
global g_mapvote_percent = 51; // Percentage of team players needed for a map vote to pass.<br />
global g_vote_time = 60; // How long (in seconds) does the voting take place.<br />
global g_kickvote_bantime = 30; // How long (in minutes) is the player banned after a kick vote.<br />
global sv_maxplayers = 16; // Maximum number of players allowed ingame.<br />
global sv_port = 50301; // Server communication port, this is where it listens for incoming clients. Remember to open this port in your firewall.<br />
global sv_password = ``; // Sets the server password.<br />
global sv_rconpassword = ``; // Sets the server remote console password. This is important if you want to have control over your server.<br />
global sv_require_auth = 1; // If set to 1 server checks client authentication via master server.<br />
global sv_gold_only = 0; // If set to 1 only premium account players can join (aka Gold Server).<br />
global sv_allow_globals_mods = 1; // If set to 1 global KAG moderators and admins can kick/ban players on server.<br />
global sv_deltapos_modifier = 1; // Controls the threshold for delta packet updating. Value higher than 1 will reduce bandwidth, lower increase.<br />
global sv_maxping = 450; // Max ping allowed on server after which player is kicked. Large ping players will slow down server.<br />
global sv_maxping_warnings = 200; // Because of ping spikes, warnings are issued if a player has ping over max number.<br />
global sv_maxhack_warnings = 25; // Maximum amount of warnings where server thinks player is hacking.<br />
global sv_alloweditor = 1; // If set to 1 players that have RCON can start map editor on server<br />
global sv_name = `KAG game`; // Sets the server name displayed in server browser.<br />
global sv_info = ``; // Sets the server info displayed in server browser. If you want it multi-line simply move text to new line with enter.<br />
</pre></font></p><br />
<br />
===dedicated_autostart.gm===<br />
<br />
<p><font size=3><pre><br />
LoadRules("Rules/CTF/gamemode.cfg");<br />
LoadMapCycle( "Scripts/mapcycle.cfg" );<br />
LoadMap( "" );<br />
</pre></font><br />
<br />
This file is very important. If you want to change rules for your server then you have to edit the first line to contain the path to the config-file which you want to use. <br /><br />
Just leave it like that if you want your server to automatically change the map after a match is finished. But if you want to have one map all the time instead of a nice mapcycle remove the path from "LoadMapCycle" and use "LoadMap".</p><br />
<br />
===mapcycle.cfg===<br />
<br />
<p><font size=3><pre><br />
#KAG mapcycle;<br />
# put map generator files, png files here, or script files<br />
# eg. mapcycle = Maps/example1.png; Maps/example2.png; Maps/generator_flat.cfg; Maps/swordfight.gm;<br />
<br />
mapcycle = Maps/generator_ctf_mountain.cfg;<br />
</pre></font><br />
<br />
You must separate paths to files with semicolons. Allowed files are generators, script files and maps in png format.</p><br />
<br />
===Generator.cfg===<br />
<br />
<p>I use here general name for generator configuration file, you can name it however you like.<br /><br />
Generator uses "libnoise"-library. You can read a tutorial about how to use it [http://libnoise.sourceforge.net/tutorials/tutorial4.html here].</p><br />
<br />
===Maqq's Server Configuration Tool===<br />
Maqq's command-line interface server configuration tool provides an interactive way of setting up a server:<br />
<br />
Download in the root KAG directory (C:\KAG or /kag_linux , in windows and linux respectively).<br />
*In Windows, run KAGServer.exe and follow the onscreen instructions.<br />
*In linux, make it executable via ''chmod +x sconfig.py'' and run with ''./sconfig.py'' . Daemonisation tools applicable to dedicatedserver.sh (''screen, tmux, nohup'' etc) still useable with this programme<br />
<br /><br />
;Reusing Generated Configs<br />
<br />
These commands reuse the generated configuration files:[http://kagforum.com/index.php?threads/maqqs-cli-server-configuration-tool.3121/#post-67046 ]<br />
<br />
*If you're using linux, type this in the console:<br />
''./KAGdedi autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br />
*If you're using windows, you should consider using the [GUI version], it lets you save the configuration into a file, but if you want to use the CLI version, type this in the command prompt:<br />
''KAG autostart Scripts/custom_autostart.gm autoconfig Scripts/custom_autoconfig.gm''<br />
<br /><br /><br />
==Download Maqq's Server Config Tool==<br />
*Windows (GUI): http://dl.dropbox.com/u/51067730/kag/KAGServer.exe<br />
*Windows (CLI): http://dl.dropbox.com/u/51067730/KAGServer.exe (has python included)<br />
*Linux/OSX (CLI-only): http://213.152.176.254/mirror/sconfig.py</div>EchoLynx//wiki.kag2d.com/wiki/User:EchoLynxUser:EchoLynx2012-02-20T21:38:18Z<p>EchoLynx: http://EchoLynx.com</p>
<hr />
<div>http://EchoLynx.com<br />
I have been running a KAG server since 20FEB2012.</div>EchoLynx