Subsections

Advanced features

Server: start a server

You can run a Hogs server on your own if you don't know of any other running ones or you simply want to choose your own settings. It can be started with the following command:

hogs server [SERVER_NAME] [MAX_PLAYERS] [MAP_NAME] [MAP_DIR]

All arguments are optional:

Arg Meaning Default
SERVER_NAME The name of the server, viewed by remote clients pinging it RenameMe
MAX_PLAYERS The maximum number of players which can connect to a server. The fewer players connected, the better performance (generally speaking). 6
MAP_NAME The map to load first. mountains_small
MAP_DIR The location where maps are stored. You probably don't need to change this. PREF/data/maps/ (PREF is where you installed Hogs).

Admin: remotely control a server

You can issue a limited set of command to control a remotely running server as long as you are an authenticated administrator OR the person who started the server.

Defining administrators

Admins are defined by username in a file in the server's data directory (PREF/data/authorized-admins). Any one who tries to administer a server using a user name in this file will be allowed to; anybody else will not.

The username of the person who ran the server is automatically added to the list of authorized admins when the server boots up, regardless of whether their name is in the authorized-admins file.

Using admin commands

The game browser has a limitd GUI interface for shutting down a remote server and booting players. It's fairly self-explanatory.

To issue admin commands from the console, use:

hogs admin HOSTNAME COMMAND [COMMAND_ARG]

where HOSTNAME is the address of a machine on which the server is running, and the commands are described below:

shutdown Shuts down the server [REASON] a message to send to all clients
mapchange Changes the current map MAP, the name of the map to change to (NOT including .pnm extension).
boot Boots a specified player by id number ID, the unique id of the player to boot (obtained by pinging).
broadcast Sends a message to all users in the game MESSAGE, the messages to send.

The argument is required for every command except for shutdown.

Hogs Project 2005-05-15