]> git.pond.sub.org Git - empserver/blobdiff - doc/econfig
client: Unbreak standalone build
[empserver] / doc / econfig
index b130c4c77a0e179447db2b6a5137555a25821482..794d814e5d8428f0c9f8abc0961795f9736b163a 100644 (file)
@@ -30,7 +30,7 @@ For instance,
 configures the data directory to that place, and
     port "7777"
 configures the empire port to 7777,
-  btu_build_rate 0.0004
+    btu_build_rate 0.0004
 configures the BTU build rate, and so on.
 
 The programs look for the config file in a compiled-in location, which
@@ -69,18 +69,21 @@ pconfig econfig2 > e2 && mv e2 econfig2
 
 which will fill in all the missing keys and values with their defaults.
 
+You define your update schedule in the schedule file, in the same
+directory as your econfig.  See doc/schedule for details.
+
 Additional customization is possible through key custom_tables, which
 is a list of files containing tables in xdump format (see doc/xdump
 for technical information on xdump).  To customize a table, copy the
 default table from the directory given by econfig key builtindir to a
-file next to your econfig, then add the file to custom_keys.  Do *not*
-edit the default table in-place!
+file next to your econfig, then name the file in custom_tables.  Do
+*not* edit the default table in-place!  That bypasses important
+consistency checks.
 
-The server lets you customize more tables than the ones in builtindir.
-This is not recommended at this time.  You can use the xdump command
-to dump the default table to a file.  The resulting table is in
-machine-readable form, and may not be portable between different
-server versions.
+A word of caution: Just because you can customize something doesn't
+mean you should!  The server makes an effort to catch mistakes that
+could crash the game.  It has no chance to catch mistakes that
+unbalance it.
 
 
 Coder information
@@ -111,7 +114,7 @@ econfig parser.
 3. Use the variable in your code.  This normally looks like
 
          if (opt_DUMB) {
-            pr("You're being dumb\n");
+             pr("You're being dumb\n");
          } else {
-            pr("You're being really dumb\n");
+             pr("You're being really dumb\n");
          }