Addventure 2.1 Administration
Game parameters
newgame options
- -filepath UNIX_path_to_files (mandatory)
-
- -urlpath URL_files_are_at (mandatory)
-
- -binpath URL_CGI_scripts_are_in (mandatory)
-
- -backlink (default)
- -nobacklink
-
- -listlinks (default for games created under 2.0)
- -nolistlinks (default for new games)
- (Added in version 2.1)
- -linkdefault
- -nolinkdefault (default)
-
- -evilhtml
- -noevilhtml (default)
-
- -mailsig (default)
- -nomailsig
-
- -cleanup seconds_to_leave_room_open
(default = 1 day)
-
- -goback
- -nogoback
- -singlegoback (default)
-
- -title game_title (optional)
-
- -roomw room_word (default = "room")
-
- -maxopt maximum_number_of_options (default = infinite)
- (Added in version 2.1)
- -mailhelper path_to_helper_script (default = none)
- (Added in version 2.1)
- -listhelper path_to_helper_script (default = none)
- (Added in version 2.1)
options.addv
Bold is the Option name, Italics indicate the newgame parameter (if any)
that can set it
- version
- The version number the game was created under. Set automatically.
- DateStarted
- The date the game was started. Set automatically.
- Game
- (Added in version 2.1) Binary setting. Is the game
running or turned off?
- FilePath
- -filepath
- Text setting
- URLPath
- -urlpath
- Text setting
- BinPath
- -binpath
- Text setting
- Backlink
- -backlink sets it to on
- -nobacklink set it to off
- Binary setting
- ListLinks
- -listlinks sets it to on
- -nolistlinks sets it to off
- (Added in version 2.1) Binary setting
- LinkDefault
- -linkdefault sets it to on
- -nolinkdefault sets it to off
- Binary setting
- EvilHTML
- -evilhtml sets it to on
- -noevilhtml sets it to off
- Binary setting
- Mailsig
- -mailsig sets it to on
- -nomailsig set it to off
- Binary setting
- Cleanup
- -cleanup
- Text setting
Used by the timeout scripts.
- Goback
- -goback sets it to on
- -nogoback sets it to off
- -singlegoback sets it to single
- Trinary setting
- MaxOpt
- -maxopt
- (Added in version 2.1) Text setting
- RoomW
- -roomw
- Text setting
- MailHelperProg
- -mailhelper
- (Added in version 2.1) Text setting
- ListHelperProg
- -listhelper
- (Added in version 2.1) Text setting
- Title
- -title
- Text setting
- Contact
- Text setting. The email address for the administrator.
- file-where-loc or
file-error-err-loc
- (Added in version 2.1) Text setting.
A file to be inserted verbatim, or a
program whose output is to be inserted verbatim.
- where
- What programs are expected to use this file. Legal values are
textentry, readyentry, and optentry
- err
- What kind of error this message is printed for.
Legal values are
unknown, locked,
invalid_target, not_exist,
empty, html,
exists, finished,
nonextroom, opt_overload,
address, and closed
- loc
- Where to print the message. Legal values are
head and foot
- applet-elements
- (Added in version 2.1) Text setting.
A space separated list of elements that are present in the applet
tag. The BODY, WIDTH, and HEIGHT tags are mandatory. Others are
optional. (This is an advisory tag only - Addventure may try
to determine other element's values.) This tag is required for
the applet tag to be added.
- applet-element-elem
- (Added in version 2.1) Text setting.
Within the applet tag, the element elem will take on the
assigned value. (This is an advisory tag only - Addventure may
assign its own values to elements.)
- applet-parameters
- (Added in version 2.1) Text setting.
A space separated list of the NAME values in param tags.
- applet-parameter-param
- (Added in version 2.1) Text setting.
Within the param tag, the name x-param will take on the
assigned value.
- debug
- (Added in version 2.1) Text setting.
A space separated list of components that should print debugging
information. Each entry is substring compared to the component
name for a match.
- spacecheck
- (Added in version 2.1) Binary setting.
Should spacecheck be run? If you turn the game off, you should
probably turn spacecheck off as well (or just not run the script).
- spacecheck-level and
spacecheck-i-level
- (Added in version 2.1) Text setting.
Numeric value when the game should go into the level indicated.
Used by the spacecheck.pl program.
- level
-
Legal values are warning and critical
timeout
Command Line Parameters
Options:
- -filepath UNIX_path_to_files (mandatory)
-
- -urlpath URL_files_are_at (mandatory)
-
- -binpath URL_CGI_scripts_are_in (mandatory)
-
- -room room_number (mandatory)
-
- -force (optional)
- Set if room should be cleaned even if it has not
timed out.
- -ignoreoff (optional)
- Set if room should be cleaned even if the game is
not running.
Using the 'timeout-all.sh' program
Set the following variables the same way you ran them with newgame:
The following variables point to programs:
- BASENAME - the location of the standard basename utility
- TIMEOUT - the location of the Addventure timeout program.
The timeout-all.sh program is usually run from
cron.
Using 'cron'
Linux, SunOS, and SysV systems
Create a file with lines in the format:
minute hour day_of_month month day_of_week command and parameters
p
comments may be preceeded by a #. "Wildcard" values may be filled
in with a *.
Install them, so they may be processed and used, with the command
-
- crontab -r filename
where filename is the name of the file that contains the cron data.
Some examples:
- Run daily at 1am
- * 1 * * * /home/asf/src/addventure/version-2.0/timeout-all.sh
- Run almost constantly
- 0-59 * * * * /home/asf/src/addventure/version-2.0/timeout-all.sh
- Run every Monday at 3am
- * 3 * * 1 /home/asf/src/addventure/version-2.0/timeout-all.sh
spacecheck