annotate dgl/dgamelaunch.conf @ 47:1951f59156e4

Mention dependencies in README.txt.
author John "Elwin" Edwards
date Sat, 08 Mar 2014 14:36:11 -0800
parents 46158c89c659
children 955c2fd68dcf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
1 # This is a sample dgamelaunch configuration file. Only bash-style comments
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
2 # are allowed, such as this. Each configuration option will be explained
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
3 # along with its default value.
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
4
14
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
5
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
6
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
7 # Global config variables:
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
8
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
9
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
10 # Max amount of registered users to allow. Has no effect if dgl was
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
11 # compiled with SQLite
24
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
12 maxusers = 64000
14
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
13
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
14 # Allow registration of new nicks? (yes or no)
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
15 allow_new_nicks = yes
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
16
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
17 # Max length for newly registered nicks. Must be less than 20.
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
18 # By default, NetHack only stores the first 10 chars of a name into
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
19 # the record/logfile.
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
20 maxnicklen = 10
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
21
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
22 # Set the default watching-screen sorting mode. Can be one of
24
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
23 # "username", "game", "windowsize", "starttime" or "idletime".
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
24 # "username" is the default.
14
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
25 sortmode = "username"
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
26
24
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
27 # Set the columns displayed in the watching-screen. Each column definition
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
28 # must have four elements as:
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
29 # [ "<display title>", "<sortname>", <Screen column>, "<printf format>" ]
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
30 #
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
31 # <sortname> may be "unsorted", "username", "game", "windowsize", "starttime",
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
32 # "duration", "idletime", or (if shmem is enabled) "watchers".
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
33 #
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
34 watch_columns = [ ["", "", 1, "%s)"],
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
35 ["User", "username", 4, "%-15s"],
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
36 ["Game", "game", 21, "%-11s"],
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
37 ["Term", "windowsize", 34, "%s"],
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
38 ["Idle", "idletime", 43, "%-10s"],
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
39 ["Started", "starttime", 60, "%s"]
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
40 ]
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
41
14
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
42 # Path to a prepared chroot jail.
24
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
43 chroot_path = "/var/dgl"
14
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
44
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
45 # From inside the jail, dgamelaunch's working directory for rcfiles/ttyrec/etc
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
46 dglroot = "/dgldir/"
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
47
24
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
48 # Strings to be replaced in every banner
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
49 # you can have either direct string replacements, like
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
50 # "$FOO" = "BAR", or you can get the server time with
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
51 # "$FOO" = timeformat("%F %T")
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
52 # for the timeformat parameter string format, see man strftime
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
53 bannervars = [ "$MOTDTIME" = "2011.10.08",
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
54 "$SERVERID" = "$ATTR(14)Roguelike Gallery - rlgallery.org$ATTR()",
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
55 "$DATETIME" = timeformat("%F %T")
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
56 ]
14
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
57
24
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
58 # From inside the jail, location of a banner file, which is
14
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
59 # shown in submenus that cannot be defined separately.
24
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
60 # Some string substitution is done for every banner file contents:
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
61 # - bannervars from above
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
62 # - $VERSION replaced with "dgamelaunch v" + dgl version number.
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
63 # - $USERNAME replaced with logged-in user's name, or with "[Anonymous]"
ce26225f7d9d Switch to the Git version of dgamelaunch.
John "Elwin" Edwards
parents: 15
diff changeset
64 # - $INCLUDE(filename) the named file will be inserted here.
14
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
65 banner = "/dgldir/dgl-banner"
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
66
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
67 # The following two options are fairly insecure. They will force us to
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
68 # load the password/group database into memory while still having root
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
69 # privileges. Replace them with shed_uid/shed_gid entries as soon as
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
70 # possible if you decide to use them. dgamelaunch will inform you of
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
71 # the uids/gids corresponding to your choices when it loads.
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
72 #
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
73 # Note that shed_uid and shed_gid will always take precedence over
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
74 # shed_user and shed_group if they are specified.
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
75
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
76 # shed_user: username to shed privileges to
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
77 #shed_user = "games"
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
78 # shed_group: group name to shed privileges to
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
79 #shed_group = "games"
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>
parents:
diff changeset
80
9945b472aac2 Add dgamelaunch configuration to the project.
John "Elwin" Edwards <elwin@sdf.org>