update episode 3 documentation

README.md

@@ -175,15 +175,14 @@ All quests, including those originally in GCI or DLQ format, are treated as onli
 
 ### Episode 3 features
 
-The following Episode 3 features work:
+The following Episode 3 features work well:
+* CARD battles. Not every combination of abilities has been tested yet, so if you find a feature or card ability that doesn't work like it's supposed to, please make a GitHub issue and describe the situation (the attacking card(s), defending card(s), and ability or condition that didn't work).
+* Tournaments. (But they don't work like Sega's tournaments did - see below)
 * Downloading quests.
-* Creating and joining games.
 * Trading cards.
 * Participating in card auctions. (The auction contents must be configured in config.json.)
-* Tournaments. (See below)
 
 The following Episode 3 features are implemented, but are only partially tested:
-* CARD battles. Almost everything works, but there may be minor behavioral bugs. If you find a feature or card ability that doesn't work, please make a GitHub issue and describe the situation (including the attacking card(s), defending card(s), and ability or condition that didn't work).
 * Spectator teams. There is a known issue that prevents viewing battles unless you're in the spectator team when the battle begins, and spectating clients sometimes crash for an unknown reason.
 * Battle replays also sometimes cause the client to crash during the replay. Using the $playrec command is therefore not recommended.
 

system/config.example.json

@@ -1,5 +1,9 @@
 {
-  // Configuration file for newserv. This file is standard JSON with comments.
+  // 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
+  // specified in hexadecimal using the 0x prefix.
 
   // Server's name (maximum 16 characters). This appears in the upper-right
   // corner of the screen while in lobbies.
@@ -268,9 +272,7 @@
   // 0x00000008 => Disable overall and per-phase battle time limits, regardless
   //               of the values chosen during battle rules setup
   // 0x00000010 => Enable debug messages in Episode 3 games and battles
-  // 0x00000020 => Load card text as well as card definitions (has no behavioral
+  // 0x00000020 => This flag is used internally and has no effect on battles
-  //               effects in games; this flag exists to be used internally when
-  //               the --show-ep3-data option is given)
   // 0x00000040 => Enable battle recording (after a battle, players can save the
   //               recording with the $saverec <filename> command)
   // 0x00000080 => Disable command masking during battles
@@ -279,15 +281,18 @@
   "Episode3BehaviorFlags": 0x00000002,
 
   // Episode 3 card auction configuration. CardAuctionPoints specifies how many
-  // points each player gets when they join an auction (may be anywhere from 0
+  // points each player gets when they join an auction (this may be anywhere
-  // to 65535, but a somewhat-low number is generally good). CardAuctionSize
+  // from 0 to 65535, but a somewhat-low number is generally good).
-  // specifies how many cards will be present in each auction; if this is a
+  // CardAuctionSize specifies how many cards will be present in each auction;
-  // list, then the number of cards is random in the specified range. Finally,
+  // this can be an integer if auctions should always have the same number of
-  // CardAuctionContents is a dictionary specifying the relative frequencies and
+  // cards, or it can be a list of [min count, max count] and the server will
-  // costs of each card in the auction pool. Relative frequencies are 64-bit
+  // choose a random number of cards in that range for each auction.
-  // integers, but should generally be less than 0x0100000000000000 to avoid
+  // CardAuctionContents is a dictionary specifying the relative frequencies
-  // excessive bias. There is no fixed summation bound for relative frequencies.
+  // and costs of each card in the auction pool. Relative frequencies are
-  // Cards are always drawn (with replacement) from the same distribution.
+  // 64-bit integers, but should generally be less than 0x0100000000000000 to
+  // avoid excessive bias. All relative frequencies must sum to a number less
+  // than 0x10000000000000000 (the limit of an unsigned 64-bit integer). Cards
+  // are drawn (with replacement) from the distribution specified here.
   "CardAuctionPoints": 30,
   "CardAuctionSize": [2, 4],
   "CardAuctionPool": {
@@ -304,11 +309,6 @@
   // enable Episode 3 patches by default; it only does so if this option is on.
   // "EnableEpisode3SendFunctionCall": true,
 
-  // Whether to enable certain exception handling. Disabling this is generally
-  // only useful for debugging newserv itself, and it should usually be left on
-  // (which is the default behavior).
-  "CatchHandlerExceptions": true,
-
   // By default, the server keeps track of items in all games, even for versions
   // other than Blue Burst. This enables use of the $what command, as well as
   // protection against item duplication cheats (the cheater is disconnected
@@ -316,4 +316,10 @@
   // be turned off here. This option has no effect on Blue Burst games - item
   // tracking is always enabled for them.
   "EnableItemTracking": true,
+
+  // Whether to enable certain exception handling. Disabling this causes
+  // newserv to abort when any client causes an exception, which is generally
+  // only useful for debugging newserv itself. This setting should usually be
+  // left on (which is the default behavior).
+  "CatchHandlerExceptions": true,
 }