summaryrefslogtreecommitdiffstats
path: root/games/tetrinetx/tetrinetx.rst
blob: 3a4b08bb042b5e1202fce66ab5b8e9070f3e09fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
.. RST source for tetrinetx(6) man page. Convert with:
..   rst2man.py tetrinetx.rst > tetrinetx.6

.. |version| replace:: 1.13.16+qirc_1.40c_15
.. |date| date::

=========
tetrinetx
=========

------------------------
server for tetrinet game
------------------------

:Manual section: 6
:Manual group: SlackBuilds.org
:Date: |date|
:Version: |version|

SYNOPSIS
========

/etc/rc.d/rc.tetrinetx [ **start** | **stop** | **restart** ]

DESCRIPTION
===========

**tetrinetx** provides a server for hosting TetriNET games. TetriNET
is a multiplayer variant of Tetris played over the internet. Up to
six people may simultaneously connect to a server to participate in
a game.

**tetrinetx** supports only the original TetriNET game mode, not the
TetriFAST mode. Clients attempting to connect with TetriFAST will be
immediately disconnected.

The actual **tetrinetx** binary should not normally be run
directly. Instead, use the startup script. If you want to start the
server at boot, include a call to it in your */etc/rc.d/rc.local*::

  if [ -x /etc/rc.d/rc.tetrinetx ]; then
    /etc/rc.d/rc.tetrinetx start
  fi

...and possibly in */etc/rc.d/rc.local_shutdown*::

  if [ -x /etc/rc.d/rc.tetrinetx ]; then
    /etc/rc.d/rc.tetrinetx stop
  fi

FILES
=====

All configuration is done via config files; there are no command-line
options (other than start/stop/restart, for the init script).

/etc/tetrinetx/game.conf
  The main config file for **tetrinetx**. Human-readable and editable,
  with explanatory comments.

/etc/tetrinetx/game.motd
  The "message of the day" shown to regular clients when they connect.

/etc/tetrinetx/game.pmotd
  Message shown to playback (spectator) service clients.

/etc/tetrinetx/game.secure
  Used to define passwords clients can send to authenticate as server
  admins. By default, nothing is defined here (everything is commented out).

/etc/tetrinetx/game.ban, game.allow, game.ban.compromise
  Controls who is allowed to connect to the server. These files don't
  ship with the package, but ".example" files are included to show you
  how they work.

/var/log/tetrinetx/game.log
  Log file for **tetrinetx**.

/var/games/tetrinetx/game.winlist, game.winlist2, game.winlist3
  Lists of game winners.

/var/run/tetrinetx/game.pid
  PID file for the daemon is normally stored here, although this can be
  changed in **game.conf**. The PID file is deleted when **tetrinetx**
  exits normally (including being killed with **SIGTERM**).
  The init script doesn't actually use the PID file.

NETWORK
=======

**tetrinetx** uses the following TCP ports:

31457
  Standard port used for tetrinet clients.

31456
  Query service. Supposedly can be connected to with a standard IRC client.
  See:

    /usr/doc/tetrinetx-|version|/README.qirc.spectators

31458
  "Playback" port, used for connecting as a spectator. **tetrinetx** must
  have a *query_password* set in **/etc/tetrinetx/game.secure** to enable
  spectator connections.

LIMITATIONS
===========

**tetrinetx** can only be compiled for *either* IPv4 *or* IPv6
support, not both. The SlackBuilds.org build allows choosing this at
build time.

COPYRIGHT
=========

See the file /usr/doc/tetrinetx-|version|/COPYING for license information.

AUTHORS
=======

**tetrinetx** was written by Brendan Grieve and Roongroj Phoophuangpairoj.

This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.

SEE ALSO
========

**gtetrinet**\(6)

The tetrinetx homepage: https://tetrinetx.sourceforge.net/