5 .. Copyright (c) 2004-2018 Jeremy Stanley <fungi@yuggoth.org>.
6 Permission to use, copy, modify, and distribute this software is
7 granted under terms provided in the LICENSE file distributed with
18 Each item in the dict identifies options for the default backing
19 file of the group named in its key. The value is itself a dict with
20 its keys and values corresponding to those options (for now, only
21 ``flags`` is implemented, with a value of ``private`` indicating it
22 should be readable only by the system user under which the mudpy
37 This is the root path beneath which all relative file references,
38 including directories comprising the search path, are assumed to be
39 found. The default value of ``.`` indicates the current working
40 directory at the time the service was initially started.
44 .mudpy.filing.prefix: .
51 Directories to search for expected data files. If not a fully
52 canonical path, this is assumed to be relative to the ``prefix``.
67 This is the default directory where new data files will be written
68 if their full paths are not specified and they aren't already found
69 in the ``search`` list. If not a fully canonical path, this is
70 assumed to be relative to the ``prefix``.
74 .mudpy.filing.stash: data
79 .mudpy.linguistic.actions
80 ~~~~~~~~~~~~~~~~~~~~~~~~~
84 This is used to tailor the appearance of output generated by the
85 ``say`` command and its relatives, so as to add some readability and
86 flavor. It matches a visible action to punctuation (ask, exclaim, et
91 .mudpy.linguistic.actions:
101 .mudpy.linguistic.default_punctuation
102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 Unpunctuated statements made by actors should be assumed to
107 terminate with this value.
111 .mudpy.linguistic.default_punctuation: .
113 .mudpy.linguistic.typos
114 ~~~~~~~~~~~~~~~~~~~~~~~
118 Replacements for common typographical and capitalization errors.
122 .mudpy.linguistic.typos:
139 The first users to create accounts with names in this list will
140 automatically be given full administrative privileges.
152 This is the maximum number of avatars allowed for each account.
156 .mudpy.limit.avatars: 7
163 This is the number of backups to keep and rotate when overwriting
164 data files. If unspecified or set to 0, no backup copies will be
169 .mudpy.limit.backups: 10
171 .mudpy.limit.password_tries
172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
176 This is the maximum number of password failures allowed during the
177 login process. Once exceeded, the user will be disconnected.
181 .mudpy.limit.password_tries: 3
191 If set, log messages will be recorded to this file.
195 .mudpy.log.file: var/mudpy.log
202 Number of log entries to keep in memory (the oldest are
203 discarded)... If unset or 0, none will be written to mudpy's
208 .mudpy.log.lines: 1000
215 If set to ``yes``, messages will be logged to the standard output of
216 the mudpy process. If unspecified, the default is ``no``.
220 .mudpy.log.stdout: true
227 If set, mudpy will send messages to the system log, and under the
228 name specified by this value (Unix derivatives only).
232 .mudpy.log.syslog: mudpy
237 .mudpy.movement.*.enter_term
238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
242 Word or words describing the direction from where you are seen to
243 enter the next room when moving.
247 .mudpy.movement.down.enter_term: above
248 .mudpy.movement.east.enter_term: the west
249 .mudpy.movement.north.enter_term: the south
250 .mudpy.movement.south.enter_term: the north
251 .mudpy.movement.up.enter_term: below
252 .mudpy.movement.west.enter_term: the east
254 .mudpy.movement.*.exit_term
255 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
259 Word or words describing the direction where you are seen to exit
260 the current room when moving.
264 .mudpy.movement.down.exit_term: downward
265 .mudpy.movement.east.exit_term: to the east
266 .mudpy.movement.north.exit_term: to the north
267 .mudpy.movement.south.exit_term: to the south
268 .mudpy.movement.up.exit_term: upward
269 .mudpy.movement.west.exit_term: to the west
271 .mudpy.movement.*.vector
272 ~~~~~~~~~~~~~~~~~~~~~~~~
276 Vector of signed integer units for use in vector addition to derive
277 the destination coordinates from the current coordinates when moving
278 through a gridlink exit. The example coordinate system used is left
279 handed (east, north and up are positive, west, south and down are
280 negative) and three-dimensional with a tuple component order of
281 (longitude, latitude, altitude).
285 .mudpy.movement.down.vector: [0, 0, -1]
286 .mudpy.movement.east.vector: [1, 0, 0]
287 .mudpy.movement.north.vector: [0, 1, 0]
288 .mudpy.movement.south.vector: [0, -1, 0]
289 .mudpy.movement.up.vector: [0, 0, 1]
290 .mudpy.movement.west.vector: [-1, 0, 0]
300 The IP address on which to listen. If unspecified, the default is
301 all available addresses.
305 .mudpy.network.host: ::1
312 The TCP port on which to listen.
316 .mudpy.network.port: 4000
321 .mudpy.process.daemon
322 ~~~~~~~~~~~~~~~~~~~~~
326 If set to ``yes``, mudpy will immediately fork and detach a child to
327 become a daemon process, then close all open file descriptors and
328 terminate the parent process (Unix derivatives only). The default
333 .mudpy.process.daemon: true
335 .mudpy.process.pidfile
336 ~~~~~~~~~~~~~~~~~~~~~~
340 If set, this filename will contain the daemon's process ID (Unix
345 .mudpy.process.pidfile: var/mudpy.pid
350 .mudpy.timing.idle.disconnect.*
351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
355 This value indicates the number of increments allowed to pass
356 without input on a socket connection before it is terminated. This
357 avoids accumulation of dead sockets which could otherwise max out
358 allowed file descriptors. The differentiators are either ``default``
359 or a state name used to override the default value for that specific
360 state (``active``, ``entering_account_name``, et cetera).
364 .mudpy.timing.idle.disconnect.active: 6048000
365 .mudpy.timing.idle.disconnect.default: 6000
366 .mudpy.timing.idle.disconnect.entering_account_name: 600
368 .mudpy.timing.idle.warn.*
369 ~~~~~~~~~~~~~~~~~~~~~~~~~
373 This value indicates the number of increments allowed to pass
374 without input on a socket connection before it is warned that
375 termination is imminent. The differentiators are either
376 ``default`` or a state name used to override the default value
377 for that specific state. It is recommended that this be less than
378 the corresponding ``.mudpy.timing.idle.disconnect.*`` value.
382 .mudpy.timing.idle.warn.active: 5040000
383 .mudpy.timing.idle.warn.default: 5000
384 .mudpy.timing.idle.warn.entering_account_name: 500
386 .mudpy.timing.increment
387 ~~~~~~~~~~~~~~~~~~~~~~~
391 This value indicates the number of real system clock seconds (or
392 more commonly, fraction thereof) each pass through the main loop is
393 intended to take. This roughly sets the frequency with which queued
394 socket I/O operations are performed, pending events are triggered,
395 and directly impacts the speed at which virtual time passes within
400 .mudpy.timing.increment: 0.1
407 Number of increments between updates of changed persistent data
412 .mudpy.timing.save: 600
419 Number of increments to wait between logging mudpy status messages.
420 If unspecified or set to 0, no mudpy status messages will be
425 .mudpy.timing.status: 6000