|
2
|
1 (9/19/94:Brandon)
|
|
|
2
|
|
|
3 QUICK INSTALLATION
|
|
|
4
|
|
|
5 To install the server onto your system, do the following:
|
|
|
6
|
|
|
7 1. Change your working directory to src/
|
|
|
8 2. execute the script called 'setup'
|
|
|
9 3. follow the instructions, no guarantees!
|
|
|
10 4. execute 'make install'
|
|
|
11
|
|
|
12 If you have the expected directory structure (as created in the 2.4
|
|
|
13 release) and you are on a common operating system, everything should
|
|
|
14 install appropriately. Read on for instructions on administrating
|
|
|
15 the server.
|
|
|
16
|
|
|
17 ADMINISTRATION
|
|
|
18
|
|
|
19 The server expects several files to be available in the appropriate
|
|
|
20 locations. These locations are based off a root level which is
|
|
|
21 specified with an environment variable of NETREKDIR (Note: if the
|
|
|
22 NETREKDIR environment variable does not exist, some scripts and
|
|
|
23 binaries may check for "../etc/conf.netrekdir" to specify the full
|
|
|
24 path). The following is an explanation of the different files and
|
|
|
25 directories.
|
|
|
26
|
|
|
27 backups/ - This is where the dbbackup script places
|
|
|
28 it's files.
|
|
|
29 bin/ - where the binaries and various scripts are
|
|
|
30 located:
|
|
|
31 daemonII - the daemon binary.
|
|
|
32 dbbackup - database backup script
|
|
|
33 faucet + - used in combination with pl to create the
|
|
|
34 player listing port, not required. It is
|
|
|
35 not distributed with the server (it is
|
|
|
36 part of Rob Forsman's NetPipes).
|
|
|
37 init.shutdown - callable by the system (shutdown)
|
|
|
38 init.startup - callable by the system (startup)
|
|
|
39 listen - the listen process binary
|
|
|
40 mailcluecheck - the script used to mail letters to ejected
|
|
|
41 people, if MAIL_CLUELETTER is defined in
|
|
|
42 config.h
|
|
|
43 makemotd - builds a message of the day with player stats
|
|
|
44 mes + - tool used by ntstop, not required.
|
|
|
45 ntserv - ntserv binary
|
|
|
46 ntstart - script to startup the server
|
|
|
47 ntstop - script to shutdown the server (with message)
|
|
|
48 pl + - tool used to give a listing of players
|
|
|
49 robotII - robot binary, if it doesn't exist no robots
|
|
|
50 will enter the game.
|
|
|
51 snake - snake binary, if it doesn't exist no snakes
|
|
|
52 will enter the game.
|
|
|
53 docs/ - where documents are stored.
|
|
|
54 etc/ - the location of files used by the various
|
|
|
55 binaries and scripts.
|
|
|
56 ALLOW - if this file exists the server will ignore
|
|
|
57 conf.hours as well as DENY and will always
|
|
|
58 allow access.
|
|
|
59 DENY - if this file exists and ALLOW does not exist
|
|
|
60 the server will ignore conf.hours and will
|
|
|
61 always be closed.
|
|
|
62 clue.letter - the form letter used by mailcluecheck
|
|
|
63 cluephrases - the cluephrases file, if it doesn't exist the
|
|
|
64 server will use a builtin list of phrases.
|
|
|
65 conf.hours - hour configuration file (access)
|
|
|
66 conf.netrekdir - hardcoded NETREKDIR path.
|
|
|
67 conf.pics - configuration file for motd pictures.
|
|
|
68 the format is:
|
|
|
69
|
|
|
70 <picture location>
|
|
|
71 <X> <Y> <page>
|
|
|
72
|
|
|
73 the picture location is based off NETREKDIR.
|
|
|
74 X and Y coordinates are explanatory, the page
|
|
|
75 is which page in the MOTD it should appear on.
|
|
|
76 conf.sysdef - the system configuration file.
|
|
|
77 db.global - database, globals.
|
|
|
78 db.players - database, players.
|
|
|
79 motd - the message of the day. Pages in the motd
|
|
|
80 are seperated by:
|
|
|
81
|
|
|
82 [newline][tab]@@b
|
|
|
83
|
|
|
84 motd.body - the body of the motd (without highscores),
|
|
|
85 used by makemotd to create the actual motd.
|
|
|
86 planets - planets file.
|
|
|
87 rsa.keys - a list of rsa keys (ignore without RSA).
|
|
|
88 logs/
|
|
|
89 conquer - a record of all conquers on the server.
|
|
|
90 daemonII.pid - a log of the current daemonII's process ID
|
|
|
91 eject.log - a log of ejections via mailcluecheck
|
|
|
92 god.log - a log of all messages sent to GOD
|
|
|
93 listen.pid - a log of the current listen's process ID
|
|
|
94 server.log - a log of the daemon and generic server messages
|
|
|
95 startup.log - a startup log from ntserv and daemonII processes
|
|
|
96 pics/ - where motd pictures can be located.
|
|
|
97 pped/ - Heath Kehoe's player database editor.
|
|
|
98 rsa/ - the RSA files, these are not required for
|
|
|
99 server execution.
|
|
|
100 src/ - source code for the server.
|
|
|
101
|
|
|
102 Note that the person who occupies player entry 0 in the player file
|
|
|
103 will *always* be given the rank of Emperor, so make sure the first
|
|
|
104 entry always has a password.
|
|
|
105
|
|
|
106 OPTIONS
|
|
|
107
|
|
|
108 Options can be found in most binaries with the '-h' flag.
|
|
|
109
|
|
|
110 To manually connect a client to the server first run the client
|
|
|
111 and tell it which socket to try:
|
|
|
112
|
|
|
113 netrek.paradise -s <socket, such as 7777>
|
|
|
114
|
|
|
115 On the server machine, enter:
|
|
|
116
|
|
|
117 ntserv -s <same socket> -d <the display the client is on>
|
|
|
118
|
|
|
119 CONTROLS
|
|
|
120
|
|
|
121 The server has some online controls which are available to the
|
|
|
122 administrators, but only if they have the correct royalty. The
|
|
|
123 first person to be in the database file (0) is always the 'Emperor',
|
|
|
124 which is the highest royalty status. As an Emperor the player
|
|
|
125 can use the online controls.
|
|
|
126
|
|
|
127 To use the controls you send yourself a message. To get a current
|
|
|
128 list of controls available send yourself 'help' and then try help
|
|
|
129 on each topic listed, such as 'control help'.
|
|
|
130
|
|
|
131 Note: be cautious on using any of the controls which modifies actual
|
|
|
132 gameplay variables during Tmode. These modifications will be recorded
|
|
|
133 into the database and will have a global effect on all statistics
|
|
|
134 (for instance, do not give 1000 armies to a player as they will
|
|
|
135 inevitably be dooshed in 10 seconds).
|
|
|
136
|
