redeclipse-server(6)

1REDECLIPSE-SERVER(6)          Red Eclipse Manual          REDECLIPSE-SERVER(6)
2
3
4

NAME

6       redeclipse-server - script to launch the server for the Red Eclipse FPS
7       game
8
9
10

SYNOPSIS

12       redeclipse-server [-hhomedir] [-ppackagedir] [-osauerdir] [-glogfile]
13
14                         [-ss{0..3}] [-skjoinpass] [-sPadminpass]
15                         [-sldefaultmap] [-x"command(s)"]
16
17                         [-siserverip] [-spserverport] [-smservermaster]
18                         [-saservermasterport] [-suserveruprate]
19
20                         [-ms{0|1}] [-mimasterip] [-mpmasterport]
21
22                         [--help] [-v{0..4}]
23
24
25

DESCRIPTION

27       Red Eclipse is a single-player and multi-player first-person ego-
28       shooter, built as a total conversion of Cube Engine 2, which lends
29       itself toward a balanced gameplay, with a general theme of agility in a
30       variety of environments.
31
32       redeclipse-server is a script which executes the redeclipse-server
33       binary from the /usr/libexec/redeclipse directory.
34
35       The recommended way to change the settings of the server is to create
36       and edit the file servinit.cfg in your home directory. Examples are
37       available in /usr/share/doc/redeclipse/examples/
38
39
40

OPTIONS

42   Filesystem options
43       -hhomedir
44              Sets your home directory to homedir.  This is where servinit.cfg
45              is read from, it defaults to $HOME/.redeclipse/.
46
47
48
49       -ppackagedir
50              Includes the data files found in packagedir.  Can be used
51              for adding additional maps that may be distributed to
52              clients. By default redeclipse-server only includes data
53              files in the working directory /usr/share/redeclipse/data
54              and in the subdirecory temp of the home directory.
55
56
57       -osauerdir
58              Sets the path to your Sauerbraten directory. If the Red
59              Eclipse server can find your Sauerbraten directory, it
60              will be able to load and distribute maps from it.
61
62
63       -glogfile
64              Output log to logfile.  Path is set relative to homedir
65              unless a leading ´/' is used, uses stdout if -g is given
66              without a parameter. Defaults to stdout.
67
68
69   Server configuration options
70       -ss{0..3}
71              Sets server type. 0 for local only, 1 for private, 2 for
72              public, 3 for dedicated. Defaults to 1.
73
74
75       -skjoinpass
76              Sets the join password to joinpass.  Users must know the
77              password before they can connect.
78
79
80       -sPadminpass
81              Sets the admin password to adminpass.
82
83
84       -scmaxclients
85              Sets the maximum number of clients to maxclients.
86
87
88       -sldefaultmap
89              Sets default map to defaultmap.
90
91
92       -x"command 1; command 2; ..."
93              Executes a list of commands once the Red Eclipse server
94              has started up.
95
96
97   Server connection options
98       -siserverip
99              Binds the server to the host address serverip.  Only
100              needed for machines with more than one interface.
101
102
103       -spserverport
104              sets the server port to serverport.
105
106
107       -smservermaster
108              Uses servermaster as the master server, defaults to
109              play.redeclipse.net.
110
111
112       -saservermasterport
113              Contacts the master server using port servermasterport,
114              defaults to 28800.
115
116
117       -suserveruprate
118              Caps upstream rate to serveruprate.  Once the cap is hit
119              it will likely cause major connection glitching and
120              disconnects. Use maxclients for bandwitch limiting
121              instead.
122
123
124   Master server options
125       -ms{0|1}
126              Enables the server to act as a master server, defaults to
127              0.
128
129
130       -mimasterip
131              Binds the master server to the host address masterip.
132              Only needed for machines with more than one interface,
133              defaults to localhost.
134
135
136       -mpmasterport
137              Binds the master server to the host port masterport,
138              defaults to 28800.
139
140
141   General options
142       --help Display this manpage
143
144
145       -v{0..4}
146              Sets verbosity. This affects how much information is
147              printed to the console. 0 is the least verbose, 4 is the
148              most verbose.
149
150
151

EXAMPLES

153       redeclipse-server -p$HOME/mod/data -ss0 -slbath -sPpass
154           Loads data from an additional directory, sets the server
155           type to local (LAN), sets the default map to "bath" and sets
156           the admin password to "pass"
157
158       redeclipse-server -h$HOME/redeclipse-server_configs/
159           Reads and writes the configuration files to the specified
160           directory instead of $HOME/.redeclipse/.
161
162
163

AUTHORS

165       Red Eclipse's main developers are Quinton "quin" Reeves and Lee
166       "eihrul" Salzman
167
168       This manual page was written by Martin Erik Werner
169       <martinerikwerner@gmail.com>
170
171
172

HISTORY

174       Red Eclipse was forked as a continuation of the game
175       Bloodfrontier, which in turn was based on the Cube2 engine and
176       the Sauerbraten game. Red Eclipse and Sauerbraten are now
177       developed in parallel.
178
179
180