1CYPHESIS(1) cyphesis CYPHESIS(1)
2
6 cyphesis - cyphesis game server process
7
9 /usr/bin/cyphesis [ --section:option=value... ]
10
12 The cyphesis program implements the core world server for WorldForge.
13
15 Configuration options are divided up into named sections, which need to
16 be specified when modifying or overriding the options. In a config file
17 the name of a section is specified in square brackets at the beginning
18 of the section. On the command line the section is given at the begin‐
19 ning of the option specification, as shown in the synopsis above.
20 SERVER OPTIONS
22 The following options are present in the cyphesis section of the config
23 file, and overriden by specifying the cyphesis section name on the com‐
24 mand line.
25 directory="/path/to/server/data"
27 Directory where server data and scripts can be found.
28 Name of the top level ruleset this server should use.
30 Normally this directory is set at compile time, but in some rare
32 cases it may be necessary to tell cyphesis to use a different
33 directory.
34 confdir="/path/to/server/config"
36 Directory where server config can be found.
37 Normally this directory is set at compile time, but in some rare
39 cases it may be necessary to tell cyphesis to use a different
40 directory.
41 vardir="/path/to/server/var"
43 Directory where temporary files can be stored.
44 Normally this directory is set at compile time, but in some rare
46 cases it may be necessary to tell cyphesis to use a different
47 directory.
48 ruleset="mason"
50 Ruleset name.
51 Name of the top level ruleset this server should use.
53 Rulesets are hierarchical, so it is very probable that the top
55 level ruleset will depend on another ruleset. In order to spec‐
56 ify the that ruleset depends on another ruleset, a section is
57 required in the config file with the name of the ruleset, which
58 contains an additional ruleset option. On startup the server
59 will look for dependent rulesets until it reaches a ruleset
60 which has no dependencies, at which point it is assumed the base
61 ruleset has been found.
62 For example, the mason ruleset depends on the basic ruleset, but
64 the basic ruleset has no dependencies. The required configura‐
65 tion entries for this arrangement look like this:
66 [cyphesis]
68 ruleset="mason"
69 [mason]
70 ruleset="basic"
71 servername=hostname
75 Server name.
76 Name that identifies this server. If this option is ommited from
78 the config file, and not provided any other way, then the system
79 hostname will be used.
80 tcpport=6767
82 Network listen port for TCP connections.
83 Specifies the port number to use to listen for incoming client
85 connections.
86 unixport="cyphesis.sock"
88 Local liston socket for Unix domain connections.
89 Specifies the filename to use to listen for local trusted client
91 connections.
92 restricted=false
94 Flag to control restricted mode.
95 If this option is true the server is run in restricted mode.
97 This means that clients will not be able to create new accounts,
98 leaving account creation entirelu in the hands of the adminis‐
99 trator.
100 usemetaserver=true
102 Flag to control use of metaserver.
103 If this flag is true the server registers its presence with a
105 metaserver.
106 metaserver="metaserver.worldforge.org"
108 Hostname to use as metaserver.
109 The hostname is used as the address of the metaserver where the
111 presence of this server is registered if the usemetaserver
112 option is enabled.
113 daemon=false
115 Flag to control daemon mode.
116 If this flag is true the server automatically drop into the
118 background after startup. For convenience the parent process
119 will not complete until the server has completed its setup,
120 including reading all config information, loading all data from
121 the database, setting up internal data structures and setting up
122 communications. The exit status of the parent process indicates
123 whether these steps were completed successfully.
124 useaiclient=false
126 Flag to control use of AI client.
127 If this flag is true the server does not attempt to do any AI
129 simulation internally, and instead relies on a specialist AI
130 client. This feature is not yet implemented.
131 dbserver
133 Remote hostname for the PostgreSQL RDBMS.
134 If this setting is present the server will use a remote instance
136 of the PostgreSQL RDBMS for its database requirements at the
137 hostname provided. Do not use this setting unless you need a
138 remote database for some reason. Specify "localhost" will cause
139 the database module to use remote connection even though the
140 connection is to the local machine.
141 dbname="cyphesis"
143 Name of database to use.
144 This setting provides the database name the server is to use for
146 its data. If this setting is omitted, the name cyphesis is
147 used.
148 dbuser Database account name for access.
150 This setting provides the username to be used to authenticate
152 with the database. If it is not included, the username of the
153 user running the server is used.
154 dbpasswd
156 Database account password for access.
157 This setting provides the password to be used to authenticate
159 with the database. PostgreSQL does not usually require a pass‐
160 word when connecting to a PostgreSQL RDBMS on the same system as
161 the server, when the database username to be used is the same as
162 the user running the server. If this is the case then the set‐
163 ting must be omitted from the config file.
164
166 Written by Alistair Riddoch.
167
169 Report bugs to <general@worldforge.org>.
170
172 Copyright 2004 Alistair Riddoch.
173
175 cyclient(1), cyphesis-tools(1), cycmd(1)
176 10 December 2010 CYPHESIS(1)