update some documentation

README.md

@@ -90,13 +90,13 @@ newserv supports several versions of PSO. Specifically:
 | GC Ep3 Trial   | Yes          | Yes          | Yes          | Yes          |
 | GC Ep3         | Yes          | Yes          | Yes          | Yes          |
 | XBOX Ep1&2     | Untested (2) | Untested (2) | Untested (2) | Untested (2) |
-| BB (vanilla)   | Yes          | Yes          | Partial (3)  | Yes          |
+| BB (vanilla)   | Yes          | Yes          | Yes (3)      | Yes          |
-| BB (Tethealla) | Yes          | Yes          | Partial (3)  | Yes          |
+| BB (Tethealla) | Yes          | Yes          | Yes (3)      | Yes          |
 
 *Notes:*
 1. *DC support has only been tested with the US versions of PSO DC. Other versions probably don't work, but will be easy to add support for. Please submit a GitHub issue if you have a non-US DC version, and can provide a log from a connection attempt.*
 2. *newserv's implementations of these versions are based on disassembly of the client executables and have never been tested.*
-3. *Some basic features are not implemented in Blue Burst games, so the games are not very playable. A lot of work has to be done to get BB games to a playable state.*
+3. *BB games are mostly playable, but there are still some unimplemented features (for example, some quests that use rare commands may not work). Please submit a GitHub issue if you find something that doesn't work.*
 4. *Support for PSO Dreamcast Trial Edition and the December 2000 prototype is somewhat incomplete and probably never will be complete. These versions are rather unstable and seem to crash often, but it's not obvious whether it's because they're prototypes or because newserv sends data they can't handle.*
 
 ## Setup

system/config.example.json

@@ -2,20 +2,24 @@
   // Configuration file for newserv.
 
   // This file is standard JSON with C-style comments. Some other extensions to
-  // the JSON standard are also supported; for example, integers may be
+  // the JSON standard are also supported; notably, integers may be specified in
-  // specified in hexadecimal using the 0x prefix. If you use a text editor that
+  // hexadecimal using the 0x prefix. If you use a text editor that auto-formats
-  // auto-formats JSON on save, it may be confused by this file's format. Make
+  // JSON on save, it may be confused by this file's format. Make sure it
-  // sure it doesn't automatically turn hex integers into strings, for example.
+  // doesn't automatically turn hex integers into strings, for example.
 
   // Server's name (maximum 16 characters). This appears in the upper-right
   // corner of the screen while in lobbies.
   "ServerName": "newserv",
 
-  // Address to connect local clients to (IP address or interface name)
+  // Address to connect local clients to (IP address or interface name). This
+  // is the address that newserv will expect clients on the same network as the
+  // server to conenct to.
   "LocalAddress": "en0",
-  // Address to connect external clients to (IP address or interface name). If
+  // Address to connect external clients to (IP address or interface name). This
-  // you're running newserv behind a NAT, this should be your router's
+  // is the address that newserv will expect clients not on the same network as
-  // public-facing address.
+  // the server to connect to. If you're running newserv behind a NAT (this
+  // applies to most home networks), this should be your router's public-facing
+  // IP address.
   "ExternalAddress": "10.0.1.5",
 
   // Port to listen for DNS queries on. To disable the DNS server, comment this
@@ -80,7 +84,7 @@
     // - If you have any DC, GC, or XB clients connecting to the server, the
     //   console-lobby port must be defined. The version for this port should be
     //   "gc", even though DC and XB clients can connect to it (newserv will
-    //   automatically detect the correct game version).
+    //   automatically detect the correct game version for each client).
     // - If you have any PC clients connecting to the server, the pc-lobby port
     //   must be defined.
     // - If you have any BB clients connecting to the server, the bb-lobby,
@@ -117,8 +121,9 @@
   "IPStackListen": [],
 
   // Other servers to support proxying to. If this is empty for any game
-  // version, the proxy server is disabled for that version. Entries are like
+  // version, the proxy server is disabled for that version. Entries in these
-  // "name": "address:port"; the names are used in the proxy server menu.
+  // dictionaries should be of the form "name": "address:port"; the names are
+  // used in the proxy server menu.
   "ProxyDestinations-DC": {},
   "ProxyDestinations-PC": {},
   "ProxyDestinations-GC": {},