Orbz Dedicated Server Overview
----------------------------------

These are some instructions for setting up a dedicated Orbz server. If you have trouble getting your server up and runnindg correctly, check in the Orbz forums on GarageGames for answers or to leave support questions:

Orbz Forums are linked in your Orbz start menu program group.
Shortcuts for launching and Orbz Server and the settings file are also linked in the start menu.


----------------------------------

Question: What's an Admin and what can the Admin do in Orbz?

Answer: An Admin can ban and kick other players from a dedicated
server. You can set yourself as Admin to a dedicated server if you
know the password by hitting the tilde (~) key and typing:

sad(password);

where 'password' is the administrator password assigned to the
dedicated server.  If you are currently an Admin, you can change the admin password by typing:

sadpassword(newpassword);

where 'newpassword' is the new password.

Refer to admin.txt for a full list of administrator commands.

----------------------------------

Question: How do I configure a dedicated server?

Answer: You will need to edit the serverprefs.cs file that is located in the common/server directory. The following is a list of variables that can be set for the dedicated server. The server name and passwords are most likely the only values you will want to alter from their default values:

$Pref::Server::Name = "Orbz Server";
Dedicated server name of your choice. You can change it to whatever you would like.

$Pref::Server::Password = "";
Password that will need to be provided by a player wishing to join the dedicated server.

$Pref::Server::Port = 28000;
This port needs to be open to the internet to allow play. This value should work fine, but you may change it to suit your needs.

$Pref::Server::AdminPassword = "admin01";
Password necessary to set player as an Admin of the dedicated server.

$Pref::Server::MaxPlayers = 10;
Maximum number of players allowed in the dedicated server.  10 players is the maximum currently supported by orbz.  If you set it higher, it will be reset to 10.

$Pref::Server::BanTime = 1800;
Amount of time in seconds that a banned player must wait before
rejoining the dedicated server.

$Pref::Server::ConnectionError = "You do not have the correct version\nof the Orbz to connect to this server.";
It is recommended that you do not change this message. It is an
informational message in the case that a player fails to connect to the dedicated server.

$Pref::Server::FloodProtectionEnabled = 0;
If this value is set to 1, players will not be able to continually
produce text message or play voice cues. You might want to set this to 1 if people are really getting annoying, but in general it is fine at 0. If they are too annoying, consider kicking or banning, instead.

$Pref::Server::MaxChatLen = 120;
Do not change this value. Maximum number of characters that can be
sent during, either in the Lobby or in-game. Note that this is not the line length you see in the game or Lobby, so changing this value won't change those lengths.

$Pref::Server::RegionMask = 2;
Do not change this value. Currently, there are no other regions, so changing this value could prevent players from seeing the dedicated server.

$Pref::Server::DisplayOnMaster = "Always";
This controls whether your server will be displayed on the master
server lists.  If set to Always, players on the internet will be able to see your server, although they may not be able to connect if your firewall is blocking UDP ports around 28000.

Set this to "Never" to prevent your server from being displayed on the master lists.  Good for private LAN servers or servers without an Internet connection.

$Pref::Server::BotStartingLevel = 2;
Sets the starting difficulty level of Botz in Multi-player games.  
Valid starting levels are 1-4.

$Pref::Server::BotAutoLevel = 1;
Sets whether Botz will auto-adjust their difficulty level between matches.
Set this to 0 to disable the feature.

$Pref::Server::BotTauntFrequency = 10;
Controls how often Botz will use voice taunts.  Valid numbers are 0-100.

----------------------------------

Question: How do I start the dedicated server on my Windows machine?

Answer: Start orbz with the following command line:

Orbz -prefs ~/server/serverprefs.cs -dedicated
(linked in the start menu)

Note: the "common" directory prefix is omitted from the -prefs parameter.  This is intentional.
----------------------------------

Question: Can I run multiple Orbz dedicated servers on one machine?

Answer: Yes you can, but make sure that your CPU is powerful enough to handle it.  You can check this by using the Task Manager in Windows to measure CPU usage.  In order to run multiple instances, you will also need multiple server preference files (mentioned above). For example, you might create serverprefs1.cs and serverprefs2.cs with different names and different port numbers.  Then you would need to run the dedicated server twice, pointing to each of the preference files, like this:

Orbz -prefs ~/server/serverprefs1.cs -dedicated

and

Orbz -prefs ~/server/serverprefs2.cs -dedicated

Note that you must run each instance of the Orbz Dedicated Server on different ports.

----------------------------------

Question: Where is the banned player list at?

Answer: The list is in the banlist.cs file that is located in the
common/server directory.

----------------------------------

Question: Where do I go for more information on Orbz?

Answer: Official customer support for Orbz is handled via web forums located at:

http://www.garagegames.com/pg/product/view.php?id=5
(scroll down to the Customer Support section for a link to the forums)

Finally, if you have an IRC client, we also have a channel set up on irc.maxgaming.net (or www.maxgaming.net) called #orbz.  Feel free to stop by and discuss anything Orbz.

