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 Runtime Environnement 1.5.x 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 a JRE 1.5 or higher installed on your server to run Jetrix. You can download it here :

http://java.sun.com/j2se/1.5.0/download.jsp

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.5.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="8080"/> </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 8080 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

Broadcast

Config

Emote

Goto

Help

Ip

Join

Kick

Language

List

Motd

Move

Operator

Pause

Ping

Random

Reply

Start

Stop

Summon

Teleport

Tell

Time

Version

Who

Valid XHTML 1.0! Valid CSS!