1CYCMD(1) cyphesis CYCMD(1)
2
6 cycmd - cycmd game server process
7
9 cycmd [ --section:option=value ... ] [ command [ server ] ]
10
13 The cycmd program provides a commandline interface to a cyphesis
14 server.
15
17 Configuration options are divided up into named sections, which need to
18 be specified when modifying or overriding the options. In a config file
19 the name of a section is specified in square brackets at the beginning
20 of the section. On the command line the section is given at the begin‐
21 ning of the option specification, as shown in the synopsis above.
22 CLIENT OPTIONS
24 The following options used by cycmd are present in the client section
25 of the config file, and overriden by specifying the client section name
26 on the command line.
27 serverhost=hostname
29 Hostname of the server to connect to.
30 This setting provides the hostname of the system where cyphesis
32 is running that cycmd should try and connect to.
33 SERVER OPTIONS
35 The following options are present in the cyphesis section of the config
36 file, and overriden by specifying the cyphesis section name on the com‐
37 mand line. These options apply to the server, but are also required by
38 the client to ensure that the client can connect.
39 tcpport=6767
41 Network port for server TCP connections.
42 Specifies the port number to use when connecting to the server.
44 unixport="cyphesis.sock"
46 Local liston socket for Unix domain connections.
47 Specifies the filename to use to listen for local trusted client
49 connections.
50
52 connect hostname
53 Connect the server to a peer.
54 Try and establish a connection to a peer server.
56 get typename
58 Examine a type on the server.
59 Get a type description from the server, and display its con‐
61 tents. The type information is typically either an entity
62 class, or an operation definition.
63 help Display online help.
65 Lists all the commands available, with a short description of
67 what each one does.
68 install type_id parent_id
70 Install a new type in the server.
71 look Return a view of the current server lobby.
74 Look at the current server lobby, where all users currently
76 logged in are represented. The view is returned and displayed.
77 logout [ account ]
79 Examine a type on the server.
80 Get a type description from the server, and display its con‐
82 tents. The type information is typically either an entity
83 class, or an operation definition.
84 monitor
86 Enable server monitoring.
87 Direct the server to report all in-game operations to the
89 client. A digest of each operation is displayed, including the
90 type, which entity the operation is from and which entity the
91 operation is to.
92 query entity_id
94 Examine an in-game entity.
95 Get an in-game entity description from the server, and display
97 its contents.
98 stat Examine the current server status.
100 Get a description of the current server status, and display its
102 contents.
103 unmonitor
105 Disable server monitoring.
106 Direct the server to stop reporting all in-game operations to
108 the client.
109
111 The first example shows getting the current server status and checking
112 the lobby to see if any users are logged in.
113 cyphesis> stat
115 Info(
116 builddate: 11:32:45, Sep 27 2004
117 clients: 1
118 name: calcitration.ecs.soton.ac.uk
119 objtype: obj
120 parents: [ server ]
121 ruleset: mason
122 server: cyphesis
123 uptime: 1728.2
124 version: 0.3.2
125 )
126 cyphesis> look
127 Sight(
128 id: lobby
129 name: lobby
130 objtype: obj
131 parents: [ room ]
132 people: [ 1 ]
133 rooms: [ ]
134 )
135 cyphesis>
136 The first entity returned shows various information about the server,
139 including when it was built, the number of connected client, the cur‐
140 rent ruleset, and the server uptime. The second entity representing the
141 lobby shows that only one user is current logged in, and no chat rooms
142 have been created.
143 The second example shows how to install a new type.
145 cyphesis> get thing
147 Info(
148 children: [ feature character plant food stackable structure arm arrow axe barrel block_house board boat boundary bow campfire cleaver coin fire gallows house lumber pelvis ribcage shin skull stall sword thigh tower twobyfour wall weather ]
149 contains: [ ]
150 id: thing
151 loc:
152 name:
153 objtype: class
154 parents: [ game_entity ]
155 pos: [ 0 0 0 ]
156 stamp_contains: 0
157 velocity: [ 0 0 0 ]
158 )
159 cyphesis> install box thing
160 cyphesis>
161 The third example shows server monitoring being enable, followed by
164 information of a series of in-game operations. The flow of messages in
165 while monitoring the server can be large. In order to supress the flow,
166 the unmonitor command must be used.
167 cyphesis> monitor
169 cyphesis>
170 tick(from="900006",to="900006")
171 tick(from="900007",to="900007")
172 cyphesis>
173 tick(from="900008",to="900008")
174 cyphesis>
175 tick(from="899982",to="899982")
176 cyphesis>
177 tick(from="899356",to="899356")
178 cyphesis>
179 tick(from="899357",to="899357")
180 cyphesis>
181 tick(from="899358",to="899358")
182 cyphesis>
183 tick(from="899359",to="899359")
184 cyphesis>
185 tick(from="899360",to="899360")
186 cyphesis>
187 tick(from="899361",to="899361")
188 cyphesis>
189
192 Written by Alistair Riddoch.
193
195 Report bugs to <general@worldforge.org>.
196
198 Copyright 2004 Alistair Riddoch.
199
201 cyphesis(1), cyclient(1), cyphesis-tools(1)
202 22 October 2006 CYCMD(1)