Jetrix SourceForge.net Logo
Open Source

User Guide

Table of Contents

  1. Installation
  2. Configuration
  3. Web Administration
  4. Command Reference

Installation

System Requirements

  • Linux, Windows, Solaris or MacOS X
  • Java 6 or higher
  • 32 Mb RAM
  • 5 Mb hard drive space
  • If you have a firewall, open the ports 31456, 31457 and 31458

Running & Upgrading

You need Java 6 or higher installed on your server to run Jetrix. You can download it on http://java.com

Unix

Once the Java Runtime Environnement is installed, you'll need a JAVA_HOME environnement variable pointing to your Java directory. For example on Linux you can add this line to your /etc/profile file:

export JAVA_HOME=/usr/java/jre_1.6.0

Then decompress the Jetrix archive to the installation directory:

tar -jxvf jetrix-x.y.z.tar.bz2

To start the server, type the following commands in the jetrix directory:

./jetrix

To start the server as a background process, type:

nohup ./jetrix &

Or even better if the screen tool is available on your system, type:

screen ./jetrix

To download the latest release and upgrade your version (experimental), type:

./update

Windows

Install the Java Runtime Environnement and then run the Jetrix installer (jetrix-x.y.z-installer.exe). This will create a "Jetrix TetriNET Server" group in your Start menu, just click on "Jetrix TetriNET Server" to start Jetrix, an icon will appear in the system tray:

You can click on this icon to open a menu and stop the server or open the administration console.

Configuration

Listeners

A listener is a component listening for network connections. It waits for connections on a specific port, for example the listener waiting for tspec clients listens on the port 31458. The listeners are declared in the server configuration under the <listeners> element:
<!-- Client listeners --> <listeners> <listener class="net.jetrix.listeners.TetrinetListener"/> <listener class="net.jetrix.listeners.TSpecListener"/> <listener class="net.jetrix.listeners.IRCListener" port="31456"/> <listener class="net.jetrix.listeners.HttpListener" port="31460"/> </listeners>

Services

Channels

Commands

Filters

Banlist

Web Administration

An administration console is integrated to Jetrix, you can use it with any modern browser to change most of the configuration without restarting the server. The console is available on the port 31460 of your server. You'll be prompted for a username and a password, just type in admin and the administrator password to enter (adminpass by default).

Command Reference

away

Set your away status.

Usage: /afk <message>
Aliases: [away, afk]
Access Level: Player

broadcast

Send a message to all clients on the server.

Usage: /br <message>
Aliases: [broadcast, br, gmsg, shout]
Access Level: Operator

config

Display the channel settings.

Usage: /config
Aliases: [config, conf, settings]
Access Level: Player

emote

Display an emote.

Usage: /me
Aliases: [emote, me]
Access Level: Player

goto

Go to the channel of the specified player.

Usage: /goto <player name>
Aliases: [goto, go]
Access Level: Player

help

List all commands available.

Usage: /help
Aliases: [help, ?, h]
Access Level: Player

ignore

Add or remove a player from the ignore list.

Usage: /ignore <player name|number>
Access Level: Player

ip

Display the IP of a player.

Usage: /ip <player name|number>
Access Level: Operator

join

Join or create a channel.

Usage: /join <channel name|number> <password>
Aliases: [join, j]
Access Level: Player

kick

Kick a player out of the server.

Usage: /kick <player name|number>
Aliases: [kick, disconnect]
Access Level: Operator

language

Set the language of the user.

Usage: /language <language code>
Aliases: [language, lang]
Access Level: Player

list

List available channels.

Usage: /list
Aliases: [list, l]
Access Level: Player

mode

Change the channel's configuration.

Usage: /mode <0-9>
Access Level: Player

motd

Display the message of the day.

Usage: /motd
Access Level: Player

move

Move a player to a new slot.

Usage: /move <player number> <slot number>
Access Level: Player

operator

Gain authenticated operator status.

Usage: /op <password>
Aliases: [operator, op]
Access Level: Player

pause

Pause or unpause the game.

Usage: /pause
Access Level: Operator

petition

Send a request for assistance to all operators online.

Usage: /petition <message>
Aliases: [petition, omsg]
Access Level: Player

ping

Display the ping to the server.

Usage: /ping
Access Level: Player

random

Display a random number.

Usage: /random <min> <max>
Aliases: [random, roll]
Access Level: Player

reply

Reply to the previous private message.

Usage: /reply <message>
Aliases: [reply, r]
Access Level: Player

speclist

Show the spectators in the channel

Usage: /speclist
Aliases: [speclist, slist]
Access Level: Player

start

Start the game.

Usage: /start <seconds>
Access Level: Player

stop

Stop the game.

Usage: /stop
Access Level: Operator

summon

Summon a player to the current channel.

Usage: /summon <player name>
Access Level: Operator

teleport

Teleport a player to another channel.

Usage: /teleport <player name|number> <channel name|number>
Aliases: [teleport, tp]
Access Level: Operator

tell

Send a private message to a player.

Usage: /tell <player name|number> <message>
Aliases: [tell, msg, cmsg, send]
Access Level: Player

time

Display the server's time.

Usage: /time
Aliases: [time, date]
Access Level: Player

tmsg

Send a message to the team.

Usage: /tmsg <message>
Aliases: [tmsg, gu]
Access Level: Player

version

Display the version of the server.

Usage: /version
Access Level: Player

who

List all players connected to the server.

Usage: /who
Aliases: [who, w, cwho]
Access Level: Player
Valid XHTML 1.0! Valid CSS!