add missing quest files

CMakeLists.txt

@@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.10)
 
 project(newserv)
 
-set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
 if (MSVC)
     add_compile_options(/W4 /WX)
@@ -90,6 +90,7 @@ set(SOURCES
     src/GSLArchive.cc
     src/GVMEncoder.cc
     src/HTTPServer.cc
+    src/IntegralExpression.cc
     src/IPFrameInfo.cc
     src/IPStackSimulator.cc
     src/IPV4RangeSet.cc
@@ -105,8 +106,8 @@ set(SOURCES
     src/Map.cc
     src/Menu.cc
     src/NetworkAddresses.cc
-    src/PatchServer.cc
     src/PatchFileIndex.cc
+    src/PatchServer.cc
     src/PlayerFilesManager.cc
     src/PlayerSubordinates.cc
     src/ProxyCommands.cc
@@ -115,7 +116,6 @@ set(SOURCES
     src/PSOGCObjectGraph.cc
     src/PSOProtocol.cc
     src/Quest.cc
-    src/IntegralExpression.cc
     src/QuestScript.cc
     src/RareItemSet.cc
     src/ReceiveCommands.cc
@@ -136,7 +136,7 @@ set(SOURCES
 )
 
 if(resource_file_FOUND)
-    set(SOURCES ${SOURCES} src/ARCodeTranslator.cc)
+    set(SOURCES ${SOURCES} src/AddressTranslator.cc)
 endif()
 
 add_executable(newserv ${SOURCES})

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Martin Michelsen
+Copyright (c) 2024 Martin Michelsen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -18,4 +18,3 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

README.md

@@ -12,6 +12,7 @@ See TODO.md for a list of known issues and future work I've curated, or go to th
 * Background
     * [History](#history)
     * [Other server projects](#other-server-projects)
+    * [Using newserv in other projects](#using-newserv-in-other-projects)
 * [Compatibility](#compatibility)
 * Setup
     * [Server setup](#server-setup)
@@ -62,7 +63,14 @@ Independently of this project, there are many other PSO servers out there. Those
 * (2019) **[Mechonis](https://gitlab.com/sora3087/mechonis)**: A PSOBB server with a microservice architecture written in TypeScript by TrueVision.
 * (2021) **[Phantasmal World](https://github.com/DaanVandenBosch/phantasmal-world)**: A set of PSO tools, including a web-based model viewer and quest builder, and a PSO server, written by Daan Vanden Bosch.
 * (2021) **[Elseware](http://git.sharnoth.com/jake/elseware)**: A PSOBB server written in Rust by Jake.
-* (2022) **[PSOSERVER](https://github.com/Sancaros/PSOSERVER)**: A server for all versions, written in C by Sancaros and based on Sylverant and newserv.
+
+## Using newserv in other projects
+
+There is a fair amount of code in this project that could potentially be useful to other projects. You are free to use code from newserv in your own open-source projects; the only condition is that the contents of the LICENSE file must be included in your project if you use code from newserv. Your project does not also have to use the MIT license; you can use any license you want.
+
+If you want to use parts of newserv in your project, there are two easy ways to do so with proper licensing:
+* If you're using a lot of code from newserv, you can put a copy of newserv's LICENSE file in your repository alongside your own license file, or include the contents of newserv's license in your own license file.
+* If you're only using a few files from newserv, you can copy and paste the contents of the LICENSE file into a comment at the beginning of each copied file.
 
 # Compatibility
 
@@ -183,9 +191,13 @@ The version of PSO PC I have has the server addresses starting at offset 0x29CB3
 
 ### PSO GC on a real GameCube
 
-You can make PSO connect to newserv by setting its default gateway and DNS server addresses in network settings to newserv's address. newserv's DNS server must be running on port 53 and must be accessible to the GameCube.
+You can make PSO connect to newserv by setting the default gateway and DNS server addresses in the game's network settings to newserv's address. newserv's DNS server must be running on port 53 and must be accessible to the GameCube. If you're not playing PSO Plus or Episode III, this should be all you need to do, assuming you already set LocalAddress in config.json to your PC's private IP address.
 
-If you have PSO Plus or Episode III, it won't want to connect to a server on the same local network as the GameCube itself, as determined by the GameCube's IP address and subnet mask. In the old days, one way to get around this was to create a fake network adapter on the server (or use an existing real one) that has an IP address on a different subnet, tell the GameCube that the server is the default gateway (as above), and have the server reply to the DNS request with its non-local IP address. To do this with newserv, just set LocalAddress in the config file to a different interface. For example, if the GameCube is on the 192.168.0.x network and your other adapter has address 10.0.1.6, set newserv's LocalAddress to 10.0.1.6 and set PSO's DNS server and default gateway addresses to the server's 192.168.0.x address. This may not work on modern systems or on non-Windows machines - I haven't tested it in many years.
+If you have PSO Plus or Episode III, it won't want to connect to a server on the same local network as the GameCube itself, as determined by the GameCube's IP address and subnet mask. There are a couple of ways to get around this.
+
+Sodaboy described a fairly easy method, which is to forward the PSO and DNS ports in your router's configuration to your PC's private IP address (the PSO ports are in config.json, and are all TCP; the DNS port is 53 and is UDP). Then, set LocalAddress and ExternalAddress in config.json to your external IP address (from e.g. whatismyip.com). Most routers will let you connect to your public IP address even from within the local network, but the GameCube will think it's connecting to a different network, so it won't reject the connection. If you're concerned about security and don't want your server to be publicly accessible, you can use Windows Firewall or UFW on Linux block incoming connections on the ports you opened, except for connections from the IP addresses you specify.
+
+Another method is to use two network interfaces on the same PC, and tell the GameCube to connect to the one that appears to be on a different network. For example, if your GameCube is on the 10.0.0.x subnet and your PC's address is 10.0.0.5, you can create a fake network adapter on your PC (or use an existing real one) that has an IP address on a different subnet than the GameCube, such as 192.168.0.8. Then, in PSO's network config, set the default gateway and DNS server addresses to 192.168.0.8, and set LocalAddress in config.json to 192.168.0.8, and PSO should connect. This is what I did back in the old days when I primarily developed software on Windows, but I haven't tried it in many years.
 
 ### PSO GC on a Wii or Wii U
 
@@ -193,7 +205,7 @@ Using a Wii or Wii U to connect to newserv requires the Wii or vWii to be softmo
 
 Nintendont includes BBA emulation and is compatible with all PSO GameCube versions except Episodes I&II Trial Edition. To use Nintendont, enable BBA emulation in Nintendont's settings and follow the instructions in the above section (PSO GC on a real GameCube).
 
-Devolution includes modem emulation and is compatible with all PSO GameCube versions including Episodes I&II Trial Edition. newserv can act as a PPP server, which Devolution can directly cnnect to. To do this:
+Devolution includes modem emulation and is compatible with all PSO GameCube versions including Episodes I&II Trial Edition. newserv can act as a PPP server, which Devolution can directly connect to. To do this:
 1. Enable the PPPRawListen option according to the comments in config.json.
 2. Start newserv.
 3. In the game's network settings, set the username and password to anything (they cannot be blank), and set the phone number to the number that newserv outputs to the console during startup. (It will be near the end of all the startup log messages.) If your Wii is on the same network as newserv, use the local number; otherwise, use the external number.
@@ -204,9 +216,9 @@ If you're using the HLE BBA type, set the BBA's DNS server address to newserv's
 
 If you're using the TAP BBA type, you'll have to set PSO's network settings appropriately for your tap interface. Set the DNS server address in PSO's network settings to newserv's IP address.
 
-If you're using a version of Dolphin with tapserver support, you can make it connect to a newserv instance running on the same machine via the tapserver interface. You do not need to install or run tapserver. To do this:
-1. Set Dolphin's BBA type to tapserver (Config -> GameCube -> SP1).
-2. Enable newserv's IP stack simulator according to the comments in config.json and start newserv.
+If you're using the tapserver BBA or modem type, you can make it connect to a newserv instance running on the same machine via the tapserver interface. To do this:
+1. In the GameCube pane of the Config window, set the SP1 device to Broadband Adapter (tapserver) or Modem Adapter (tapserver).
+2. Set IPStackListen (for BBA) or PPPStackListen (for modem) according to the comments in config.json and start newserv.
 3. In PSO's network settings, enable DHCP ("Automatically obtain an IP address"), set DNS server address to "Automatic", and leave DHCP Hostname as "Not set". Leave the proxy server settings blank.
 4. Start an online game.
 
@@ -214,9 +226,12 @@ If you're using a version of Dolphin with tapserver support, you can make it con
 
 The PSO BB client has been modified and distributed in many different forms. newserv supports most, but not all, of the common distributions. Unlike other versions, it's important that the client and server have the same map files, so make sure to set up the patch directory based on the client you'll be using with newserv. (See the "Client patch directories" section for instructions on setting this up.)
 
-The original Japanese and US versions of PSO BB should work (the last Japanese release can be found [here](https://archive.org/details/psobb_jp_setup_12511_20240109/)), but you'll have to modify your hosts file or edit psobb.exe to point to your newserv instance. The original versions are packed with various versions of ASProtect, so this is a more involved process than simply opening the executable in a hex editor and finding/replacing some strings.
+The original Japanese and US versions of PSO BB work with newserv (the last Japanese release can be found [here](https://archive.org/details/psobb_jp_setup_12511_20240109/)). To get them to connect to your server, do one of the following:
+* Use a drop-in patcher like [AzureFlare](https://github.com/Repflez/AzureFlare).
+* Modify your hosts file to redirect the client's destination address to localhost or your server's address.
+* Edit psobb.exe to point to your newserv instance. The original clients are packed with various versions of ASProtect, so this is a more involved process than simply opening the executable in a hex editor and finding/replacing some strings.
 
-Alternatively, you can use the Tethealla client ([English](https://web.archive.org/web/20240402011115/https://ragol.org/files/bb/TethVer12513_English.zip) / [Japanese](https://web.archive.org/web/20240402013127/https://ragol.org/files/bb/TethVer12513_Japanese.zip)); you can find the connection addresses starting at 0x56D724 in psobb.exe. Overwrite these addresses with your server's hostname or IP address, and you should be able to connect. If the server is on the same PC as the client and you don't plan to have any external players, these Tethealla clients will automatically connect to the server without any modifications.
+Alternatively, you can use the Tethealla client ([English](https://web.archive.org/web/20240402011115/https://ragol.org/files/bb/TethVer12513_English.zip) or [Japanese](https://web.archive.org/web/20240402013127/https://ragol.org/files/bb/TethVer12513_Japanese.zip)). If the server is on the same PC as the client and you don't plan to have any external players, these Tethealla clients will automatically connect to the server without any modifications. This version of the client is not packed, and you can find the connection addresses starting at 0x56D724 in psobb.exe. Overwrite these addresses with your server's hostname or IP address, and you should be able to connect.
 
 ### Connecting external clients
 
@@ -324,6 +339,32 @@ All versions of PSO can see and interact with each other in the lobby. newserv a
 
 In V1/V2 cross-version play, when any of the server drop modes are used, the server uses the drop table corresponding to the version the game was created with. (For example, if a DC V1 player created the game, rare-table-v1.json will be used, even after V2 players join.)
 
+## Server-side saves
+
+newserv has the ability to save character data on the server side. For PSO BB, this is required of course, but this feature can also be used on other PSO versions.
+
+Each account has 4 BB character slots and 16 non-BB character file slots. The non-BB slots are independent of the BB slots, and can be accessed with the `$savechar <slot>` and `$loadchar <slot>` commands (slots are numbered 1 through 16). `$savechar` copies the character you're currently playing as and saves the data on the server, and `$loadchar` does the reverse, overwriting your current character with the data saved on the server. Note that you can load a character that was saved from a different version of PSO, which allows you to easily transfer characters between games. On v1 and v2, changes done by `$loadchar` will be undone if you join a game; to permanently save your changes, disconnect from the lobby after using the command.
+
+There is a third command, `$bbchar <username> <password> <slot>`, which behaves similarly to `$savechar` but writes the character data to a BB character slot in a different account instead (slots are numbered 1 through 4). This can be used to "upgrade" a character to BB from an earlier version.
+
+Exactly which data is saved and loaded depends on the game version:
+
+| Game                 | Inventory | Character | Options/chats | Quest flags | Bank | Battle/challenge |
+|----------------------|-----------|-----------|---------------|-------------|------|------------------|
+| PSO DC v1 prototypes | Yes       | Yes       | No            | No          | No   | N/A              |
+| PSO DC v1            | Yes       | Yes       | No            | No          | No   | N/A              |
+| PSO DC v2            | Yes       | Yes       | Yes           | Yes         | Yes  | Yes              |
+| PSO PC (v2)          | Yes       | Yes       | No            | No          | No   | Save only        |
+| PSO GC NTE           | Yes       | Yes       | Yes           | Yes         | Yes  | Yes              |
+| PSO GC (not Plus)    | Yes       | Yes       | Yes           | Yes         | Yes  | Yes              |
+| PSO GC Plus (1)      | Save only | Save only | No            | No          | No   | Save only        |
+| PSO GC Ep3 (1)       | No        | Save only | No            | No          | No   | Save only        |
+| PSO Xbox             | Yes       | Yes       | Yes           | Yes         | Yes  | Yes              |
+| PSO BB               | Yes       | Yes       | Yes           | Yes         | Yes  | Yes              |
+
+*Notes*:
+1. *If EnableSendFunctionCallQuestNumber is enabled in config.json, then $savechar and $loadchar can save and restore all character data on these versions, just like on GC non-Plus. Episode 3 characters exist in a separate namespace; that is, you can't use $savechar and $loadchar to convert an Ep3 character to non-Ep3, or vice versa.*
+
 ## Episode 3 features
 
 newserv supports many features unique to Episode 3:
@@ -355,13 +396,14 @@ Episode 3 state and game data is stored in the system/ep3 directory. The files i
 * card-text.mnr: Compressed card text archive. Generally only used for debugging.
 * card-text.mnrd: Decompressed card text archive; same format as TextCardE.bin. Generally only used for debugging.
 * com-decks.json: COM decks used in tournaments. The default decks in this file come from logs from Sega's servers, so the file doesn't include every COM deck Sega ever made - the rest are probably lost to time.
-* maps/: Online free battle and quest maps (.mnm/.bin/.mnmd/.bind files). newserv comes with all the original online and offline maps, including Story Mode quests. If you don't want the offline maps and quests to be playable online, delete the .bind files system/ep3/maps.
+* maps/: Online free battle and quest maps (.mnm/.bin/.mnmd/.bind files). newserv comes with the default online maps, as well as some fan-made variations and quests to help new players get up to speed.
 * maps-download/: Download maps and quests (.mnm/.bin/.mnmd/.bind files). There are two subcategories by default (download maps and Trial Edition download maps), but you can add more by editing QuestCategories in config.json. Categories that have flag 0x40 (Ep3 download) set are indexed from this directory; all others are indexed from system/quests/. Files in maps-download/ subdirectories have the same format as those in the maps/ directory, but should be named like `e###-gc3-LANGUAGE.EXT` (similar to how non-Episode 3 quests are named in the system/quests/ directory). If you want a map to be available for online play and for downloading, the file must exist in both maps/ and in a maps-download/ subdirectory (a symbolic link is acceptable).
+* maps-offline/: Offline map files. These are all the offline quests and free battle maps from the client, including some debugging/test maps that were inaccessible during normal play. To make them playable online, put the files in the maps/ directory.
 * tournament-state.json: State of all active tournaments. This file is automatically written when any tournament changes state for any reason (e.g. a tournament is created/started/deleted or a match is resolved).
 
-There is no public editor for Episode 3 maps and quests, but the format is described fairly thoroughly in src/Episode3/DataIndexes.hh (see the MapDefinition structure). You'll need to use `newserv decompress-prs ...` to decompress .bin or .mnm files before editing them, but you don't need to compress the files again to use them - just put the .bind or .mnmd file in the maps directory and newserv will make it available.
+There is no public editor for Episode 3 maps and quests, but the format is described fairly thoroughly in src/Episode3/DataIndexes.hh (see the MapDefinition structure). You'll need to use `newserv decompress-prs ...` to decompress a .bin or .mnm file before editing it, but you don't need to compress it again to use it - just put the .bind or .mnmd file in the maps directory and newserv will make it available.
 
-Like quests, Episode 3 card definitions, maps, and quests are cached in memory. If you've changed any of these files, you can run `reload ep3-data` in the interactive shell to make the changes take effect without restarting the server.
+Like quests, Episode 3 card definitions, maps, and quests are cached in memory. If you've changed any of these files, you can run `reload ep3-cards` or `reload ep3-maps` in the interactive shell to make the changes take effect without restarting the server.
 
 ## Memory patches, client functions, and DOL files
 
@@ -371,48 +413,48 @@ You can put assembly files in the system/client-functions directory with filenam
 
 The VERS token in client function filenames refers to the specific version of the game that the client function applies to. Some versions do not support receiving client functions at all. The specific versions are:
 
-| Game              | VERS | Supported |
-|-------------------|------|-----------|
-| PSO DC NTE        | 1OJ1 | No        |
-| PSO DC 11/2000    | 1OJ2 | No        |
-| PSO DC 12/2000    | 1OJ3 | No        |
-| PSO DC 01/2001    | 1OJ4 | No        |
-| PSO DC v1 JP      | 1OJF | No        |
-| PSO DC v1 US      | 1OEF | No        |
-| PSO DC v1 EU      | 1OPF | No        |
-| PSO DC 08/2001    | 2OJ5 | Yes       |
-| PSO DC v2 JP      | 2OJF | Yes       |
-| PSO DC v2 US      | 2OEF | Yes       |
-| PSO DC v2 EU      | 2OPF | Yes       |
-| PSO PC (v2)       | 2OJW | No        |
-| PSO GC NTE        | 3OJT | Yes       |
-| PSO GC v1.2 JP    | 3OJ2 | Yes       |
-| PSO GC v1.3 JP    | 3OJ3 | Yes       |
-| PSO GC v1.4 JP    | 3OJ4 | Yes       |
-| PSO GC v1.5 JP    | 3OJ5 | No        |
-| PSO GC v1.0 US    | 3OE0 | Yes       |
-| PSO GC v1.1 US    | 3OE1 | Yes       |
-| PSO GC v1.2 US    | 3OE2 | No        |
-| PSO GC v1.0 EU    | 3OP0 | Yes       |
-| PSO GC Ep3 NTE    | 3SJT | Yes       |
-| PSO GC Ep3 JP     | 3SJ0 | Yes       |
-| PSO GC Ep3 US     | 3SE0 | No        |
-| PSO GC Ep3 EU     | 3SP0 | No        |
-| PSO Xbox Beta     | 4OJB | Yes       |
-| PSO Xbox JP Disc  | 4OJD | Yes       |
-| PSO Xbox JP TU    | 4OJU | Yes       |
-| PSO Xbox US Disc  | 4OED | Yes       |
-| PSO Xbox US TU    | 4OEU | Yes       |
-| PSO Xbox EU Disc  | 4OPD | Yes       |
-| PSO Xbox EU TU    | 4OPU | Yes       |
-| PSO BB JP 1.25.13 | 51OC | Yes       |
-| PSO BB Tethealla  | 51OC | Yes       |
+| Game              | VERS | Architecture  |
+|-------------------|------|---------------|
+| PSO DC NTE        | 1OJ1 | Not supported |
+| PSO DC 11/2000    | 1OJ2 | Not supported |
+| PSO DC 12/2000    | 1OJ3 | Not supported |
+| PSO DC 01/2001    | 1OJ4 | Not supported |
+| PSO DC v1 JP      | 1OJF | Not supported |
+| PSO DC v1 US      | 1OEF | Not supported |
+| PSO DC v1 EU      | 1OPF | Not supported |
+| PSO DC 08/2001    | 2OJ5 | SH-4          |
+| PSO DC v2 JP      | 2OJF | SH-4          |
+| PSO DC v2 US      | 2OEF | SH-4          |
+| PSO DC v2 EU      | 2OPF | SH-4          |
+| PSO PC (v2)       | 2OJW | Not supported |
+| PSO GC NTE        | 3OJT | PowerPC       |
+| PSO GC v1.2 JP    | 3OJ2 | PowerPC       |
+| PSO GC v1.3 JP    | 3OJ3 | PowerPC       |
+| PSO GC v1.4 JP    | 3OJ4 | PowerPC       |
+| PSO GC v1.5 JP    | 3OJ5 | Not supported |
+| PSO GC v1.0 US    | 3OE0 | PowerPC       |
+| PSO GC v1.1 US    | 3OE1 | PowerPC       |
+| PSO GC v1.2 US    | 3OE2 | Not supported |
+| PSO GC v1.0 EU    | 3OP0 | PowerPC       |
+| PSO GC Ep3 NTE    | 3SJT | PowerPC       |
+| PSO GC Ep3 JP     | 3SJ0 | PowerPC       |
+| PSO GC Ep3 US     | 3SE0 | Not supported |
+| PSO GC Ep3 EU     | 3SP0 | Not supported |
+| PSO Xbox Beta     | 4OJB | x86           |
+| PSO Xbox JP Disc  | 4OJD | x86           |
+| PSO Xbox JP TU    | 4OJU | x86           |
+| PSO Xbox US Disc  | 4OED | x86           |
+| PSO Xbox US TU    | 4OEU | x86           |
+| PSO Xbox EU Disc  | 4OPD | x86           |
+| PSO Xbox EU TU    | 4OPU | x86           |
+| PSO BB JP 1.25.13 | 51OC | x86           |
+| PSO BB Tethealla  | 51OC | x86           |
 
 *Note: newserv uses the shorter GameCube versioning convention, where discs labeled DOL-XXXX-0-0Y are version 1.Y. The PSO community seems to use the convention 1.0Y in some places instead, but these are the same version. For example, the version that newserv calls v1.4 is the same as v1.04, and is labeled DOL-GPOJ-0-04 on the underside of the disc.*
 
 newserv comes with a set of patches for some of the above versions, based on AR codes originally made by Ralf at GC-Forever and Aleron Ives. Many of them were originally posted in [this thread](https://www.gc-forever.com/forums/viewtopic.php?f=38&t=2050).
 
-You can also put DOL files in the system/dol directory, and they will appear in the Programs menu for GC clients. Selecting a DOL file there will load the file into the GameCube's memory and run it, just like the old homebrew loaders (PSUL and PSOload) did. For this to work, ReadMemoryWord.ppc.s, WriteMemory.ppc.s, and RunDOL.ppc.s must be present in the system/client-functions directory. This has been tested on Dolphin but not on a real GameCube, so results may vary.
+You can also put DOL files in the system/dol directory, and they will appear in the Programs menu for GC clients. Selecting a DOL file there will load the file into the GameCube's memory and run it, just like the old homebrew loaders (PSUL and PSOload) did. For this to work, ReadMemoryWord.ppc.s, WriteMemory.ppc.s, and RunDOL.ppc.s must be present in the system/client-functions/System directory. This has been tested on Dolphin but not on a real GameCube, so results may vary.
 
 Like other kinds of data, functions and DOL files are cached in memory. If you've changed any of these files, you can run `reload functions` or `reload dol-files` in the interactive shell to make the changes take effect without restarting the server.
 
@@ -460,35 +502,36 @@ newserv supports a variety of commands players can use by chatting in-game. Any
 Some commands only work on the game server and not on the proxy server. The chat commands are:
 
 * Information commands
-    * `$li`: Shows basic information about the lobby or game you're in. If you're on the proxy server, shows information about your connection instead (remote Guild Card number, client ID, etc.).
-    * `$si` (game server only): Shows basic information about the server.
-    * `$ping`: Shows round-trip ping time from the server to you. On the proxy server, shows the ping time from you to the proxy and from the proxy to the server.
-    * `$matcount` (game server only): Shows how many of each type of material you've used.
-    * `$itemnotifs <mode>`: Enables item drop notification messages. If the game has private drops enabled, you will only see a notification if the dropped item is visible to you; you won't be notified of other players' drops. The modes are:
+    * `$li`: Show basic information about the lobby or game you're in. If you're on the proxy server, show information about your connection instead (remote Guild Card number, client ID, etc.).
+    * `$si` (game server only): Show basic information about the server.
+    * `$ping`: Show round-trip ping time from the server to you. On the proxy server, show the ping time from you to the proxy and from the proxy to the server.
+    * `$matcount` (game server only): Show how many of each type of material you've used.
+    * `$itemnotifs <mode>`: Enable item drop notification messages. If the game has private drops enabled, you will only see a notification if the dropped item is visible to you; you won't be notified of other players' drops. The modes are:
         * `off`: No notifications are shown.
         * `rare`: You are notified when a rare item drops.
         * `on`: You are notified when any item drops, except Meseta.
         * `every`: You are notified when any item drops, including Meseta.
-    * `$what` (game server only): Shows the type, name, and stats of the nearest item on the ground.
-    * `$where` (game server only): Shows your current floor number and coordinates. Mainly useful for debugging.
+    * `$what` (game server only): Show the type, name, and stats of the nearest item on the ground.
+    * `$where` (game server only): Show your current floor number and coordinates. Mainly useful for debugging.
+    * `$qfread <field-name>` (game server only): Show the value of a quest counter in your player data. The field names are defined in config.json.
 
 * Debugging commands
-    * `$debug` (game server only): Enable or disable debug. You need the DEBUG flag in your user account to use this command. Enabling debug does a few things:
+    * `$debug` (game server only): Enable or disable debug. You need the DEBUG flag in your user account to use this command. Enabling debug does several things:
         * You'll see in-game messages from the server when you take certain actions, like killing an enemy in BB.
         * You'll see the rare seed value and floor variations when you join a game.
-        * You'll be placed into the highest available slot in lobbies and games instead of the lowest, unless you're joining a BB solo-mode game.
-        * You'll be able to join games with any PSO version, not only those for which crossplay is normally supported. Be prepared for client crashes and other client-side brokenness if you do this. Please do not submit any issues for broken behaviors in crossplay, unless the situation is explicitly supported (see the "Cross-version play" section above).
+        * You'll be placed into the last available slot in lobbies and games instead of the first, unless you're joining a BB solo-mode game.
+        * You'll be able to join games with any PSO version, not only those for which crossplay is normally supported. Be prepared for client crashes and other client-side brokenness if you do this. Do not submit any issues for broken behaviors in crossplay, unless the situation is explicitly supported (see the "Cross-version play" section above).
         * The rest of the commands in this section are enabled on the game server. (They are always enabled on the proxy server.)
-    * `$quest <number>` (game server only): Load a quest by quest number. Can be used to load battle or challenge quests with only one player present.
+    * `$quest <number>` (game server only): Load a quest by quest number. Can be used to load battle or challenge quests with only one player present. Debug is not required to be enabled if the specified quest has the AllowStartFromChatCommand field set in its metadata file.
     * `$qcall <function-id>`: Call a quest function on your client.
     * `$qcheck <flag-num>` (game server only): Show the value of a quest flag. This command can be used without debug mode enabled. If you're in a game, show the value of the flag in that game; if you're in the lobby, show the saved value of that quest flag for your character (BB only).
     * `$qset <flag-num>` or `$qclear <flag-num>`: Set or clear a quest flag for everyone in the game. If you're in the lobby and on BB, set or clear the saved value of a quest flag in your character file.
-    * `$qgread <flag-num>` (game server only): Get the value of a quest counter ("global flag"). This command can be used without debug mode enabled.
+    * `$qgread <flag-num>` (game server only): Show the value of a quest counter ("global flag"). This command can be used without debug mode enabled.
     * `$qgwrite <flag-num> <value>` (game server only): Set the value of a quest counter ("global flag") for yourself.
     * `$qsync <reg-num> <value>`: Set a quest register's value for yourself only. `<reg-num>` should be either rXX (e.g. r60) or fXX (e.g. f60); if the latter, `<value>` is parsed as a floating-point value instead of as an integer.
     * `$qsyncall <reg-num> <value>`: Set a quest register's value for everyone in the game. `<reg-num>` should be either rXX (e.g. r60) or fXX (e.g. f60); if the latter, `<value>` is parsed as a floating-point value instead of as an integer.
     * `$swset [floor] <flag-num>` and `$swclear [floor] <flag-num>`: Set or clear a switch flag. If floor is not given, sets or clears the flag on your current floor.
-    * `$swsetall`: Sets all switch flags on your current floor. This unlocks all doors, disables all laser fences, triggers all light/poison switches, etc.
+    * `$swsetall`: Set all switch flags on your current floor. This unlocks all doors, disables all laser fences, triggers all light/poison switches, etc.
     * `$gc` (game server only): Send your own Guild Card to yourself.
     * `$sc <data>`: Send a command to yourself.
     * `$ss <data>`: Send a command to the remote server (if in a proxy session) or to the game server.
@@ -498,62 +541,63 @@ Some commands only work on the game server and not on the proxy server. The chat
     * `$ep3battledebug` (game server only; Episode 3 only): Enable or disable TCard00_Select. If enabled, the game will enter the debug menu when you start a battle.
 
 * Personal state commands
-    * `$arrow <color-id>`: Changes your lobby arrow color.
-    * `$secid <section-id>`: Sets your override section ID. After running this command, any games you create will use your override section ID for rare drops instead of your character's actual section ID. If you're in a game and you are the leader of the game, this also immediately changes the item tables used by the server when creating items. To revert to your actual section id, run `$secid` with no name after it. On the proxy server, this will not work if the remote server controls item drops (e.g. on BB, or on Schtserv with server drops enabled). If the server does not allow cheat mode anywhere (that is, "CheatModeBehavior" is "Off" in config.json), this command does nothing.
-    * `$rand <seed>`: Sets your override random seed (specified as a 32-bit hex value). This will make any games you create use the given seed for rare enemies. This also makes item drops deterministic in Blue Burst games hosted by newserv. On the proxy server, this command can cause desyncs with other players in the same game, since they will not see the overridden random seed. To remove the override, run `$rand` with no arguments. If the server does not allow cheat mode anywhere (that is, "CheatModeBehavior" is "Off" in config.json), this command does nothing.
-    * `$ln [name-or-type]`: Sets the lobby number. Visible only to you. This command exists because some non-lobby maps can be loaded as lobbies with invalid lobby numbers. See the "GC lobby types" and "Ep3 lobby types" entries in the information menu for acceptable values here. Note that non-lobby maps do not have a lobby counter, so there's no way to exit the lobby without using either `$ln` again or `$exit`. On the game server, `$ln` reloads the lobby immediately; on the proxy server, it doesn't take effect until you load another lobby yourself (which means you'll like have to use `$exit` to escape). Run this command with no argument to return to the default lobby.
-    * `$swa`: Enables or disables switch assist. When enabled, the server will attempt to automatically unlock two-player and four-player doors in non-quest games if you step on all the required switches sequentially.
-    * `$exit`: If you're in a lobby, sends you to the main menu (which ends your proxy session, if you're in one). If you're in a game or spectator team, sends you to the lobby (but does not end your proxy session if you're in one). Does nothing if you're in a non-Episode 3 game and no quest is in progress.
+    * `$arrow <color-id>`: Change your lobby arrow color.
+    * `$secid <section-id>`: Set your override section ID. After running this command, any games you create will use your override section ID for rare drops instead of your character's actual section ID. If you're in a game and you are the leader of the game, this also immediately changes the item tables used by the server when creating items. To revert to your actual section id, run `$secid` with no name after it. On the proxy server, this will not work if the remote server controls item drops (e.g. on BB, or on Schtserv with server drops enabled). If the server does not allow cheat mode anywhere (that is, "CheatModeBehavior" is "Off" in config.json), this command does nothing.
+    * `$rand <seed>`: Set your override random seed (specified as a 32-bit hex value). This will make any games you create use the given seed for rare enemies. This also makes item drops deterministic in Blue Burst games hosted by newserv. On the proxy server, this command can cause desyncs with other players in the same game, since they will not see the overridden random seed. To remove the override, run `$rand` with no arguments. If the server does not allow cheat mode anywhere (that is, "CheatModeBehavior" is "Off" in config.json), this command does nothing.
+    * `$ln [name-or-type]`: Set the lobby number. Visible only to you. This command exists because some non-lobby maps can be loaded as lobbies with invalid lobby numbers. See the "GC lobby types" and "Ep3 lobby types" entries in the information menu for acceptable values here. Note that non-lobby maps do not have a lobby counter, so there's no way to exit the lobby without using either `$ln` again or `$exit`. On the game server, `$ln` reloads the lobby immediately; on the proxy server, it doesn't take effect until you load another lobby yourself (which means you'll like have to use `$exit` to escape). Run this command with no argument to return to the default lobby.
+    * `$swa`: Enable or disable switch assist. When enabled, the server will attempt to automatically unlock two-player and four-player doors in non-quest games if you step on all the required switches sequentially.
+    * `$exit`: If you're in a lobby, send you to the main menu (which ends your proxy session, if you're in one). If you're in a game or spectator team, send you to the lobby (but does not end your proxy session if you're in one). Does nothing if you're in a non-Episode 3 game and no quest is in progress.
     * `$patch <name>`: Run a patch on your client. `<name>` must exactly match the name of a patch on the server.
 
 * Character data commands (game server only)
-    * `$savechar <slot>`: Saves your current character data on the server in the specified slot (each serial number has 4 slots, numbered 1-4). These slots are separate from BB character slots; using this command does not affect BB characters.
-    * `$loadchar <slot>` (v1 and v2 only): Loads your character data from the specified slot. The changes will be undone if you join a game - to save your changes, disconnect from the lobby.
-    * `$bbchar <username> <password> <slot>`: Use this command when playing on a non-BB version of PSO. If the username and password are correct, this command converts your current character to BB format and saves it on the server in the given slot (1-4). Any character already in that slot is overwritten. (This command is similar to `$savechar`, except it overwrites a BB character slot, and can transfer characters across accounts.) Note that the character's chat data, quick menu config, and bank contents are not copied, since there is no way for the server to request those types of data.
-    * `$edit <stat> <value>`: Modifies your character data. If you are on V3 (GameCube/Xbox), this command does nothing. If you are on V1 or V2 (DC or PC, not BB), your changes will be undone if you join a game - to save your changes, disconnect from the lobby. If cheats are allowed on the server, `<stat>` can be any of `atp`, `mst`, `evp`, `hp`, `dfp`, `ata`, `lck`, `meseta`, `exp`, `level`, `namecolor`, `secid`, `name`, `language`, `npc`, or `tech`. If cheats are not allowed, only `namecolor`, `name`, `language`, and `npc` can be used. Changing your character's language is only useful on BB; to do so, use a single-character language code (e.g. to switch your character to English, use `$edit language E`; for Japanese, use `$edit language J`).
+    * `$savechar <slot>`: Save your current character data on the server in the specified slot. See the "Server-side saves" section for more details.
+    * `$loadchar <slot>`: Save your current character data on the server in the specified slot. See the "Server-side saves" section for more details.
+    * `$bbchar <username> <password> <slot>`: Save your current character data on the server in a different account's BB character slots. See the "Server-side saves" section for more details.
+    * `$edit <stat> <value>`: Modify your character data. If you are on V3 (GameCube/Xbox), this command does nothing. If you are on V1 or V2 (DC or PC, not BB), your changes will be undone if you join a game - to save your changes, disconnect from the lobby. If cheats are allowed on the server, `<stat>` can be any of `atp`, `mst`, `evp`, `hp`, `dfp`, `ata`, `lck`, `meseta`, `exp`, `level`, `namecolor`, `secid`, `name`, `language`, `npc`, or `tech`. If cheats are not allowed, only `namecolor`, `name`, `language`, and `npc` can be used. Changing your character's language is only useful on BB; to do so, use a single-character language code (e.g. to switch your character to English, use `$edit language E`; for Japanese, use `$edit language J`).
 
 * Blue Burst player commands (game server only)
-    * `$bank [number]`: Switches your current bank, so you can access your other character's banks (if `number` is 1-4) or your shared account bank (if `number` is 0). If `number` is not given, switches back to your current character's bank.
-    * `$save`: Saves your character, system, and Guild Card data immediately. (By default, your character is saved every 60 seconds while online, and your account and Guild Card data are saved whenever they change.)
+    * `$bank [number]`: Switch your current bank, so you can access your other character's banks (if `number` is 1-4) or your shared account bank (if `number` is 0). If `number` is not given, switch back to your current character's bank.
+    * `$save`: Save your character, system, and Guild Card data immediately. (By default, your character is saved every 60 seconds while online, and your account and Guild Card data are saved whenever they change.)
 
 * Game state commands (game server only)
-    * `$maxlevel <level>`: Sets the maximum level for players to join the current game. (This only applies when joining; if a player joins and then levels up past this level during the game, they are not kicked out, but won't be able to rejoin if they leave.)
-    * `$minlevel <level>`: Sets the minimum level for players to join the current game.
-    * `$password <password>`: Sets the game's join password. To unlock the game, run `$password` with nothing after it.
-    * `$dropmode [mode]`: Changes the way item drops behave in the current game. `mode` can be `none`, `client`, `shared`, `private`, or `duplicate`. If `mode` is not given, tells you the current drop mode without changing it. See the "Item tables and drop modes" section for more information.
-    * `$persist`: Enable or disable persistence for the current game. When persistence is on, the game will not be deleted when the last player leaves. The states of enemies, objects, and switches will be saved, and items left on the floor will not be deleted (except items only visible to the leaving player). If the game is empty for too long (15 minutes by default), it is then deleted. There is an edge case with persistence: if the player defeats a boss, leaves the room, joins again, and returns to the boss arena, neither the boss nor the exit warp will spawn, so they will be stuck there and have to use $warp or Quit Game to get out. For this reason, `$warp 0` is allowed in boss arenas once the boss is defeated, even if cheat mode is disabled.
+    * `$maxlevel <level>`: Set the maximum level for players to join the current game. (This only applies when joining; if a player joins and then levels up past this level during the game, they are not kicked out, but won't be able to rejoin if they leave.)
+    * `$minlevel <level>`: Set the minimum level for players to join the current game.
+    * `$password <password>`: Set the game's join password. To unlock the game, run `$password` with nothing after it.
+    * `$dropmode [mode]`: Change the way item drops behave in the current game. `mode` can be `none`, `client`, `shared`, `private`, or `duplicate`. If `mode` is not given, tells you the current drop mode without changing it. See the "Item tables and drop modes" section for more information.
+    * `$persist`: Enable or disable persistence for the current game. When persistence is on, the game will not be deleted when the last player leaves. The states of enemies, objects, and switches will be saved, and items left on the floor will not be deleted (except items that were only visible to the leaving player, which are deleted). If the game is empty for too long (15 minutes by default), it is then deleted. There is an edge case with persistence: if the player defeats a boss, leaves the room, joins again, and returns to the boss arena, neither the boss nor the exit warp will appear, so they will be stuck there and have to use $warp or Quit Game to get out. For this reason, `$warp 0` is allowed in boss arenas once the boss is defeated, even if cheat mode is disabled.
 
 * Episode 3 commands (game server only)
-    * `$spec`: Toggles the allow spectators flag for Episode 3 games. If any players are spectating when this flag is disabled, they will be sent back to the lobby.
-    * `$inftime`: Toggles infinite-time mode. Must be used before starting a battle. If infinite-time mode is enabled, the overall and per-phase time limits will be disabled regardless of the values chosen during battle setup. After completing a battle, infinite-time mode is reset to the server's default value (which can be set in Episode3BehaviorFlags in config.json).
-    * `$dicerange [d:L-H] [1:L-H] [a1:L-H] [d1:L-H]`: Sets override dice ranges for the next battle. The min and max dice values from the rules setup menu always apply to the ATK dice, but you can specify a different range for the DEF dice with `d:2-4` (for example). The `1:` override applies to the 1-player team in a 2v1 game (so you would set the 2-player team's desired dice range in the rules menu). You can also specify the 1-player team's ATK and DEF ranges separately with the `a1:` and `d1:` overrides. Note that these ranges will only be used if the chosen map or quest does not override them.
-    * `$stat <what>`: Shows a statistic about your player or team in the current battle. `<what>` can be `duration`, `fcs-destroyed`, `cards-destroyed`, `damage-given`, `damage-taken`, `opp-cards-destroyed`, `own-cards-destroyed`, `move-distance`, `cards-set`, `fcs-set`, `attack-actions-set`, `techs-set`, `assists-set`, `defenses-self`, `defenses-ally`, `cards-drawn`, `max-attack-damage`, `max-combo`, `attacks-given`, `attacks-taken`, `sc-damage`, `damage-defended`, or `rank`.
-    * `$surrender`: Causes your team to immediately lose the current battle.
-    * `$saverec <name>`: Saves the recording of the last battle.
-    * `$playrec <name>`: Plays a battle recording. This command creates a spectator team and replays the specified battle log within it. There is a bug in Dolphin that makes use of this command unstable in emulation (see the "Battle records" section above).
+    * `$spec`: Toggle the allow spectators flag for Episode 3 games. If any players are spectating when this flag is disabled, they are sent back to the lobby.
+    * `$inftime`: Toggle infinite-time mode. Must be used before starting a battle. If infinite-time mode is on, the overall and per-phase time limits will be disabled regardless of the values chosen during battle rules setup. After completing a battle, infinite-time mode is reset to the server's default value (which can be set in Episode3BehaviorFlags in config.json).
+    * `$dicerange [d:L-H] [1:L-H] [a1:L-H] [d1:L-H]`: Set override dice ranges for the next battle. The min and max dice values from the rules setup menu always apply to the ATK dice, but you can specify a different range for the DEF dice with `d:2-4` (for example). The `1:` override applies to the 1-player team in a 2v1 game (so you would set the 2-player team's desired dice range in the rules menu). You can also specify the 1-player team's ATK and DEF ranges separately with the `a1:` and `d1:` overrides. Note that these ranges will only be used if the chosen map or quest does not override them.
+    * `$stat <what>`: Show a statistic about your player or team in the current battle. `<what>` can be `duration`, `fcs-destroyed`, `cards-destroyed`, `damage-given`, `damage-taken`, `opp-cards-destroyed`, `own-cards-destroyed`, `move-distance`, `cards-set`, `fcs-set`, `attack-actions-set`, `techs-set`, `assists-set`, `defenses-self`, `defenses-ally`, `cards-drawn`, `max-attack-damage`, `max-combo`, `attacks-given`, `attacks-taken`, `sc-damage`, `damage-defended`, or `rank`.
+    * `$surrender`: Cause your team to immediately lose the current battle.
+    * `$saverec <name>`: Save the recording of the last battle.
+    * `$playrec <name>`: Play a battle recording. This command creates a spectator team immediately but the replay does not start automatically, to give other players a chance to join. To start the battle replay within the spectator team, run `$playrec` again (with no name). There is a bug in Dolphin that makes this command unstable in emulation (see the "Battle records" section above).
 
 * Cheat mode commands
-    * `$cheat` (game server only): Enables or disables cheat mode for the current game. All other cheat mode commands do nothing if cheat mode is disabled. By default, cheat mode is off in new games but can be enabled; there is an option in config.json that allows you to disable cheat mode entirely, or set it to on by default in new games. Cheat mode is always enabled on the proxy server, unless cheat mode is disabled on the entire server.
-    * `$infhp` / `$inftp`: Enables or disables infinite HP or TP mode. Applies to only you. In infinite HP mode, one-hit KO attacks will still kill you. On V1 and V2, infinite HP also automatically cures status ailments.
-    * `$warpme <floor-id>` (or `$warp <floor-id>`): Warps yourself to the given floor.
-    * `$warpall <floor-id>`: Warps everyone in the game to the given floor. You must be the leader to use this command, unless you're on the proxy server.
-    * `$next`: Warps yourself to the next floor.
+    * `$cheat` (game server only): Enable or disable cheat mode for the current game. All other cheat mode commands do nothing if cheat mode is disabled. By default, cheat mode is off in new games but can be enabled; there is an option in config.json that allows you to disable cheat mode entirely, or set it to on by default in new games. Cheat mode is always enabled on the proxy server, unless cheat mode is disabled on the entire server.
+    * `$infhp`: Enable or disable infinite HP mode. Applies to only you; does not affect other players. When enabled, one-hit KO attacks will still kill you, but on most versions of the game (not DCv1, GC US 1.2, or GC JP 1.5), the server will automatically revive you if you die. On all versions except GC US 1.2 and GC JP 1.5, infinite HP also automatically cures status ailments.
+    * `$inftp`: Enable or disable infinite TP mode. Applies to only you; does not affect other players.
+    * `$warpme <floor-id>` (or `$warp <floor-id>`): Warp yourself to the given floor.
+    * `$warpall <floor-id>`: Warp everyone in the game to the given floor. You must be the leader to use this command, unless you're on the proxy server.
+    * `$next`: Warp yourself to the next floor.
     * `$item <desc>` (or `$i <desc>`): Create an item. `desc` may be a description of the item (e.g. "Hell Saber +5 0/10/25/0/10") or a string of hex data specifying the item code. Item codes are 16 hex bytes; at least 2 bytes must be specified, and all unspecified bytes are zeroes. If you are on the proxy server, you must not be using Blue Burst for this command to work. On the game server, this command works for all versions.
     * `$unset <index>` (game server only): In an Episode 3 battle, removes one of your set cards from the field. `<index>` is the index of the set card as it appears on your screen - 1 is the card next to your SC's icon, 2 is the card to the right of 1, etc. This does not cause a Hunters-side SC to lose HP, as they normally do when their items are destroyed.
-    * `$dropmode [mode]` (proxy server): Changes the way item drops behave in the current game, if you are not on BB. Unlike the game server version of this command, using this on the proxy server requires cheats to be enabled. This works by intercepting the drop requests sent to and from the leader. (So, if you are the leader and not using server drop mode on the remote server, it affects the entire game; otherwise, it affects only items generated by your actions.) `mode` can be `none` (no drops), `default` (normal drops), or `proxy` (use newserv's drop tables instead of the remote server's). If `mode` is not given, tells you the current drop mode without changing it.
+    * `$dropmode [mode]` (proxy server): Change the way item drops behave in the current game, if you are not on BB. Unlike the game server version of this command, using this on the proxy server requires cheats to be enabled. This works by intercepting the drop requests sent to and from the leader. (So, if you are the leader and not using server drop mode on the remote server, it affects the entire game; otherwise, it affects only items generated by your actions.) `mode` can be `none` (no drops), `default` (normal drops), or `proxy` (use newserv's drop tables instead of the remote server's). If `mode` is not given, tells you the current drop mode without changing it.
 
-* Configuration commands
-    * `$event <event>`: Sets the current holiday event in the current lobby. Holiday events are documented in the "Using $event" item in the information menu. If you're on the proxy server, this applies to all lobbies and games you join, but only you will see the new event - other players will not.
-    * `$allevent <event>` (game server only): Sets the current holiday event in all lobbies.
-    * `$song <song-id>` (Episode 3 only): Plays a specific song in the current lobby.
+* Aesthetic commands
+    * `$event <event>`: Set the current holiday event in the current lobby. Holiday events are documented in the "Using $event" item in the information menu. If you're on the proxy server, this applies to all lobbies and games you join, but only you will see the new event - other players will not.
+    * `$allevent <event>` (game server only): Set the current holiday event in all lobbies.
+    * `$song <song-id>` (Episode 3 only): Play a specific song in the current lobby.
 
 * Administration commands (game server only)
-    * `$ann <message>`: Sends an announcement message. The message is sent as temporary on-screen text to all players in all games and lobbies.
-    * `$ann! <message>`: Sends an announcement message. The message is sent as a Simple Mail message to all players in all games and lobbies.
-    * `$ax <message>`: Sends a message to the server's terminal. This cannot be used to run server shell commands; it only prints text to stderr.
-    * `$silence <identifier>`: Silences a player (remove their ability to chat) or unsilences a player. The identifier may be the player's name or Guild Card number.
-    * `$kick <identifier>`: Disconnects a player. The identifier may be the player's name or Guild Card number.
-    * `$ban <identifier>`: Bans a player. The identifier may be the player's name or Guild Card number.
+    * `$ann <message>`: Send an announcement message. The message is sent as temporary on-screen text to all players in all games and lobbies.
+    * `$ann! <message>`: Send an announcement message. The message is sent as a Simple Mail message to all players in all games and lobbies.
+    * `$ax <message>`: Send a message to the server's terminal. This cannot be used to run server shell commands; it only prints text to stderr.
+    * `$silence <identifier>`: Silence a player (remove their ability to chat) or unsilence a player. The identifier may be the player's name or Guild Card number.
+    * `$kick <identifier>`: Disconnect a player. The identifier may be the player's name or Guild Card number.
+    * `$ban <duration> <identifier>`: Ban a player. The duration should be of the form `10m` (minutes), `10h` (hours), `10d` (days), `10w` (weeks), `10M` (months), or `10y` (years). (Numbers other than 10 may be used, of course.) As with `$kick`, the identifier may be the player's name or Guild Card number.
 
 # Non-server features
 

TODO.md

@@ -1,11 +1,10 @@
 ## General
 
-- Make reloading happen on separate threads so compression doesn't block active clients
 - Implement decrypt/encrypt actions for VMS files
 - Make UI strings localizable (e.g. entries in menus, welcome message, etc.)
 - Add an idle connection timeout for proxy sessions
 - Clean up ItemParameterTable implementation (see comment at the top of the class definition)
-- Handle MeetUserExtensions properly in 41 and C4 commands on the proxy (rewrite the embedded 19 command and store a map of )
+- Handle MeetUserExtensions properly in 41 and C4 commands on the proxy (rewrite the embedded 19 command and store a map of received destinations)
 
 ## PSO DC
 
@@ -26,7 +25,6 @@
 
 ## PSOBB
 
-- Test all quest item subcommands
 - Figure out why Pouilly Slime EXP doesn't work
 - Make server-specified rare enemies work with maps loaded by the proxy
 - Implement serialization for various table types (ItemPMT, ItemPT, etc.)

notes/ar-codes.txt

@@ -79,6 +79,11 @@ Ep3-US  => 042F9AC0 60000000
 Ep3-NTE => 040C2C48 60000000
 Ep3-JP  => 042F8B74 60000000
 
+(Ep1&2 USA v1.1) Change type of all loading screens
+0401CA04 3BE0000X
+0401CA08 48000038
+Values for X: 0 = lobby/game join, 1 = quest load, 3 = pipe up, 4 = pipe down, anything else = silent black screen
+
 (Ep3 USA) Replace loading screen A button sounds with random sounds
 042F9B18 4804BB19
 042F9B1C 5463063E
@@ -350,3 +355,8 @@ Note: Without a TextEnglish.pr2/pr3 patch, the menu items for these sounds will
 0408E448 38000001
 0408E44C 900DA62C
 0408E450 4E800020
+
+(v1.1 USA) Replace all sound effects with specified sound effect
+042256E4 3F40XXXX
+042256E8 635AYYYY
+042256EC 4800000C

notes/patch-ports.txt

@@ -73,9 +73,9 @@ ItemLossPrevention
 *** desc=Don't lose items if\nyou don't log off\nnormally
 JP12------------- JP13------------- JP14------------- JP15------------- US10------------- US11------------- US12------------- EU--------------- DISASSEMBLY (US10)
 801D33E4 4800004C 801D38EC 4800004C 801D3CC4 4800004C 801D39B8 4800004C 801D381C 4800004C 801D381C 4800004C 801D3A1C 4800004C 801D3ED8 4800004C b         +0x0000004C /* 801D3868 */
-                                    8020010C 60000000 801FF710 60000000 801FF0FC 60000000 801FF0FC 60000000 801FFA44 60000000 801FF9E0 60000000 nop
-                                    802016CC 60000000 80200C9C 60000000 80200658 60000000 80200658 60000000 80200FD0 60000000 80200F3C 60000000 nop
-                                    801FD944 38000000 80202860 38000000 802021C4 38000000 802021C4 38000000 80202B94 38000000 80202AA8 38000000 li        r0, 0x0000
+801FE900 60000000 801FF174 60000000 8020010C 60000000 801FF710 60000000 801FF0FC 60000000 801FF0FC 60000000 801FFA44 60000000 801FF9E0 60000000 nop
+801FFE5C 60000000 802006D0 60000000 802016CC 60000000 80200C9C 60000000 80200658 60000000 80200658 60000000 80200FD0 60000000 80200F3C 60000000 nop
+802019C8 38000000 8020223C 38000000 801FD944 38000000 80202860 38000000 802021C4 38000000 802021C4 38000000 80202B94 38000000 80202AA8 38000000 li        r0, 0x0000
 802C2060 4800004C 802C2F98 4800004C 802C42E4 4800004C 802C3E78 4800004C 802C2A40 4800004C 802C2A84 4800004C 802C402C 4800004C 802C37C0 4800004C b         +0x0000004C /* 802C2A8C */
 802D0AA0 48000020 802D1A58 48000020 802D2C10 48000020 802D2938 48000020 802D1480 48000020 802D14C4 48000020 802D2AEC 48000020 802D2280 48000020 b         +0x00000020 /* 802D14A0 */
 
@@ -754,15 +754,45 @@ Show Enemy HP Bars
 EnemyHPBars
 *** name=Enemy HP bars
 *** desc=Show HP bars in\nenemy info windows
-JP12------------- JP13------------- JP14------------- JP15------------- US10------------- US11------------- US12------------- EU--------------- DISASSEMBLY (US10)
+JP12------------- JP13------------- JP14------------- JP15------------- US10------------- US11------------- US12------------- EU--------------- DISASSEMBLY (US12)
 802612C4 4BFE1541 80261E9C 4BFE1349 80262EE4 4BFE0665 80262C98 4BFE1241 80261B9C 4BFE1545 80261B9C 4BFE1545 80262F5C 4BFE12B1 802627A4 4BFE12B1 bl        -0x0001EABC /* 802430E0 */
-804CAF00 42300000 804CE650 42300000 804D0BA0 42300000 804D0940 42300000 804CB6D0 42300000 804CBBB0 42300000 804D0218 42300000 804D0608 42300000 bdnz      cr4, +0x00000000 /* 804CB6D0 */
-804CAF1C FF00FF15 804CE66C FF00FF15 804D0BBC FF00FF15 804D095C FF00FF15 804CB6EC FF00FF15 804CBBCC FF00FF15 804D0234 FF00FF15 804D0624 FF00FF15 .invalid  FC, 0
-805CBFBC 42A00000 805D65BC 42A00000 805DDA5C 42A00000 805DD7FC 42A00000 805CC8C4 42A00000 805D38E4 42A00000 805DD104 42A00000 805D9344 42A00000 b         +0x00000000 /* 805CC8C4 */
-804CAE40 42640000 804CE590 42640000 804D0AE0 42640000 804D0880 42640000 804CB610 42640000 804CBAF0 42640000 804D0158 42640000 804D0548 42640000 bc        19, 4, +0x00000000 /* 804CB610 */
-804CAE4C 42640000 804CE59C 42640000 804D0AEC 42640000 804D088C 42640000 804CB61C 42640000 804CBAFC 42640000 804D0164 42640000 804D0554 42640000 bc        19, 4, +0x00000000 /* 804CB61C */
-804CAE58 42640000 804CE5A8 42640000 804D0AF8 42640000 804D0898 42640000 804CB628 42640000 804CBB08 42640000 804D0170 42640000 804D0560 42640000 bc        19, 4, +0x00000000 /* 804CB628 */
-804CAE64 42640000 804CE5B4 42640000 804D0B04 42640000 804D08A4 42640000 804CB634 42640000 804CBB14 42640000 804D017C 42640000 804D056C 42640000 bc        19, 4, +0x00000000 /* 804CB634 */
+804CAF00 42780000 804CE650 42780000 804D0BA0 42780000 804D0940 42780000 804CB6D0 42780000 804CBBB0 42780000 804D0218 42780000 804D0608 42780000
+804CAF1C FF00FF15 804CE66C FF00FF15 804D0BBC FF00FF15 804D095C FF00FF15 804CB6EC FF00FF15 804CBBCC FF00FF15 804D0234 FF00FF15 804D0624 FF00FF15
+805CBFBC 42C00000 805D65BC 42C00000 805DDA5C 42C00000 805DD7FC 42C00000 805CC8C4 42C00000 805D38E4 42C00000 805DD104 42C00000 805D9344 42C00000
+804CAE40 42960000 804CE590 42960000 804D0AE0 42960000 804D0880 42960000 804CB610 42960000 804CBAF0 42960000 804D0158 42960000 804D0548 42960000
+804CAE4C 42960000 804CE59C 42960000 804D0AEC 42960000 804D088C 42960000 804CB61C 42960000 804CBAFC 42960000 804D0164 42960000 804D0554 42960000
+804CAE58 42960000 804CE5A8 42960000 804D0AF8 42960000 804D0898 42960000 804CB628 42960000 804CBB08 42960000 804D0170 42960000 804D0560 42960000
+804CAE64 42960000 804CE5B4 42960000 804D0B04 42960000 804D08A4 42960000 804CB634 42960000 804CBB14 42960000 804D017C 42960000 804D056C 42960000
+804CAE70 42960000 804CE5C0 42960000 804D0B10 42960000 804D08B0 42960000 804CB640 42960000 804CBB20 42960000 804D0188 42960000 804D0578 42960000
+80261260 4BDAA3F1 80261E38 4BDA9819 80262E80 4BDA87D1 80262C34 4BDA8A1D 80261B38 4BDA9B19 80261B38 4BDA9B19 80262EF8 4BDA8759 80262740 4BDA8F11 bl        -0x002578A8 /* 8000B650 */
+80261420 4BDAA245 80261FF8 4BDA966D 80263040 4BDA8625 80262DF4 4BDA8871 80261CF8 4BDA996D 80261CF8 4BDA996D 802630B8 4BDA85AD 80262900 4BDA8D65 bl        -0x00257A54 /* 8000B664 */
+8000B650 3CA08001 8000B650 3CA08001 8000B650 3CA08001 8000B650 3CA08001 8000B650 3CA08001 8000B650 3CA08001 8000B650 3CA08001 8000B650 3CA08001 lis       r5, 0x8001
+8000B654 8065B6BC 8000B654 8065B6BC 8000B654 8065B6BC 8000B654 8065B6BC 8000B654 8065B6BC 8000B654 8065B6BC 8000B654 8065B6BC 8000B654 8065B6BC lwz       r3, [r5 - 0x4944]
+8000B658 7FFEFB78 8000B658 7FFEFB78 8000B658 7FFEFB78 8000B658 7FFEFB78 8000B658 7FFEFB78 8000B658 7FFEFB78 8000B658 7FFEFB78 8000B658 7FFEFB78 mr        r30, r31
+8000B65C A8DE032C 8000B65C A8DE032C 8000B65C A8DE032C 8000B65C A8DE032C 8000B65C A8DE032C 8000B65C A8DE032C 8000B65C A8DE032C 8000B65C A8DE032C lha       r6, [r30 + 0x032C]
+8000B660 48000010 8000B660 48000010 8000B660 48000010 8000B660 48000010 8000B660 48000010 8000B660 48000010 8000B660 48000010 8000B660 48000010 b         +0x00000010 /* 8000B670 */
+8000B664 A8DE02B8 8000B664 A8DE02B8 8000B664 A8DE02B8 8000B664 A8DE02B8 8000B664 A8DE02B8 8000B664 A8DE02B8 8000B664 A8DE02B8 8000B664 A8DE02B8 lha       r6, [r30 + 0x02B8]
+8000B668 3CA08001 8000B668 3CA08001 8000B668 3CA08001 8000B668 3CA08001 8000B668 3CA08001 8000B668 3CA08001 8000B668 3CA08001 8000B668 3CA08001 lis       r5, 0x8001
+8000B66C 9065B6BC 8000B66C 9065B6BC 8000B66C 9065B6BC 8000B66C 9065B6BC 8000B66C 9065B6BC 8000B66C 9065B6BC 8000B66C 9065B6BC 8000B66C 9065B6BC stw       [r5 - 0x4944], r3
+8000B670 7C0802A6 8000B670 7C0802A6 8000B670 7C0802A6 8000B670 7C0802A6 8000B670 7C0802A6 8000B670 7C0802A6 8000B670 7C0802A6 8000B670 7C0802A6 mflr      r0
+8000B674 9005B6C0 8000B674 9005B6C0 8000B674 9005B6C0 8000B674 9005B6C0 8000B674 9005B6C0 8000B674 9005B6C0 8000B674 9005B6C0 8000B674 9005B6C0 stw       [r5 - 0x4940], r0
+8000B678 7C651B78 8000B678 7C651B78 8000B678 7C651B78 8000B678 7C651B78 8000B678 7C651B78 8000B678 7C651B78 8000B678 7C651B78 8000B678 7C651B78 mr        r5, r3
+8000B67C A8FE02B8 8000B67C A8FE02B8 8000B67C A8FE02B8 8000B67C A8FE02B8 8000B67C A8FE02B8 8000B67C A8FE02B8 8000B67C A8FE02B8 8000B67C A8FE02B8 lha       r7, [r30 + 0x02B8]
+8000B680 3C808000 8000B680 3C808000 8000B680 3C808000 8000B680 3C808000 8000B680 3C808000 8000B680 3C808000 8000B680 3C808000 8000B680 3C808000 lis       r4, 0x8000
+8000B684 6084B6AC 8000B684 6084B6AC 8000B684 6084B6AC 8000B684 6084B6AC 8000B684 6084B6AC 8000B684 6084B6AC 8000B684 6084B6AC 8000B684 6084B6AC ori       r4, r4, 0xB6AC
+8000B688 38640018 8000B688 38640018 8000B688 38640018 8000B688 38640018 8000B688 38640018 8000B688 38640018 8000B688 38640018 8000B688 38640018 addi      r3, r4, 0x0018
+8000B68C 4CC63182 8000B68C 4CC63182 8000B68C 4CC63182 8000B68C 4CC63182 8000B68C 4CC63182 8000B68C 4CC63182 8000B68C 4CC63182 8000B68C 4CC63182 crxor     crb6, crb6, crb6
+8000B690 4838A86D 8000B690 4838D275 8000B690 4838F115 8000B690 4838EEC5 8000B690 4838BB3D 8000B690 4838BB95 8000B690 4838F295 8000B690 4838DD85 bl        sprintf /* 8039A924 */
+8000B694 3C808000 8000B694 3C808000 8000B694 3C808000 8000B694 3C808000 8000B694 3C808000 8000B694 3C808000 8000B694 3C808000 8000B694 3C808000 lis       r4, 0x8000
+8000B698 6084B6C4 8000B698 6084B6C4 8000B698 6084B6C4 8000B698 6084B6C4 8000B698 6084B6C4 8000B698 6084B6C4 8000B698 6084B6C4 8000B698 6084B6C4 ori       r4, r4, 0xB6C4
+8000B69C 7F83E378 8000B69C 7F83E378 8000B69C 7F83E378 8000B69C 7F83E378 8000B69C 7F83E378 8000B69C 7F83E378 8000B69C 7F83E378 8000B69C 7F83E378 mr        r3, r28
+8000B6A0 8004FFFC 8000B6A0 8004FFFC 8000B6A0 8004FFFC 8000B6A0 8004FFFC 8000B6A0 8004FFFC 8000B6A0 8004FFFC 8000B6A0 8004FFFC 8000B6A0 8004FFFC lwz       r0, [r4 - 0x0004]
+8000B6A4 7C0803A6 8000B6A4 7C0803A6 8000B6A4 7C0803A6 8000B6A4 7C0803A6 8000B6A4 7C0803A6 8000B6A4 7C0803A6 8000B6A4 7C0803A6 8000B6A4 7C0803A6 mtlr      r0
+8000B6A8 4E800020 8000B6A8 4E800020 8000B6A8 4E800020 8000B6A8 4E800020 8000B6A8 4E800020 8000B6A8 4E800020 8000B6A8 4E800020 8000B6A8 4E800020 blr
+8000B6AC 25730A0A 8000B6AC 25730A0A 8000B6AC 25730A0A 8000B6AC 25730A0A 8000B6AC 25730A0A 8000B6AC 25730A0A 8000B6AC 25730A0A 8000B6AC 25730A0A .invalid
+8000B6B0 48503A25 8000B6B0 48503A25 8000B6B0 48503A25 8000B6B0 48503A25 8000B6B0 48503A25 8000B6B0 48503A25 8000B6B0 48503A25 8000B6B0 48503A25 bl        +0x00503A24 /* 8050F0D4 */
+8000B6B4 642F2564 8000B6B4 642F2564 8000B6B4 642F2564 8000B6B4 642F2564 8000B6B4 642F2564 8000B6B4 642F2564 8000B6B4 642F2564 8000B6B4 642F2564 oris      r15, r1, 0x2564
+8000B6B8 00000000 8000B6B8 00000000 8000B6B8 00000000 8000B6B8 00000000 8000B6B8 00000000 8000B6B8 00000000 8000B6B8 00000000 8000B6B8 00000000 .invalid
 
 PSO DC Reticle Colours
 DCReticleColors

notes/psobb/translated-coren-map-files/npc-coren-textstrings/tsuchan.txt

@@ -1,96 +1,94 @@
-###########################################################
-
-NPC: Coren Tsu - The Wanderer
-AREAS: Pioneer 2
-
-Translations by: apexseals (discord: apexseals)
-Proofing & Debugging by: nolrinale (github.com/nolrinale)
-
-###########################################################
-
-presentation:
-
-I am Coren Tsu, a wandering merchant,
-you could say.
-
-Please take some time to look at
-the rare and wonderous goods
-I have been collecting.
-
-If you spend a little meseta,
-you could win a wonderful prize.
-
-Well? Wanna try?
-
-
-You may win,
-you may lose.
-
-But if you don't win,
-don't take it out on me.
-
-That's just the way
-gambling is, yes?
-
-Well then, how much
-meseta do you want to pay?
-
-As long as you pay me,
-I'll give you a great service.
-
-
-Huh?
-
-That's too bad...
-
-Well, these kind of things usually
-have a chance to lose money. 
-
-Let's keep this discreet.
-If you feel up to it, talk to me again.
-
-
-It seems you have
-too many items.
-
-First, go and
-organize your items,
-
-Then speak to me again.
-
-What?
-
-You said you'd try,
-then you said no.
-
-People like that
-fail at everything.
-
-
-What the...?
-
-You don't have the 
-meseta to pay me?
-
-I won't work with such
-cold hearted people.
-
-
-Alright, let's do it.
-
-You better pray
-for something good...
-
-
-Look here!
-Take it!
-
-Even if you had bad luck,
-something good will come out of it.
-
-You'll win someday!
-
-In case you want to try again,
-come back to me once more.
-
-
+###########################################################
+
+NPC: Coren Tsu - The Wanderer
+AREAS: Pioneer 2
+
+Translations by: apexseals (discord: apexseals)
+Proofing & Debugging by: nolrinale (github.com/nolrinale)
+
+###########################################################
+
+presentation:
+
+I am Coren Tsu, a wandering merchant,
+you could say.
+
+Please take some time to look at
+the rare and wonderous goods
+I have been collecting.
+
+If you spend a little meseta,
+you could win a wonderful prize.
+
+Well? Wanna try?
+
+
+You may win,
+you may lose.
+
+But if you don't win,
+don't take it out on me.
+
+That's just the way
+gambling is, yes?
+
+Well then, how much
+meseta do you want to pay?
+
+As long as you pay me,
+I'll give you a great service.
+
+
+Huh?
+
+That's too bad...
+
+Well, these kind of things usually
+have a chance to lose money.
+
+Let's keep this discreet.
+If you feel up to it, talk to me again.
+
+
+It seems you have
+too many items.
+
+First, go and
+organize your items,
+
+Then speak to me again.
+
+What?
+
+You said you'd try,
+then you said no.
+
+People like that
+fail at everything.
+
+
+What the...?
+
+You don't have the
+meseta to pay me?
+
+I won't work with such
+cold hearted people.
+
+
+Alright, let's do it.
+
+You better pray
+for something good...
+
+
+Look here!
+Take it!
+
+Even if you had bad luck,
+something good will come out of it.
+
+You'll win someday!
+
+In case you want to try again,
+come back to me once more.

src/ARCodeTranslator-Stub.hh

@@ -1,18 +0,0 @@
-#pragma once
-
-#include <stdexcept>
-#include <string>
-#include <utility>
-#include <vector>
-
-inline void run_ar_code_translator(const std::string&, const std::string&, const std::string&) {
-  throw std::runtime_error("resource_file is not available; install it and rebuild newserv");
-}
-
-inline void run_xbe_patch_translator(const std::string&, const std::string&, const std::string&) {
-  throw std::runtime_error("resource_file is not available; install it and rebuild newserv");
-}
-
-inline std::vector<std::pair<uint32_t, std::string>> diff_dol_files(const std::string&, const std::string&) {
-  throw std::runtime_error("resource_file is not available; install it and rebuild newserv");
-}

src/ARCodeTranslator.cc

@@ -1,640 +0,0 @@
-#include "ARCodeTranslator.hh"
-
-#include <array>
-#include <future>
-#include <phosg/Filesystem.hh>
-#include <phosg/Strings.hh>
-#include <resource_file/ExecutableFormats/DOLFile.hh>
-#include <resource_file/ExecutableFormats/XBEFile.hh>
-
-using namespace std;
-
-class ARCodeTranslator {
-public:
-  enum class ExpandMethod {
-    FORWARD = 0,
-    FORWARD_WITH_BARRIER,
-    BACKWARD,
-    BACKWARD_WITH_BARRIER,
-    BOTH,
-    BOTH_WITH_BARRIER,
-    BOTH_IGNORE_ORIGIN,
-  };
-
-  static const char* name_for_expand_method(ExpandMethod method) {
-    switch (method) {
-      case ExpandMethod::FORWARD:
-        return "FORWARD";
-      case ExpandMethod::FORWARD_WITH_BARRIER:
-        return "FORWARD_WITH_BARRIER";
-      case ExpandMethod::BACKWARD:
-        return "BACKWARD";
-      case ExpandMethod::BACKWARD_WITH_BARRIER:
-        return "BACKWARD_WITH_BARRIER";
-      case ExpandMethod::BOTH:
-        return "BOTH";
-      case ExpandMethod::BOTH_WITH_BARRIER:
-        return "BOTH_WITH_BARRIER";
-      case ExpandMethod::BOTH_IGNORE_ORIGIN:
-        return "BOTH_IGNORE_ORIGIN";
-      default:
-        throw logic_error("invalid expand method");
-    }
-  }
-
-  ARCodeTranslator(const string& directory)
-      : log("[ar-trans] "),
-        directory(directory) {
-    while (ends_with(this->directory, "/")) {
-      this->directory.pop_back();
-    }
-    for (const auto& filename : list_directory(this->directory)) {
-      if (ends_with(filename, ".dol")) {
-        string name = filename.substr(0, filename.size() - 4);
-        string path = directory + "/" + filename;
-        this->files.emplace(name, make_shared<DOLFile>(path.c_str()));
-        this->log.info("Loaded %s", name.c_str());
-      }
-    }
-  }
-  ~ARCodeTranslator() = default;
-
-  const string& get_source_filename() const {
-    return this->src_filename;
-  }
-  void set_source_file(const string& filename) {
-    this->src_filename = filename;
-    this->src_file = this->files.at(this->src_filename);
-  }
-
-  void find_rtoc_global_regs() const {
-    for (const auto& it : this->files) {
-      bool r2_high_found = false;
-      bool r2_low_found = false;
-      bool r13_high_found = false;
-      bool r13_low_found = false;
-      uint32_t r2 = 0;
-      uint32_t r13 = 0;
-      for (const auto& section : it.second->sections) {
-        if (!section.is_text) {
-          continue;
-        }
-        StringReader r(section.data);
-        while (!r.eof() && r.where()) {
-          uint32_t opcode = r.get_u32b();
-          if ((opcode & 0xFFFF0000) == 0x3DA00000) {
-            if (r13_high_found) {
-              throw runtime_error("multiple values for r13_high");
-            }
-            r13_high_found = true;
-            r13 |= (opcode << 16);
-          } else if ((opcode & 0xFFFF0000) == 0x3C400000) {
-            if (r2_high_found) {
-              throw runtime_error("multiple values for r2_high");
-            }
-            r2_high_found = true;
-            r2 |= (opcode << 16);
-          } else if ((opcode & 0xFFFF0000) == 0x61AD0000) {
-            if (r13_low_found) {
-              throw runtime_error("multiple values for r13_low");
-            }
-            r13_low_found = true;
-            r13 |= (opcode & 0xFFFF);
-          } else if ((opcode & 0xFFFF0000) == 0x60420000) {
-            if (r2_low_found) {
-              throw runtime_error("multiple values for r2_low");
-            }
-            r2_low_found = true;
-            r2 |= (opcode & 0xFFFF);
-          }
-        }
-      }
-      if (r2_low_found && r2_high_found) {
-        fprintf(stderr, "(%s) r2 = %08" PRIX32 "\n", it.first.c_str(), r2);
-      } else {
-        fprintf(stderr, "(%s) r2 = __MISSING__\n", it.first.c_str());
-      }
-      if (r13_low_found && r13_high_found) {
-        fprintf(stderr, "(%s) r13 = %08" PRIX32 "\n", it.first.c_str(), r13);
-      } else {
-        fprintf(stderr, "(%s) r13 = __MISSING__\n", it.first.c_str());
-      }
-    }
-  }
-
-  uint32_t find_match(shared_ptr<const DOLFile> dest_file, uint32_t src_address, ExpandMethod expand_method) const {
-    if (!this->src_file) {
-      throw runtime_error("no source file selected");
-    }
-
-    const DOLFile::Section* src_section = nullptr;
-    for (const auto& sec : this->src_file->sections) {
-      if (src_address >= sec.address && src_address < sec.address + sec.data.size()) {
-        src_section = &sec;
-        break;
-      }
-    }
-    if (!src_section) {
-      throw runtime_error("source address not within any section");
-    }
-
-    const char* method_token = this->name_for_expand_method(expand_method);
-
-    size_t src_offset = src_address - src_section->address;
-    size_t src_bytes_available_before = src_offset;
-    size_t src_bytes_available_after = src_section->data.size() - src_offset - 4;
-    this->log.info("(find_match/%s) Source offset = %08zX with %zX/%zX bytes available before/after",
-        method_token, src_offset, src_bytes_available_before, src_bytes_available_after);
-
-    size_t match_bytes_before = 0;
-    size_t match_bytes_after = 0;
-    while (match_bytes_before + match_bytes_after + 4 < 0x100) {
-      size_t num_matches = 0;
-      size_t last_match_address = 0;
-      size_t match_length = match_bytes_before + match_bytes_after + 4;
-      StringReader src_r(src_section->data.data() + src_offset - match_bytes_before, match_length);
-      for (const auto& dest_section : dest_file->sections) {
-        for (size_t dest_match_offset = 0;
-             dest_match_offset < dest_section.data.size();
-             dest_match_offset += 4) {
-          src_r.go(0);
-          StringReader dest_r(dest_section.data.data() + dest_match_offset, match_length);
-          size_t z;
-          for (z = 0; z < match_length; z += 4) {
-            if (expand_method == ExpandMethod::BOTH_IGNORE_ORIGIN && z == match_bytes_before) {
-              src_r.skip(4);
-              dest_r.skip(4);
-            } else if (src_section->is_text) {
-              uint32_t src_opcode = src_r.get_u32b();
-              uint32_t dest_opcode = dest_r.get_u32b();
-              uint32_t src_class = src_opcode & 0xFC000000;
-              if (src_class != (dest_opcode & 0xFC000000)) {
-                break;
-              }
-              if (src_class == 0x48000000) {
-                // b +-offset
-                src_opcode &= 0xFC000003;
-                dest_opcode &= 0xFC000003;
-              } else if (((src_opcode & 0xAC1F0000) == 0x800D0000) || ((src_opcode & 0xAC1F0000) == 0x80020000)) {
-                // lwz/lfs rXX/fXX, [r2/r13 +- offset] OR stw/stfs [r2/r13 +- offset], rXX/fXX
-                src_opcode &= 0xFFFF0000;
-                dest_opcode &= 0xFFFF0000;
-              }
-              if (src_opcode != dest_opcode) {
-                break;
-              }
-            } else {
-              uint32_t src_data = src_r.get_u32b();
-              uint32_t dest_data = dest_r.get_u32b();
-              if ((src_data & 0xFE000000) == 0x80000000) {
-                src_data &= 0xFE000003;
-              }
-              if ((dest_data & 0xFE000000) == 0x80000000) {
-                dest_data &= 0xFE000003;
-              }
-              if (src_data != dest_data) {
-                break;
-              }
-            }
-          }
-          if (z == match_length) {
-            num_matches++;
-            last_match_address = dest_section.address + dest_match_offset + match_bytes_before;
-          }
-        }
-      }
-      this->log.info("(find_match/%s) For match length %zX, %zu matches found", method_token, match_length, num_matches);
-      if (num_matches == 1) {
-        return last_match_address;
-      } else if (num_matches == 0) {
-        throw runtime_error("did not find exactly one match");
-      }
-      bool can_expand_backward = false;
-      bool can_expand_forward = false;
-      switch (expand_method) {
-        case ExpandMethod::BACKWARD_WITH_BARRIER:
-          can_expand_backward = (src_r.pget_u32b(0) != 0x4E800020) &&
-              (src_bytes_available_before >= match_bytes_before + 4);
-          break;
-        case ExpandMethod::BACKWARD:
-          can_expand_backward = (src_bytes_available_before >= match_bytes_before + 4);
-          break;
-        case ExpandMethod::FORWARD_WITH_BARRIER:
-          can_expand_forward = (src_r.pget_u32b(src_r.size() - 4) != 0x4E800020) &&
-              (src_bytes_available_after >= match_bytes_after + 4);
-          break;
-        case ExpandMethod::FORWARD:
-          can_expand_forward = (src_bytes_available_after >= match_bytes_after + 4);
-          break;
-        case ExpandMethod::BOTH_WITH_BARRIER:
-        case ExpandMethod::BOTH_IGNORE_ORIGIN:
-          can_expand_backward = (src_r.pget_u32b(0) != 0x4E800020) &&
-              (src_bytes_available_before >= match_bytes_before + 4);
-          can_expand_forward = (src_r.pget_u32b(src_r.size() - 4) != 0x4E800020) &&
-              (src_bytes_available_after >= match_bytes_after + 4);
-          break;
-        case ExpandMethod::BOTH:
-          can_expand_backward = (src_bytes_available_before >= match_bytes_before + 4);
-          can_expand_forward = (src_bytes_available_after >= match_bytes_after + 4);
-          break;
-        default:
-          throw logic_error("invalid expand method");
-      }
-      if (!can_expand_backward && !can_expand_forward) {
-        throw runtime_error("no further expansion is allowed");
-      }
-      if (can_expand_backward) {
-        match_bytes_before += 4;
-      }
-      if (can_expand_forward) {
-        match_bytes_after += 4;
-      }
-    }
-    throw runtime_error("scan field too long; too many matches");
-  }
-
-  void find_all_matches(uint32_t src_addr) const {
-    if (!this->src_file) {
-      throw runtime_error("no source file selected");
-    }
-
-    unordered_map<string, uint32_t> results;
-    for (const auto& it : this->files) {
-      if (it.second == this->src_file) {
-        log.info("(%s) %08" PRIX32 " (from source)", it.first.c_str(), src_addr);
-        results.emplace(it.first, src_addr);
-      } else {
-
-        array<future<uint32_t>, 7> futures;
-        static const array<ExpandMethod, 7> methods = {
-            ExpandMethod::FORWARD,
-            ExpandMethod::FORWARD_WITH_BARRIER,
-            ExpandMethod::BACKWARD,
-            ExpandMethod::BACKWARD_WITH_BARRIER,
-            ExpandMethod::BOTH,
-            ExpandMethod::BOTH_WITH_BARRIER,
-            ExpandMethod::BOTH_IGNORE_ORIGIN,
-        };
-        for (size_t z = 0; z < methods.size(); z++) {
-          futures[z] = async(&ARCodeTranslator::find_match, this, it.second, src_addr, methods[z]);
-        }
-
-        unordered_set<uint32_t> match_addrs;
-        for (size_t z = 0; z < futures.size(); z++) {
-          const char* method_name = this->name_for_expand_method(methods[z]);
-          try {
-            uint32_t ret = futures[z].get();
-            log.info("(%s) (%s) %08" PRIX32, it.first.c_str(), method_name, ret);
-            match_addrs.emplace(ret);
-          } catch (const exception& e) {
-            log.error("(%s) (%s) failed: %s", it.first.c_str(), method_name, e.what());
-          }
-        }
-
-        if (match_addrs.empty()) {
-          log.error("(%s) no match found", it.first.c_str());
-        } else if (match_addrs.size() > 1) {
-          log.error("(%s) different matches found by different methods", it.first.c_str());
-        } else {
-          results.emplace(it.first, *match_addrs.begin());
-        }
-      }
-    }
-    for (const auto& it : results) {
-      fprintf(stdout, "%s => %08" PRIX32 "\n", it.first.c_str(), it.second);
-    }
-  }
-
-  void handle_command(const string& command) {
-    auto tokens = split(command, ' ');
-    if (tokens.empty()) {
-      throw runtime_error("no command given");
-    }
-    strip_trailing_whitespace(tokens[tokens.size() - 1]);
-
-    if (tokens[0] == "use") {
-      this->set_source_file(tokens.at(1));
-    } else if (tokens[0] == "match") {
-      this->find_all_matches(stoul(tokens.at(1), nullptr, 16));
-    } else if (tokens[0] == "find-globals") {
-      this->find_rtoc_global_regs();
-    } else if (!tokens[0].empty()) {
-      throw runtime_error("unknown command");
-    }
-  }
-
-  void run_shell() {
-    while (!feof(stdin)) {
-      if (!this->src_filename.empty()) {
-        fprintf(stdout, "ar-trans:%s/%s> ", this->directory.c_str(), this->src_filename.c_str());
-      } else {
-        fprintf(stdout, "ar-trans:%s> ", this->directory.c_str());
-      }
-      fflush(stdout);
-
-      string command = fgets(stdin);
-      try {
-        this->handle_command(command);
-      } catch (const exception& e) {
-        this->log.error("Failed: %s", e.what());
-      }
-    }
-    fputc('\n', stdout);
-  }
-
-private:
-  PrefixedLogger log;
-  string directory;
-  unordered_map<string, shared_ptr<const DOLFile>> files;
-  string src_filename;
-  shared_ptr<const DOLFile> src_file;
-};
-
-class XBEPatchTranslator {
-public:
-  enum class ExpandMethod {
-    FORWARD = 0,
-    BACKWARD,
-    BOTH,
-  };
-
-  static const char* name_for_expand_method(ExpandMethod method) {
-    switch (method) {
-      case ExpandMethod::FORWARD:
-        return "FORWARD";
-      case ExpandMethod::BACKWARD:
-        return "BACKWARD";
-      case ExpandMethod::BOTH:
-        return "BOTH";
-      default:
-        throw logic_error("invalid expand method");
-    }
-  }
-
-  XBEPatchTranslator(const string& directory)
-      : log("[xbe-trans] "),
-        directory(directory) {
-    while (ends_with(this->directory, "/")) {
-      this->directory.pop_back();
-    }
-    for (const auto& filename : list_directory(this->directory)) {
-      if (ends_with(filename, ".xbe")) {
-        string name = filename.substr(0, filename.size() - 4);
-        string path = directory + "/" + filename;
-        this->files.emplace(name, make_shared<XBEFile>(path.c_str()));
-        this->log.info("Loaded %s", name.c_str());
-      }
-    }
-  }
-  ~XBEPatchTranslator() = default;
-
-  const string& get_source_filename() const {
-    return this->src_filename;
-  }
-  void set_source_file(const string& filename) {
-    this->src_filename = filename;
-    this->src_file = this->files.at(this->src_filename);
-  }
-
-  uint32_t find_match(
-      shared_ptr<const XBEFile> dest_file,
-      uint32_t src_address,
-      uint32_t src_size,
-      ExpandMethod expand_method) const {
-    if (!this->src_file) {
-      throw runtime_error("no source file selected");
-    }
-
-    const XBEFile::Section* src_section = nullptr;
-    for (const auto& sec : this->src_file->sections) {
-      if (src_address >= sec.addr && src_address < sec.addr + sec.file_size) {
-        src_section = &sec;
-        break;
-      }
-    }
-    if (!src_section) {
-      throw runtime_error("source address not within any section");
-    }
-
-    const char* method_token = this->name_for_expand_method(expand_method);
-
-    size_t src_offset = src_address - src_section->addr;
-    size_t src_bytes_available_before = src_offset;
-    size_t src_bytes_available_after = src_section->file_size - src_offset - src_size;
-    this->log.info("(find_match/%s) Source offset = %08zX with %zX/%zX bytes available before/after",
-        method_token, src_offset, src_bytes_available_before, src_bytes_available_after);
-
-    size_t match_bytes_before = 0;
-    size_t match_bytes_after = 0;
-    while (match_bytes_before + match_bytes_after + src_size < 0x100) {
-      size_t num_matches = 0;
-      size_t last_match_address = 0;
-      size_t match_length = match_bytes_before + match_bytes_after + src_size;
-      auto src_r = this->src_file->read_from_addr(src_section->addr + src_offset - match_bytes_before, match_length);
-      for (const auto& dest_section : dest_file->sections) {
-        for (size_t dest_match_offset = 0; dest_match_offset + match_length <= dest_section.file_size; dest_match_offset++) {
-          src_r.go(0);
-          StringReader dest_r = dest_file->read_from_addr(dest_section.addr + dest_match_offset, match_length);
-          size_t z;
-          for (z = 0; z < match_length; z++) {
-            uint8_t src_data = src_r.get_u8();
-            uint8_t dest_data = dest_r.get_u8();
-            if (src_data != dest_data) {
-              break;
-            }
-          }
-          if (z == match_length) {
-            num_matches++;
-            last_match_address = dest_section.addr + dest_match_offset + match_bytes_before;
-          }
-        }
-      }
-      this->log.info("(find_match/%s) For match length %zX, %zu matches found", method_token, match_length, num_matches);
-      if (num_matches == 1) {
-        return last_match_address;
-      } else if (num_matches == 0) {
-        throw runtime_error("did not find exactly one match");
-      }
-      bool can_expand_backward = false;
-      bool can_expand_forward = false;
-      switch (expand_method) {
-        case ExpandMethod::BACKWARD:
-          can_expand_backward = (src_bytes_available_before > match_bytes_before);
-          break;
-        case ExpandMethod::FORWARD:
-          can_expand_forward = (src_bytes_available_after > match_bytes_after);
-          break;
-        case ExpandMethod::BOTH:
-          can_expand_backward = (src_bytes_available_before > match_bytes_before);
-          can_expand_forward = (src_bytes_available_after > match_bytes_after);
-          break;
-        default:
-          throw logic_error("invalid expand method");
-      }
-      if (!can_expand_backward && !can_expand_forward) {
-        throw runtime_error("no further expansion is allowed");
-      }
-      if (can_expand_backward) {
-        match_bytes_before++;
-      }
-      if (can_expand_forward) {
-        match_bytes_after++;
-      }
-    }
-    throw runtime_error("scan field too long; too many matches");
-  }
-
-  void find_all_matches(uint32_t src_addr, uint32_t src_size) const {
-    if (!this->src_file) {
-      throw runtime_error("no source file selected");
-    }
-
-    unordered_map<string, uint32_t> results;
-    for (const auto& it : files) {
-      if (it.second == this->src_file) {
-        log.info("(%s) %08" PRIX32 " (from source)", it.first.c_str(), src_addr);
-        results.emplace(it.first, src_addr);
-      } else {
-
-        array<future<uint32_t>, 3> futures;
-        static const array<ExpandMethod, 3> methods = {
-            ExpandMethod::FORWARD,
-            ExpandMethod::BACKWARD,
-            ExpandMethod::BOTH,
-        };
-        for (size_t z = 0; z < methods.size(); z++) {
-          futures[z] = async(&XBEPatchTranslator::find_match, this, it.second, src_addr, src_size, methods[z]);
-        }
-
-        unordered_set<uint32_t> match_addrs;
-        for (size_t z = 0; z < futures.size(); z++) {
-          const char* method_name = this->name_for_expand_method(methods[z]);
-          try {
-            uint32_t ret = futures[z].get();
-            log.info("(%s) (%s) %08" PRIX32, it.first.c_str(), method_name, ret);
-            match_addrs.emplace(ret);
-          } catch (const exception& e) {
-            log.error("(%s) (%s) failed: %s", it.first.c_str(), method_name, e.what());
-          }
-        }
-
-        if (match_addrs.empty()) {
-          log.error("(%s) no match found", it.first.c_str());
-        } else if (match_addrs.size() > 1) {
-          log.error("(%s) different matches found by different methods", it.first.c_str());
-        } else {
-          results.emplace(it.first, *match_addrs.begin());
-        }
-      }
-    }
-    for (const auto& it : results) {
-      fprintf(stdout, "%s => %08" PRIX32 "\n", it.first.c_str(), it.second);
-    }
-  }
-
-  void handle_command(const string& command) {
-    auto tokens = split(command, ' ');
-    if (tokens.empty()) {
-      throw runtime_error("no command given");
-    }
-    strip_trailing_whitespace(tokens[tokens.size() - 1]);
-
-    if (tokens[0] == "use") {
-      this->set_source_file(tokens.at(1));
-    } else if (tokens[0] == "match") {
-      this->find_all_matches(stoul(tokens.at(1), nullptr, 16), stoul(tokens.at(2), nullptr, 16));
-    } else if (!tokens[0].empty()) {
-      throw runtime_error("unknown command");
-    }
-  }
-
-  void run_shell() {
-    while (!feof(stdin)) {
-      if (!this->src_filename.empty()) {
-        fprintf(stdout, "ar-trans:%s/%s> ", this->directory.c_str(), this->src_filename.c_str());
-      } else {
-        fprintf(stdout, "ar-trans:%s> ", this->directory.c_str());
-      }
-      fflush(stdout);
-
-      string command = fgets(stdin);
-      try {
-        this->handle_command(command);
-      } catch (const exception& e) {
-        this->log.error("Failed: %s", e.what());
-      }
-    }
-    fputc('\n', stdout);
-  }
-
-private:
-  PrefixedLogger log;
-  string directory;
-  unordered_map<string, shared_ptr<const XBEFile>> files;
-  string src_filename;
-  shared_ptr<const XBEFile> src_file;
-};
-
-void run_ar_code_translator(const std::string& directory, const std::string& use_filename, const std::string& command) {
-  ARCodeTranslator trans(directory);
-  if (!use_filename.empty()) {
-    trans.set_source_file(use_filename);
-  }
-
-  if (!command.empty()) {
-    trans.handle_command(command);
-  } else {
-    trans.run_shell();
-  }
-}
-
-void run_xbe_patch_translator(const std::string& directory, const std::string& use_filename, const std::string& command) {
-  XBEPatchTranslator trans(directory);
-  if (!use_filename.empty()) {
-    trans.set_source_file(use_filename);
-  }
-
-  if (!command.empty()) {
-    trans.handle_command(command);
-  } else {
-    trans.run_shell();
-  }
-}
-
-vector<pair<uint32_t, string>> diff_dol_files(const string& a_filename, const string& b_filename) {
-  DOLFile a(a_filename.c_str());
-  DOLFile b(b_filename.c_str());
-  auto a_mem = make_shared<MemoryContext>();
-  auto b_mem = make_shared<MemoryContext>();
-  a.load_into(a_mem);
-  b.load_into(b_mem);
-
-  uint32_t min_addr = 0xFFFFFFFF;
-  uint32_t max_addr = 0x00000000;
-  for (const auto& sec : a.sections) {
-    min_addr = min<uint32_t>(min_addr, sec.address);
-    max_addr = max<uint32_t>(max_addr, sec.address + sec.data.size());
-  }
-  for (const auto& sec : b.sections) {
-    min_addr = min<uint32_t>(min_addr, sec.address);
-    max_addr = max<uint32_t>(max_addr, sec.address + sec.data.size());
-  }
-
-  vector<pair<uint32_t, string>> ret;
-  for (uint32_t addr = min_addr; addr < max_addr; addr += 4) {
-    bool a_exists = a_mem->exists(addr, 4);
-    bool b_exists = b_mem->exists(addr, 4);
-    if (a_exists && b_exists) {
-      string a_value = a_mem->read(addr, 4);
-      string b_value = b_mem->read(addr, 4);
-      if (a_value != b_value) {
-        if (!ret.empty() && (ret.back().first + ret.back().second.size() == addr)) {
-          ret.back().second += b_value;
-        } else {
-          ret.emplace_back(make_pair(addr, b_value));
-        }
-      }
-    }
-  }
-  return ret;
-}

src/ARCodeTranslator.hh

@@ -1,11 +0,0 @@
-#pragma once
-
-#include <stdint.h>
-
-#include <string>
-#include <utility>
-#include <vector>
-
-void run_ar_code_translator(const std::string& directory, const std::string& use_filename, const std::string& command);
-void run_xbe_patch_translator(const std::string& directory, const std::string& use_filename, const std::string& command);
-std::vector<std::pair<uint32_t, std::string>> diff_dol_files(const std::string& a_filename, const std::string& b_filename);

src/Account.hh

@@ -1,263 +1,263 @@
-#pragma once
-
-#include <memory>
-#include <mutex>
-#include <phosg/JSON.hh>
-#include <shared_mutex>
-#include <string>
-#include <unordered_map>
-#include <vector>
-
-#include "Text.hh"
-
-class LicenseIndex;
-
-struct DCNTELicense {
-  std::string serial_number;
-  std::string access_key;
-
-  static std::shared_ptr<DCNTELicense> from_json(const JSON& json);
-  JSON json() const;
-};
-
-struct V1V2License {
-  uint32_t serial_number = 0;
-  std::string access_key;
-
-  static std::shared_ptr<V1V2License> from_json(const JSON& json);
-  JSON json() const;
-};
-
-struct GCLicense {
-  uint32_t serial_number = 0;
-  std::string access_key;
-  std::string password;
-
-  static std::shared_ptr<GCLicense> from_json(const JSON& json);
-  JSON json() const;
-};
-
-struct XBLicense {
-  std::string gamertag;
-  uint64_t user_id = 0;
-  uint64_t account_id = 0;
-
-  static std::shared_ptr<XBLicense> from_json(const JSON& json);
-  JSON json() const;
-};
-
-struct BBLicense {
-  std::string username;
-  std::string password;
-
-  static std::shared_ptr<BBLicense> from_json(const JSON& json);
-  JSON json() const;
-};
-
-struct Account {
-  enum class Flag : uint32_t {
-    // clang-format off
-    KICK_USER                   = 0x00000001,
-    BAN_USER                    = 0x00000002,
-    SILENCE_USER                = 0x00000004,
-    CHANGE_EVENT                = 0x00000010,
-    ANNOUNCE                    = 0x00000020,
-    FREE_JOIN_GAMES             = 0x00000040,
-    DEBUG                       = 0x01000000,
-    CHEAT_ANYWHERE              = 0x02000000,
-    DISABLE_QUEST_REQUIREMENTS  = 0x04000000,
-    ALWAYS_ENABLE_CHAT_COMMANDS = 0x08000000,
-    MODERATOR                   = 0x00000007,
-    ADMINISTRATOR               = 0x000000FF,
-    ROOT                        = 0x7FFFFFFF,
-    IS_SHARED_ACCOUNT           = 0x80000000,
-    // NOTE: When adding or changing license flags, don't forget to change the
-    // documentation in the shell's help text.
-    UNUSED_BITS                 = 0x70FFFF00,
-    // clang-format on
-  };
-
-  // account_id is also the account's guild card number
-  uint32_t account_id = 0;
-
-  uint32_t flags = 0;
-  uint64_t ban_end_time = 0; // 0 = not banned
-  std::string last_player_name;
-  std::string auto_reply_message;
-
-  uint32_t ep3_current_meseta = 0;
-  uint32_t ep3_total_meseta_earned = 0;
-
-  uint32_t bb_team_id = 0;
-  bool is_temporary = false; // If true, isn't saved to disk
-
-  std::unordered_set<std::string> auto_patches_enabled;
-
-  std::unordered_map<std::string, std::shared_ptr<DCNTELicense>> dc_nte_licenses;
-  std::unordered_map<uint32_t, std::shared_ptr<V1V2License>> dc_licenses;
-  std::unordered_map<uint32_t, std::shared_ptr<V1V2License>> pc_licenses;
-  std::unordered_map<uint32_t, std::shared_ptr<GCLicense>> gc_licenses;
-  std::unordered_map<std::string, std::shared_ptr<XBLicense>> xb_licenses;
-  std::unordered_map<std::string, std::shared_ptr<BBLicense>> bb_licenses;
-
-  Account() = default;
-  explicit Account(const JSON& json);
-  virtual ~Account() = default;
-
-  JSON json() const;
-  virtual void save() const;
-  virtual void delete_file() const;
-
-  [[nodiscard]] inline bool check_flag(Flag flag) const {
-    return !!(this->flags & static_cast<uint32_t>(flag));
-  }
-  inline void set_flag(Flag flag) {
-    this->flags |= static_cast<uint32_t>(flag);
-  }
-  inline void clear_flag(Flag flag) {
-    this->flags &= (~static_cast<uint32_t>(flag));
-  }
-  inline void toggle_flag(Flag flag) {
-    this->flags ^= static_cast<uint32_t>(flag);
-  }
-  inline void replace_all_flags(Flag mask) {
-    this->flags = static_cast<uint32_t>(mask);
-  }
-
-  void print(FILE* stream) const;
-};
-
-struct Login {
-  bool account_was_created = false;
-  // This field will never be null
-  std::shared_ptr<Account> account;
-  // Exactly one of the following will be non-null, representing the license
-  // that the client logged in with
-  std::shared_ptr<DCNTELicense> dc_nte_license;
-  std::shared_ptr<V1V2License> dc_license;
-  std::shared_ptr<V1V2License> pc_license;
-  std::shared_ptr<GCLicense> gc_license;
-  std::shared_ptr<XBLicense> xb_license;
-  std::shared_ptr<BBLicense> bb_license;
-};
-
-class AccountIndex {
-public:
-  class no_username : public std::invalid_argument {
-  public:
-    no_username() : invalid_argument("serial number is zero or username is missing") {}
-  };
-  class incorrect_password : public std::invalid_argument {
-  public:
-    incorrect_password() : invalid_argument("incorrect password") {}
-  };
-  class incorrect_access_key : public std::invalid_argument {
-  public:
-    incorrect_access_key() : invalid_argument("incorrect access key") {}
-  };
-  class missing_account : public std::invalid_argument {
-  public:
-    missing_account() : invalid_argument("missing account") {}
-  };
-
-  explicit AccountIndex(bool force_all_temporary);
-  virtual ~AccountIndex() = default;
-
-  std::shared_ptr<Account> create_account(bool is_temporary) const;
-
-  size_t count() const;
-  std::vector<std::shared_ptr<Account>> all() const;
-
-  void add(std::shared_ptr<Account> a);
-  void remove(uint32_t serial_number);
-
-  void add_dc_nte_license(std::shared_ptr<Account> account, std::shared_ptr<DCNTELicense> license);
-  void add_dc_license(std::shared_ptr<Account> account, std::shared_ptr<V1V2License> license);
-  void add_pc_license(std::shared_ptr<Account> account, std::shared_ptr<V1V2License> license);
-  void add_gc_license(std::shared_ptr<Account> account, std::shared_ptr<GCLicense> license);
-  void add_xb_license(std::shared_ptr<Account> account, std::shared_ptr<XBLicense> license);
-  void add_bb_license(std::shared_ptr<Account> account, std::shared_ptr<BBLicense> license);
-  void remove_dc_nte_license(std::shared_ptr<Account> account, const std::string& serial_number);
-  void remove_dc_license(std::shared_ptr<Account> account, uint32_t serial_number);
-  void remove_pc_license(std::shared_ptr<Account> account, uint32_t serial_number);
-  void remove_gc_license(std::shared_ptr<Account> account, uint32_t serial_number);
-  void remove_xb_license(std::shared_ptr<Account> account, const std::string& gamertag);
-  void remove_bb_license(std::shared_ptr<Account> account, const std::string& username);
-
-  std::shared_ptr<Account> from_account_id(uint32_t account_id) const;
-  std::shared_ptr<Login> from_dc_nte_credentials(
-      const std::string& serial_number,
-      const std::string& access_key,
-      bool allow_create);
-  std::shared_ptr<Login> from_dc_credentials(
-      uint32_t serial_number,
-      const std::string& access_key,
-      const std::string& character_name,
-      bool allow_create);
-  std::shared_ptr<Login> from_pc_nte_credentials(
-      uint32_t guild_card_number,
-      bool allow_create);
-  std::shared_ptr<Login> from_pc_credentials(
-      uint32_t serial_number,
-      const std::string& access_key,
-      const std::string& character_name,
-      bool allow_create);
-  std::shared_ptr<Login> from_gc_credentials(
-      uint32_t serial_number,
-      const std::string& access_key,
-      const std::string* password,
-      const std::string& character_name,
-      bool allow_create);
-  std::shared_ptr<Login> from_xb_credentials(
-      const std::string& gamertag,
-      uint64_t user_id,
-      uint64_t account_id,
-      bool allow_create);
-  std::shared_ptr<Login> from_bb_credentials(
-      const std::string& username,
-      const std::string* password,
-      bool allow_create);
-
-  std::shared_ptr<Account> create_temporary_account_for_shared_account(
-      std::shared_ptr<const Account> src_a, const std::string& variation_data) const;
-
-protected:
-  bool force_all_temporary;
-
-  // This class must be thread-safe because it's used by both the patch server
-  // and game server threads
-  mutable std::shared_mutex lock;
-  std::unordered_map<uint32_t, std::shared_ptr<Account>> by_account_id;
-  std::unordered_map<std::string, std::shared_ptr<Account>> by_dc_nte_serial_number;
-  std::unordered_map<uint32_t, std::shared_ptr<Account>> by_dc_serial_number;
-  std::unordered_map<uint32_t, std::shared_ptr<Account>> by_pc_serial_number;
-  std::unordered_map<uint32_t, std::shared_ptr<Account>> by_gc_serial_number;
-  std::unordered_map<std::string, std::shared_ptr<Account>> by_xb_gamertag;
-  std::unordered_map<std::string, std::shared_ptr<Account>> by_bb_username;
-
-  void add_locked(std::shared_ptr<Account> a);
-
-  std::shared_ptr<Login> from_dc_nte_credentials_locked(
-      const std::string& serial_number,
-      const std::string& access_key);
-  std::shared_ptr<Login> from_dc_credentials_locked(
-      uint32_t serial_number,
-      const std::string& access_key,
-      const std::string& character_name);
-  std::shared_ptr<Login> from_pc_credentials_locked(
-      uint32_t serial_number,
-      const std::string& access_key,
-      const std::string& character_name);
-  std::shared_ptr<Login> from_gc_credentials_locked(
-      uint32_t serial_number,
-      const std::string& access_key,
-      const std::string* password,
-      const std::string& character_name);
-  std::shared_ptr<Login> from_xb_credentials_locked(
-      const std::string& gamertag,
-      uint64_t user_id,
-      uint64_t account_id);
-  std::shared_ptr<Login> from_bb_credentials_locked(
-      const std::string& username,
-      const std::string* password);
-};
+#pragma once
+
+#include <memory>
+#include <mutex>
+#include <phosg/JSON.hh>
+#include <shared_mutex>
+#include <string>
+#include <unordered_map>
+#include <vector>
+
+#include "Text.hh"
+
+class LicenseIndex;
+
+struct DCNTELicense {
+  std::string serial_number;
+  std::string access_key;
+
+  static std::shared_ptr<DCNTELicense> from_json(const JSON& json);
+  JSON json() const;
+};
+
+struct V1V2License {
+  uint32_t serial_number = 0;
+  std::string access_key;
+
+  static std::shared_ptr<V1V2License> from_json(const JSON& json);
+  JSON json() const;
+};
+
+struct GCLicense {
+  uint32_t serial_number = 0;
+  std::string access_key;
+  std::string password;
+
+  static std::shared_ptr<GCLicense> from_json(const JSON& json);
+  JSON json() const;
+};
+
+struct XBLicense {
+  std::string gamertag;
+  uint64_t user_id = 0;
+  uint64_t account_id = 0;
+
+  static std::shared_ptr<XBLicense> from_json(const JSON& json);
+  JSON json() const;
+};
+
+struct BBLicense {
+  std::string username;
+  std::string password;
+
+  static std::shared_ptr<BBLicense> from_json(const JSON& json);
+  JSON json() const;
+};
+
+struct Account {
+  enum class Flag : uint32_t {
+    // clang-format off
+    KICK_USER                   = 0x00000001,
+    BAN_USER                    = 0x00000002,
+    SILENCE_USER                = 0x00000004,
+    CHANGE_EVENT                = 0x00000010,
+    ANNOUNCE                    = 0x00000020,
+    FREE_JOIN_GAMES             = 0x00000040,
+    DEBUG                       = 0x01000000,
+    CHEAT_ANYWHERE              = 0x02000000,
+    DISABLE_QUEST_REQUIREMENTS  = 0x04000000,
+    ALWAYS_ENABLE_CHAT_COMMANDS = 0x08000000,
+    MODERATOR                   = 0x00000007,
+    ADMINISTRATOR               = 0x000000FF,
+    ROOT                        = 0x7FFFFFFF,
+    IS_SHARED_ACCOUNT           = 0x80000000,
+    // NOTE: When adding or changing license flags, don't forget to change the
+    // documentation in the shell's help text.
+    UNUSED_BITS                 = 0x70FFFF00,
+    // clang-format on
+  };
+
+  // account_id is also the account's guild card number
+  uint32_t account_id = 0;
+
+  uint32_t flags = 0;
+  uint64_t ban_end_time = 0; // 0 = not banned
+  std::string last_player_name;
+  std::string auto_reply_message;
+
+  uint32_t ep3_current_meseta = 0;
+  uint32_t ep3_total_meseta_earned = 0;
+
+  uint32_t bb_team_id = 0;
+  bool is_temporary = false; // If true, isn't saved to disk
+
+  std::unordered_set<std::string> auto_patches_enabled;
+
+  std::unordered_map<std::string, std::shared_ptr<DCNTELicense>> dc_nte_licenses;
+  std::unordered_map<uint32_t, std::shared_ptr<V1V2License>> dc_licenses;
+  std::unordered_map<uint32_t, std::shared_ptr<V1V2License>> pc_licenses;
+  std::unordered_map<uint32_t, std::shared_ptr<GCLicense>> gc_licenses;
+  std::unordered_map<std::string, std::shared_ptr<XBLicense>> xb_licenses;
+  std::unordered_map<std::string, std::shared_ptr<BBLicense>> bb_licenses;
+
+  Account() = default;
+  explicit Account(const JSON& json);
+  virtual ~Account() = default;
+
+  JSON json() const;
+  virtual void save() const;
+  virtual void delete_file() const;
+
+  [[nodiscard]] inline bool check_flag(Flag flag) const {
+    return !!(this->flags & static_cast<uint32_t>(flag));
+  }
+  inline void set_flag(Flag flag) {
+    this->flags |= static_cast<uint32_t>(flag);
+  }
+  inline void clear_flag(Flag flag) {
+    this->flags &= (~static_cast<uint32_t>(flag));
+  }
+  inline void toggle_flag(Flag flag) {
+    this->flags ^= static_cast<uint32_t>(flag);
+  }
+  inline void replace_all_flags(Flag mask) {
+    this->flags = static_cast<uint32_t>(mask);
+  }
+
+  void print(FILE* stream) const;
+};
+
+struct Login {
+  bool account_was_created = false;
+  // This field will never be null
+  std::shared_ptr<Account> account;
+  // Exactly one of the following will be non-null, representing the license
+  // that the client logged in with
+  std::shared_ptr<DCNTELicense> dc_nte_license;
+  std::shared_ptr<V1V2License> dc_license;
+  std::shared_ptr<V1V2License> pc_license;
+  std::shared_ptr<GCLicense> gc_license;
+  std::shared_ptr<XBLicense> xb_license;
+  std::shared_ptr<BBLicense> bb_license;
+};
+
+class AccountIndex {
+public:
+  class no_username : public std::invalid_argument {
+  public:
+    no_username() : invalid_argument("serial number is zero or username is missing") {}
+  };
+  class incorrect_password : public std::invalid_argument {
+  public:
+    incorrect_password() : invalid_argument("incorrect password") {}
+  };
+  class incorrect_access_key : public std::invalid_argument {
+  public:
+    incorrect_access_key() : invalid_argument("incorrect access key") {}
+  };
+  class missing_account : public std::invalid_argument {
+  public:
+    missing_account() : invalid_argument("missing account") {}
+  };
+
+  explicit AccountIndex(bool force_all_temporary);
+  virtual ~AccountIndex() = default;
+
+  std::shared_ptr<Account> create_account(bool is_temporary) const;
+
+  size_t count() const;
+  std::vector<std::shared_ptr<Account>> all() const;
+
+  void add(std::shared_ptr<Account> a);
+  void remove(uint32_t serial_number);
+
+  void add_dc_nte_license(std::shared_ptr<Account> account, std::shared_ptr<DCNTELicense> license);
+  void add_dc_license(std::shared_ptr<Account> account, std::shared_ptr<V1V2License> license);
+  void add_pc_license(std::shared_ptr<Account> account, std::shared_ptr<V1V2License> license);
+  void add_gc_license(std::shared_ptr<Account> account, std::shared_ptr<GCLicense> license);
+  void add_xb_license(std::shared_ptr<Account> account, std::shared_ptr<XBLicense> license);
+  void add_bb_license(std::shared_ptr<Account> account, std::shared_ptr<BBLicense> license);
+  void remove_dc_nte_license(std::shared_ptr<Account> account, const std::string& serial_number);
+  void remove_dc_license(std::shared_ptr<Account> account, uint32_t serial_number);
+  void remove_pc_license(std::shared_ptr<Account> account, uint32_t serial_number);
+  void remove_gc_license(std::shared_ptr<Account> account, uint32_t serial_number);
+  void remove_xb_license(std::shared_ptr<Account> account, const std::string& gamertag);
+  void remove_bb_license(std::shared_ptr<Account> account, const std::string& username);
+
+  std::shared_ptr<Account> from_account_id(uint32_t account_id) const;
+  std::shared_ptr<Login> from_dc_nte_credentials(
+      const std::string& serial_number,
+      const std::string& access_key,
+      bool allow_create);
+  std::shared_ptr<Login> from_dc_credentials(
+      uint32_t serial_number,
+      const std::string& access_key,
+      const std::string& character_name,
+      bool allow_create);
+  std::shared_ptr<Login> from_pc_nte_credentials(
+      uint32_t guild_card_number,
+      bool allow_create);
+  std::shared_ptr<Login> from_pc_credentials(
+      uint32_t serial_number,
+      const std::string& access_key,
+      const std::string& character_name,
+      bool allow_create);
+  std::shared_ptr<Login> from_gc_credentials(
+      uint32_t serial_number,
+      const std::string& access_key,
+      const std::string* password,
+      const std::string& character_name,
+      bool allow_create);
+  std::shared_ptr<Login> from_xb_credentials(
+      const std::string& gamertag,
+      uint64_t user_id,
+      uint64_t account_id,
+      bool allow_create);
+  std::shared_ptr<Login> from_bb_credentials(
+      const std::string& username,
+      const std::string* password,
+      bool allow_create);
+
+  std::shared_ptr<Account> create_temporary_account_for_shared_account(
+      std::shared_ptr<const Account> src_a, const std::string& variation_data) const;
+
+protected:
+  bool force_all_temporary;
+
+  // This class must be thread-safe because it's used by both the patch server
+  // and game server threads
+  mutable std::shared_mutex lock;
+  std::unordered_map<uint32_t, std::shared_ptr<Account>> by_account_id;
+  std::unordered_map<std::string, std::shared_ptr<Account>> by_dc_nte_serial_number;
+  std::unordered_map<uint32_t, std::shared_ptr<Account>> by_dc_serial_number;
+  std::unordered_map<uint32_t, std::shared_ptr<Account>> by_pc_serial_number;
+  std::unordered_map<uint32_t, std::shared_ptr<Account>> by_gc_serial_number;
+  std::unordered_map<std::string, std::shared_ptr<Account>> by_xb_gamertag;
+  std::unordered_map<std::string, std::shared_ptr<Account>> by_bb_username;
+
+  void add_locked(std::shared_ptr<Account> a);
+
+  std::shared_ptr<Login> from_dc_nte_credentials_locked(
+      const std::string& serial_number,
+      const std::string& access_key);
+  std::shared_ptr<Login> from_dc_credentials_locked(
+      uint32_t serial_number,
+      const std::string& access_key,
+      const std::string& character_name);
+  std::shared_ptr<Login> from_pc_credentials_locked(
+      uint32_t serial_number,
+      const std::string& access_key,
+      const std::string& character_name);
+  std::shared_ptr<Login> from_gc_credentials_locked(
+      uint32_t serial_number,
+      const std::string& access_key,
+      const std::string* password,
+      const std::string& character_name);
+  std::shared_ptr<Login> from_xb_credentials_locked(
+      const std::string& gamertag,
+      uint64_t user_id,
+      uint64_t account_id);
+  std::shared_ptr<Login> from_bb_credentials_locked(
+      const std::string& username,
+      const std::string* password);
+};

src/AddressTranslator-Stub.hh

@@ -0,0 +1,14 @@
+#pragma once
+
+#include <stdexcept>
+#include <string>
+#include <utility>
+#include <vector>
+
+inline void run_address_translator(const std::string&, const std::string&, const std::string&) {
+  throw std::runtime_error("resource_file is not available; install it and rebuild newserv");
+}
+
+inline std::vector<std::pair<uint32_t, std::string>> diff_dol_files(const std::string&, const std::string&) {
+  throw std::runtime_error("resource_file is not available; install it and rebuild newserv");
+}

src/AddressTranslator.cc

@@ -0,0 +1,528 @@
+#include "AddressTranslator.hh"
+
+#include <array>
+#include <future>
+#include <phosg/Filesystem.hh>
+#include <phosg/Strings.hh>
+#include <resource_file/ExecutableFormats/DOLFile.hh>
+#include <resource_file/ExecutableFormats/XBEFile.hh>
+
+using namespace std;
+
+class AddressTranslator {
+public:
+  enum class ExpandMethod {
+    PPC_TEXT_FORWARD = 0,
+    PPC_TEXT_FORWARD_WITH_BARRIER,
+    PPC_TEXT_BACKWARD,
+    PPC_TEXT_BACKWARD_WITH_BARRIER,
+    PPC_TEXT_BOTH,
+    PPC_TEXT_BOTH_WITH_BARRIER,
+    PPC_TEXT_BOTH_IGNORE_ORIGIN,
+    PPC_DATA_FORWARD,
+    PPC_DATA_BACKWARD,
+    PPC_DATA_BOTH,
+    RAW_FORWARD,
+    RAW_BACKWARD,
+    RAW_BOTH,
+  };
+
+  static const char* name_for_expand_method(ExpandMethod method) {
+    switch (method) {
+      case ExpandMethod::PPC_TEXT_FORWARD:
+        return "PPC_TEXT_FORWARD";
+      case ExpandMethod::PPC_TEXT_FORWARD_WITH_BARRIER:
+        return "PPC_TEXT_FORWARD_WITH_BARRIER";
+      case ExpandMethod::PPC_TEXT_BACKWARD:
+        return "PPC_TEXT_BACKWARD";
+      case ExpandMethod::PPC_TEXT_BACKWARD_WITH_BARRIER:
+        return "PPC_TEXT_BACKWARD_WITH_BARRIER";
+      case ExpandMethod::PPC_TEXT_BOTH:
+        return "PPC_TEXT_BOTH";
+      case ExpandMethod::PPC_TEXT_BOTH_WITH_BARRIER:
+        return "PPC_TEXT_BOTH_WITH_BARRIER";
+      case ExpandMethod::PPC_TEXT_BOTH_IGNORE_ORIGIN:
+        return "PPC_TEXT_BOTH_IGNORE_ORIGIN";
+      case ExpandMethod::PPC_DATA_FORWARD:
+        return "PPC_DATA_FORWARD";
+      case ExpandMethod::PPC_DATA_BACKWARD:
+        return "PPC_DATA_BACKWARD";
+      case ExpandMethod::PPC_DATA_BOTH:
+        return "PPC_DATA_BOTH";
+      case ExpandMethod::RAW_FORWARD:
+        return "RAW_FORWARD";
+      case ExpandMethod::RAW_BACKWARD:
+        return "RAW_BACKWARD";
+      case ExpandMethod::RAW_BOTH:
+        return "RAW_BOTH";
+      default:
+        throw logic_error("invalid expand method");
+    }
+  }
+
+  static bool is_ppc_expand_method(ExpandMethod method) {
+    switch (method) {
+      case ExpandMethod::PPC_TEXT_FORWARD:
+      case ExpandMethod::PPC_TEXT_FORWARD_WITH_BARRIER:
+      case ExpandMethod::PPC_TEXT_BACKWARD:
+      case ExpandMethod::PPC_TEXT_BACKWARD_WITH_BARRIER:
+      case ExpandMethod::PPC_TEXT_BOTH:
+      case ExpandMethod::PPC_TEXT_BOTH_WITH_BARRIER:
+      case ExpandMethod::PPC_TEXT_BOTH_IGNORE_ORIGIN:
+      case ExpandMethod::PPC_DATA_FORWARD:
+      case ExpandMethod::PPC_DATA_BACKWARD:
+      case ExpandMethod::PPC_DATA_BOTH:
+        return true;
+      case ExpandMethod::RAW_FORWARD:
+      case ExpandMethod::RAW_BACKWARD:
+      case ExpandMethod::RAW_BOTH:
+        return false;
+      default:
+        throw logic_error("invalid expand method");
+    }
+  }
+
+  static bool is_ppc_data_expand_method(ExpandMethod method) {
+    switch (method) {
+      case ExpandMethod::PPC_DATA_FORWARD:
+      case ExpandMethod::PPC_DATA_BACKWARD:
+      case ExpandMethod::PPC_DATA_BOTH:
+        return true;
+      case ExpandMethod::PPC_TEXT_FORWARD:
+      case ExpandMethod::PPC_TEXT_FORWARD_WITH_BARRIER:
+      case ExpandMethod::PPC_TEXT_BACKWARD:
+      case ExpandMethod::PPC_TEXT_BACKWARD_WITH_BARRIER:
+      case ExpandMethod::PPC_TEXT_BOTH:
+      case ExpandMethod::PPC_TEXT_BOTH_WITH_BARRIER:
+      case ExpandMethod::PPC_TEXT_BOTH_IGNORE_ORIGIN:
+      case ExpandMethod::RAW_FORWARD:
+      case ExpandMethod::RAW_BACKWARD:
+      case ExpandMethod::RAW_BOTH:
+        return false;
+      default:
+        throw logic_error("invalid expand method");
+    }
+  }
+
+  AddressTranslator(const string& directory)
+      : log("[addr-trans] "),
+        directory(directory),
+        enable_ppc(false) {
+    while (ends_with(this->directory, "/")) {
+      this->directory.pop_back();
+    }
+    for (const auto& filename : list_directory(this->directory)) {
+      if (ends_with(filename, ".dol")) {
+        string name = filename.substr(0, filename.size() - 4);
+        string path = directory + "/" + filename;
+        DOLFile dol(path.c_str());
+        auto mem = make_shared<MemoryContext>();
+        dol.load_into(mem);
+        this->mems.emplace(name, mem);
+        this->enable_ppc = true;
+        this->log.info("Loaded %s", name.c_str());
+      } else if (ends_with(filename, ".xbe")) {
+        string name = filename.substr(0, filename.size() - 4);
+        string path = directory + "/" + filename;
+        XBEFile xbe(path.c_str());
+        auto mem = make_shared<MemoryContext>();
+        xbe.load_into(mem);
+        this->mems.emplace(name, mem);
+        this->log.info("Loaded %s", name.c_str());
+      } else if (ends_with(filename, ".bin")) {
+        string name = filename.substr(0, filename.size() - 4);
+        string path = directory + "/" + filename;
+        string data = load_file(path);
+        auto mem = make_shared<MemoryContext>();
+        mem->allocate_at(0x8C010000, data.size());
+        mem->memcpy(0x8C010000, data.data(), data.size());
+        this->mems.emplace(name, mem);
+        this->log.info("Loaded %s", name.c_str());
+      }
+    }
+  }
+  ~AddressTranslator() = default;
+
+  const string& get_source_filename() const {
+    return this->src_filename;
+  }
+  void set_source_file(const string& filename) {
+    this->src_filename = filename;
+    this->src_mem = this->mems.at(this->src_filename);
+  }
+
+  void find_ppc_rtoc_global_regs() const {
+    for (const auto& it : this->mems) {
+      bool r2_high_found = false;
+      bool r2_low_found = false;
+      bool r13_high_found = false;
+      bool r13_low_found = false;
+      uint32_t r2 = 0;
+      uint32_t r13 = 0;
+      for (const auto& block : it.second->allocated_blocks()) {
+        StringReader r = it.second->reader(block.first, block.second);
+        while (!r.eof() && r.where()) {
+          uint32_t opcode = r.get_u32b();
+          if ((opcode & 0xFFFF0000) == 0x3DA00000) {
+            if (r13_high_found) {
+              throw runtime_error("multiple values for r13_high");
+            }
+            r13_high_found = true;
+            r13 |= (opcode << 16);
+          } else if ((opcode & 0xFFFF0000) == 0x3C400000) {
+            if (r2_high_found) {
+              throw runtime_error("multiple values for r2_high");
+            }
+            r2_high_found = true;
+            r2 |= (opcode << 16);
+          } else if ((opcode & 0xFFFF0000) == 0x61AD0000) {
+            if (r13_low_found) {
+              throw runtime_error("multiple values for r13_low");
+            }
+            r13_low_found = true;
+            r13 |= (opcode & 0xFFFF);
+          } else if ((opcode & 0xFFFF0000) == 0x60420000) {
+            if (r2_low_found) {
+              throw runtime_error("multiple values for r2_low");
+            }
+            r2_low_found = true;
+            r2 |= (opcode & 0xFFFF);
+          }
+        }
+      }
+      if (r2_low_found && r2_high_found) {
+        fprintf(stderr, "(%s) r2 = %08" PRIX32 "\n", it.first.c_str(), r2);
+      } else {
+        fprintf(stderr, "(%s) r2 = __MISSING__\n", it.first.c_str());
+      }
+      if (r13_low_found && r13_high_found) {
+        fprintf(stderr, "(%s) r13 = %08" PRIX32 "\n", it.first.c_str(), r13);
+      } else {
+        fprintf(stderr, "(%s) r13 = __MISSING__\n", it.first.c_str());
+      }
+    }
+  }
+
+  uint32_t find_match(
+      shared_ptr<const MemoryContext> dest_mem,
+      uint32_t src_addr,
+      uint32_t src_size,
+      ExpandMethod expand_method) const {
+    bool is_ppc = this->is_ppc_expand_method(expand_method);
+    bool is_ppc_data = this->is_ppc_data_expand_method(expand_method);
+    if (!this->src_mem) {
+      throw runtime_error("no source file selected");
+    }
+
+    if (src_size == 0) {
+      src_size = is_ppc ? 4 : 1;
+    }
+
+    pair<uint32_t, uint32_t> src_section = make_pair(0, 0);
+    for (const auto& sec : this->src_mem->allocated_blocks()) {
+      if (src_addr >= sec.first && src_addr + src_size <= sec.first + sec.second) {
+        src_section = sec;
+        break;
+      }
+    }
+    if (!src_section.second) {
+      throw runtime_error("source address not within any section");
+    }
+
+    const char* method_token = this->name_for_expand_method(expand_method);
+
+    size_t src_offset = src_addr - src_section.first;
+    size_t src_bytes_available_before = src_offset;
+    size_t src_bytes_available_after = src_section.second - src_offset - 4;
+    this->log.info("(find_match/%s) Source offset = %08zX with %zX/%zX bytes available before/after",
+        method_token, src_offset, src_bytes_available_before, src_bytes_available_after);
+
+    size_t match_bytes_before = 0;
+    size_t match_bytes_after = 0;
+    while (match_bytes_before + match_bytes_after + 4 < 0x100) {
+      size_t num_matches = 0;
+      size_t last_match_address = 0;
+      size_t match_length = match_bytes_before + match_bytes_after + 4;
+      StringReader src_r = this->src_mem->reader(src_section.first + src_offset - match_bytes_before, match_length);
+      for (const auto& dest_section : dest_mem->allocated_blocks()) {
+        for (size_t dest_match_offset = 0;
+             dest_match_offset + match_length < dest_section.second;
+             dest_match_offset += (is_ppc ? 4 : 1)) {
+          src_r.go(0);
+          StringReader dest_r = dest_mem->reader(dest_section.first + dest_match_offset, match_length);
+          size_t z;
+          if (is_ppc) {
+            for (z = 0; z < match_length; z += 4) {
+              if ((expand_method == ExpandMethod::PPC_TEXT_BOTH_IGNORE_ORIGIN) && (z == match_bytes_before)) {
+                src_r.skip(4);
+                dest_r.skip(4);
+              } else if (!is_ppc_data) {
+                uint32_t src_opcode = src_r.get_u32b();
+                uint32_t dest_opcode = dest_r.get_u32b();
+                uint32_t src_class = src_opcode & 0xFC000000;
+                if (src_class != (dest_opcode & 0xFC000000)) {
+                  break;
+                }
+                if (src_class == 0x48000000) {
+                  // b +-offset
+                  src_opcode &= 0xFC000003;
+                  dest_opcode &= 0xFC000003;
+                } else if (((src_opcode & 0xAC1F0000) == 0x800D0000) || ((src_opcode & 0xAC1F0000) == 0x80020000)) {
+                  // lwz/lfs rXX/fXX, [r2/r13 +- offset] OR stw/stfs [r2/r13 +- offset], rXX/fXX
+                  src_opcode &= 0xFFFF0000;
+                  dest_opcode &= 0xFFFF0000;
+                }
+                if (src_opcode != dest_opcode) {
+                  break;
+                }
+              } else {
+                uint32_t src_data = src_r.get_u32b();
+                uint32_t dest_data = dest_r.get_u32b();
+                if ((src_data & 0xFE000000) == 0x80000000) {
+                  src_data &= 0xFE000003;
+                }
+                if ((dest_data & 0xFE000000) == 0x80000000) {
+                  dest_data &= 0xFE000003;
+                }
+                if (src_data != dest_data) {
+                  break;
+                }
+              }
+            }
+          } else {
+            for (z = 0; z < match_length; z++) {
+              uint8_t src_data = src_r.get_u8();
+              uint8_t dest_data = dest_r.get_u8();
+              if (src_data != dest_data) {
+                break;
+              }
+            }
+          }
+          if (z == match_length) {
+            num_matches++;
+            last_match_address = dest_section.first + dest_match_offset + match_bytes_before;
+          }
+        }
+      }
+      this->log.info("(find_match/%s) For match length %zX, %zu matches found", method_token, match_length, num_matches);
+      if (num_matches == 1) {
+        return last_match_address;
+      } else if (num_matches == 0) {
+        throw runtime_error("did not find exactly one match");
+      }
+      bool can_expand_backward = false;
+      bool can_expand_forward = false;
+      switch (expand_method) {
+        case ExpandMethod::PPC_TEXT_BACKWARD_WITH_BARRIER:
+          can_expand_backward = (src_r.pget_u32b(0) != 0x4E800020) &&
+              (src_bytes_available_before >= match_bytes_before + 4);
+          break;
+        case ExpandMethod::PPC_TEXT_BACKWARD:
+        case ExpandMethod::PPC_DATA_BACKWARD:
+          can_expand_backward = (src_bytes_available_before >= match_bytes_before + 4);
+          break;
+        case ExpandMethod::PPC_TEXT_FORWARD_WITH_BARRIER:
+          can_expand_forward = (src_r.pget_u32b(src_r.size() - 4) != 0x4E800020) &&
+              (src_bytes_available_after >= match_bytes_after + 4);
+          break;
+        case ExpandMethod::PPC_TEXT_FORWARD:
+        case ExpandMethod::PPC_DATA_FORWARD:
+          can_expand_forward = (src_bytes_available_after >= match_bytes_after + 4);
+          break;
+        case ExpandMethod::PPC_TEXT_BOTH_WITH_BARRIER:
+        case ExpandMethod::PPC_TEXT_BOTH_IGNORE_ORIGIN:
+          can_expand_backward = (src_r.pget_u32b(0) != 0x4E800020) &&
+              (src_bytes_available_before >= match_bytes_before + 4);
+          can_expand_forward = (src_r.pget_u32b(src_r.size() - 4) != 0x4E800020) &&
+              (src_bytes_available_after >= match_bytes_after + 4);
+          break;
+        case ExpandMethod::PPC_TEXT_BOTH:
+        case ExpandMethod::PPC_DATA_BOTH:
+          can_expand_backward = (src_bytes_available_before >= match_bytes_before + 4);
+          can_expand_forward = (src_bytes_available_after >= match_bytes_after + 4);
+          break;
+        case ExpandMethod::RAW_BACKWARD:
+          can_expand_backward = (src_bytes_available_before > match_bytes_before);
+          break;
+        case ExpandMethod::RAW_FORWARD:
+          can_expand_forward = (src_bytes_available_after > match_bytes_after);
+          break;
+        case ExpandMethod::RAW_BOTH:
+          can_expand_backward = (src_bytes_available_before > match_bytes_before);
+          can_expand_forward = (src_bytes_available_after > match_bytes_after);
+          break;
+        default:
+          throw logic_error("invalid expand method");
+      }
+      if (!can_expand_backward && !can_expand_forward) {
+        throw runtime_error("no further expansion is allowed");
+      }
+      if (can_expand_backward) {
+        match_bytes_before += (is_ppc ? 4 : 1);
+      }
+      if (can_expand_forward) {
+        match_bytes_after += (is_ppc ? 4 : 1);
+      }
+    }
+    throw runtime_error("scan field too long; too many matches");
+  }
+
+  void find_all_matches(uint32_t src_addr, uint32_t src_size) const {
+    if (!this->src_mem) {
+      throw runtime_error("no source file selected");
+    }
+
+    map<string, uint32_t> results;
+    for (const auto& it : this->mems) {
+      if (it.second == this->src_mem) {
+        log.info("(%s) %08" PRIX32 " (from source)", it.first.c_str(), src_addr);
+        results.emplace(it.first, src_addr);
+
+      } else {
+        vector<future<uint32_t>> futures;
+        static const vector<ExpandMethod> ppc_methods = {
+            ExpandMethod::PPC_TEXT_FORWARD,
+            ExpandMethod::PPC_TEXT_FORWARD_WITH_BARRIER,
+            ExpandMethod::PPC_TEXT_BACKWARD,
+            ExpandMethod::PPC_TEXT_BACKWARD_WITH_BARRIER,
+            ExpandMethod::PPC_TEXT_BOTH,
+            ExpandMethod::PPC_TEXT_BOTH_WITH_BARRIER,
+            ExpandMethod::PPC_TEXT_BOTH_IGNORE_ORIGIN,
+            ExpandMethod::PPC_DATA_FORWARD,
+            ExpandMethod::PPC_DATA_BACKWARD,
+            ExpandMethod::PPC_DATA_BOTH,
+        };
+        static const vector<ExpandMethod> raw_methods = {
+            ExpandMethod::RAW_FORWARD,
+            ExpandMethod::RAW_BACKWARD,
+            ExpandMethod::RAW_BOTH,
+        };
+        const auto& methods = this->enable_ppc ? ppc_methods : raw_methods;
+        for (size_t z = 0; z < methods.size(); z++) {
+          futures.emplace_back(async(&AddressTranslator::find_match, this, it.second, src_addr, src_size, methods[z]));
+        }
+
+        unordered_set<uint32_t> match_addrs;
+        for (size_t z = 0; z < futures.size(); z++) {
+          const char* method_name = this->name_for_expand_method(methods[z]);
+          try {
+            uint32_t ret = futures[z].get();
+            log.info("(%s) (%s) %08" PRIX32, it.first.c_str(), method_name, ret);
+            match_addrs.emplace(ret);
+          } catch (const exception& e) {
+            log.error("(%s) (%s) failed: %s", it.first.c_str(), method_name, e.what());
+          }
+        }
+
+        if (match_addrs.empty()) {
+          log.error("(%s) no match found", it.first.c_str());
+        } else if (match_addrs.size() > 1) {
+          log.error("(%s) different matches found by different methods", it.first.c_str());
+        } else {
+          results.emplace(it.first, *match_addrs.begin());
+        }
+      }
+    }
+    for (const auto& it : results) {
+      fprintf(stdout, "%s => %08" PRIX32 "\n", it.first.c_str(), it.second);
+    }
+  }
+
+  void handle_command(const string& command) {
+    auto tokens = split(command, ' ');
+    if (tokens.empty()) {
+      throw runtime_error("no command given");
+    }
+    strip_trailing_whitespace(tokens[tokens.size() - 1]);
+
+    if (tokens[0] == "use") {
+      this->set_source_file(tokens.at(1));
+    } else if (tokens[0] == "match") {
+      this->find_all_matches(
+          stoul(tokens.at(1), nullptr, 16),
+          tokens.size() >= 3 ? stoul(tokens[2], nullptr, 16) : 0);
+    } else if (tokens[0] == "find-ppc-globals") {
+      this->find_ppc_rtoc_global_regs();
+    } else if (!tokens[0].empty()) {
+      throw runtime_error("unknown command");
+    }
+  }
+
+  void run_shell() {
+    while (!feof(stdin)) {
+      if (!this->src_filename.empty()) {
+        fprintf(stdout, "addr-trans:%s/%s> ", this->directory.c_str(), this->src_filename.c_str());
+      } else {
+        fprintf(stdout, "addr-trans:%s> ", this->directory.c_str());
+      }
+      fflush(stdout);
+
+      string command = fgets(stdin);
+      try {
+        this->handle_command(command);
+      } catch (const exception& e) {
+        this->log.error("Failed: %s", e.what());
+      }
+    }
+    fputc('\n', stdout);
+  }
+
+private:
+  PrefixedLogger log;
+  string directory;
+  unordered_map<string, shared_ptr<const MemoryContext>> mems;
+  string src_filename;
+  shared_ptr<const MemoryContext> src_mem;
+  bool enable_ppc;
+};
+
+void run_address_translator(const std::string& directory, const std::string& use_filename, const std::string& command) {
+  AddressTranslator trans(directory);
+  if (!use_filename.empty()) {
+    trans.set_source_file(use_filename);
+  }
+
+  if (!command.empty()) {
+    trans.handle_command(command);
+  } else {
+    trans.run_shell();
+  }
+}
+
+vector<pair<uint32_t, string>> diff_dol_files(const string& a_filename, const string& b_filename) {
+  DOLFile a(a_filename.c_str());
+  DOLFile b(b_filename.c_str());
+  auto a_mem = make_shared<MemoryContext>();
+  auto b_mem = make_shared<MemoryContext>();
+  a.load_into(a_mem);
+  b.load_into(b_mem);
+
+  uint32_t min_addr = 0xFFFFFFFF;
+  uint32_t max_addr = 0x00000000;
+  for (const auto& sec : a.sections) {
+    min_addr = min<uint32_t>(min_addr, sec.address);
+    max_addr = max<uint32_t>(max_addr, sec.address + sec.data.size());
+  }
+  for (const auto& sec : b.sections) {
+    min_addr = min<uint32_t>(min_addr, sec.address);
+    max_addr = max<uint32_t>(max_addr, sec.address + sec.data.size());
+  }
+
+  vector<pair<uint32_t, string>> ret;
+  for (uint32_t addr = min_addr; addr < max_addr; addr += 4) {
+    bool a_exists = a_mem->exists(addr, 4);
+    bool b_exists = b_mem->exists(addr, 4);
+    if (a_exists && b_exists) {
+      string a_value = a_mem->read(addr, 4);
+      string b_value = b_mem->read(addr, 4);
+      if (a_value != b_value) {
+        if (!ret.empty() && (ret.back().first + ret.back().second.size() == addr)) {
+          ret.back().second += b_value;
+        } else {
+          ret.emplace_back(make_pair(addr, b_value));
+        }
+      }
+    }
+  }
+  return ret;
+}

src/AddressTranslator.hh

@@ -0,0 +1,10 @@
+#pragma once
+
+#include <stdint.h>
+
+#include <string>
+#include <utility>
+#include <vector>
+
+void run_address_translator(const std::string& directory, const std::string& use_filename, const std::string& command);
+std::vector<std::pair<uint32_t, std::string>> diff_dol_files(const std::string& a_filename, const std::string& b_filename);

src/BattleParamsIndex.cc

@@ -1,83 +1,83 @@
-#include "BattleParamsIndex.hh"
-
-#include <phosg/Filesystem.hh>
-#include <phosg/Strings.hh>
-
-#include "Loggers.hh"
-#include "PSOEncryption.hh"
-#include "StaticGameData.hh"
-
-using namespace std;
-
-void BattleParamsIndex::Table::print(FILE* stream) const {
-  auto print_entry = +[](FILE* stream, const PlayerStats& e) {
-    fprintf(stream,
-        "%5hu %5hu %5hu %5hu %5hu %5hu %5hu %5hu %5" PRIu32 " %5" PRIu32,
-        e.char_stats.atp.load(),
-        e.char_stats.mst.load(),
-        e.char_stats.evp.load(),
-        e.char_stats.hp.load(),
-        e.char_stats.dfp.load(),
-        e.char_stats.ata.load(),
-        e.char_stats.lck.load(),
-        e.esp.load(),
-        e.experience.load(),
-        e.meseta.load());
-  };
-
-  for (size_t diff = 0; diff < 4; diff++) {
-    fprintf(stream, "%c ZZ   ATP   PSV   EVP    HP   DFP   ATA   LCK   ESP   EXP  DIFF\n",
-        abbreviation_for_difficulty(diff));
-    for (size_t z = 0; z < 0x60; z++) {
-      fprintf(stream, "  %02zX ", z);
-      print_entry(stream, this->stats[diff][z]);
-      fputc('\n', stream);
-    }
-  }
-}
-
-BattleParamsIndex::BattleParamsIndex(
-    shared_ptr<const string> data_on_ep1,
-    shared_ptr<const string> data_on_ep2,
-    shared_ptr<const string> data_on_ep4,
-    shared_ptr<const string> data_off_ep1,
-    shared_ptr<const string> data_off_ep2,
-    shared_ptr<const string> data_off_ep4) {
-  this->files[0][0].data = data_on_ep1;
-  this->files[0][1].data = data_on_ep2;
-  this->files[0][2].data = data_on_ep4;
-  this->files[1][0].data = data_off_ep1;
-  this->files[1][1].data = data_off_ep2;
-  this->files[1][2].data = data_off_ep4;
-
-  for (uint8_t is_solo = 0; is_solo < 2; is_solo++) {
-    for (uint8_t episode = 0; episode < 3; episode++) {
-      auto& file = this->files[is_solo][episode];
-      if (file.data->size() < sizeof(Table)) {
-        throw runtime_error(string_printf(
-            "battle params table size is incorrect (expected %zX bytes, have %zX bytes; is_solo=%hhu, episode=%hhu)",
-            sizeof(Table), file.data->size(), is_solo, episode));
-      }
-      file.table = reinterpret_cast<const Table*>(file.data->data());
-    }
-  }
-}
-
-const BattleParamsIndex::Table& BattleParamsIndex::get_table(bool solo, Episode episode) const {
-  uint8_t ep_index;
-  switch (episode) {
-    case Episode::EP1:
-      ep_index = 0;
-      break;
-    case Episode::EP2:
-      ep_index = 1;
-      break;
-    case Episode::EP4:
-      ep_index = 2;
-      break;
-    default:
-      throw invalid_argument("invalid episode");
-  }
-
-  return *this->files[!!solo][ep_index].table;
-}
+#include "BattleParamsIndex.hh"
+
+#include <phosg/Filesystem.hh>
+#include <phosg/Strings.hh>
+
+#include "Loggers.hh"
+#include "PSOEncryption.hh"
+#include "StaticGameData.hh"
+
+using namespace std;
+
+void BattleParamsIndex::Table::print(FILE* stream) const {
+  auto print_entry = +[](FILE* stream, const PlayerStats& e) {
+    fprintf(stream,
+        "%5hu %5hu %5hu %5hu %5hu %5hu %5hu %5hu %5" PRIu32 " %5" PRIu32,
+        e.char_stats.atp.load(),
+        e.char_stats.mst.load(),
+        e.char_stats.evp.load(),
+        e.char_stats.hp.load(),
+        e.char_stats.dfp.load(),
+        e.char_stats.ata.load(),
+        e.char_stats.lck.load(),
+        e.esp.load(),
+        e.experience.load(),
+        e.meseta.load());
+  };
+
+  for (size_t diff = 0; diff < 4; diff++) {
+    fprintf(stream, "%c ZZ   ATP   PSV   EVP    HP   DFP   ATA   LCK   ESP   EXP  DIFF\n",
+        abbreviation_for_difficulty(diff));
+    for (size_t z = 0; z < 0x60; z++) {
+      fprintf(stream, "  %02zX ", z);
+      print_entry(stream, this->stats[diff][z]);
+      fputc('\n', stream);
+    }
+  }
+}
+
+BattleParamsIndex::BattleParamsIndex(
+    shared_ptr<const string> data_on_ep1,
+    shared_ptr<const string> data_on_ep2,
+    shared_ptr<const string> data_on_ep4,
+    shared_ptr<const string> data_off_ep1,
+    shared_ptr<const string> data_off_ep2,
+    shared_ptr<const string> data_off_ep4) {
+  this->files[0][0].data = data_on_ep1;
+  this->files[0][1].data = data_on_ep2;
+  this->files[0][2].data = data_on_ep4;
+  this->files[1][0].data = data_off_ep1;
+  this->files[1][1].data = data_off_ep2;
+  this->files[1][2].data = data_off_ep4;
+
+  for (uint8_t is_solo = 0; is_solo < 2; is_solo++) {
+    for (uint8_t episode = 0; episode < 3; episode++) {
+      auto& file = this->files[is_solo][episode];
+      if (file.data->size() < sizeof(Table)) {
+        throw runtime_error(string_printf(
+            "battle params table size is incorrect (expected %zX bytes, have %zX bytes; is_solo=%hhu, episode=%hhu)",
+            sizeof(Table), file.data->size(), is_solo, episode));
+      }
+      file.table = reinterpret_cast<const Table*>(file.data->data());
+    }
+  }
+}
+
+const BattleParamsIndex::Table& BattleParamsIndex::get_table(bool solo, Episode episode) const {
+  uint8_t ep_index;
+  switch (episode) {
+    case Episode::EP1:
+      ep_index = 0;
+      break;
+    case Episode::EP2:
+      ep_index = 1;
+      break;
+    case Episode::EP4:
+      ep_index = 2;
+      break;
+    default:
+      throw invalid_argument("invalid episode");
+  }
+
+  return *this->files[!!solo][ep_index].table;
+}

src/BattleParamsIndex.hh

@@ -1,100 +1,100 @@
-#pragma once
-
-#include <inttypes.h>
-
-#include <array>
-#include <memory>
-#include <phosg/Encoding.hh>
-#include <random>
-#include <string>
-#include <vector>
-
-#include "EnemyType.hh"
-#include "LevelTable.hh"
-#include "StaticGameData.hh"
-#include "Text.hh"
-
-class BattleParamsIndex {
-public:
-  // These files are little-endian, even on PSO GC.
-
-  struct AttackData {
-    /* 00 */ le_int16_t unknown_a1;
-    /* 02 */ le_int16_t atp;
-    /* 04 */ le_int16_t ata_bonus;
-    /* 06 */ le_uint16_t unknown_a4;
-    /* 08 */ le_float distance_x;
-    /* 0C */ le_uint32_t angle_x; // Out of 0x10000 (high 16 bits are unused)
-    /* 10 */ le_float distance_y;
-    /* 14 */ le_uint16_t unknown_a8;
-    /* 16 */ le_uint16_t unknown_a9;
-    /* 18 */ le_uint16_t unknown_a10;
-    /* 1A */ le_uint16_t unknown_a11;
-    /* 1C */ le_uint32_t unknown_a12;
-    /* 20 */ le_uint32_t unknown_a13;
-    /* 24 */ le_uint32_t unknown_a14;
-    /* 28 */ le_uint32_t unknown_a15;
-    /* 2C */ le_uint32_t unknown_a16;
-    /* 30 */
-  } __packed_ws__(AttackData, 0x30);
-
-  struct ResistData {
-    /* 00 */ le_int16_t evp_bonus;
-    /* 02 */ le_uint16_t efr;
-    /* 04 */ le_uint16_t eic;
-    /* 06 */ le_uint16_t eth;
-    /* 08 */ le_uint16_t elt;
-    /* 0A */ le_uint16_t edk;
-    /* 0C */ le_uint32_t unknown_a6;
-    /* 10 */ le_uint32_t unknown_a7;
-    /* 14 */ le_uint32_t unknown_a8;
-    /* 18 */ le_uint32_t unknown_a9;
-    /* 1C */ le_int32_t dfp_bonus;
-    /* 20 */
-  } __packed_ws__(ResistData, 0x20);
-
-  struct MovementData {
-    /* 00 */ le_float idle_move_speed;
-    /* 04 */ le_float idle_animation_speed;
-    /* 08 */ le_float move_speed;
-    /* 0C */ le_float animation_speed;
-    /* 10 */ le_float unknown_a1;
-    /* 14 */ le_float unknown_a2;
-    /* 18 */ le_uint32_t unknown_a3;
-    /* 1C */ le_uint32_t unknown_a4;
-    /* 20 */ le_uint32_t unknown_a5;
-    /* 24 */ le_uint32_t unknown_a6;
-    /* 28 */ le_uint32_t unknown_a7;
-    /* 2C */ le_uint32_t unknown_a8;
-    /* 30 */
-  } __packed_ws__(MovementData, 0x30);
-
-  struct Table {
-    /* 0000 */ parray<parray<PlayerStats, 0x60>, 4> stats;
-    /* 3600 */ parray<parray<AttackData, 0x60>, 4> attack_data;
-    /* 7E00 */ parray<parray<ResistData, 0x60>, 4> resist_data;
-    /* AE00 */ parray<parray<MovementData, 0x60>, 4> movement_data;
-    /* F600 */
-
-    void print(FILE* stream) const;
-  } __packed_ws__(Table, 0xF600);
-
-  BattleParamsIndex(
-      std::shared_ptr<const std::string> data_on_ep1, // BattleParamEntry_on.dat
-      std::shared_ptr<const std::string> data_on_ep2, // BattleParamEntry_lab_on.dat
-      std::shared_ptr<const std::string> data_on_ep4, // BattleParamEntry_ep4_on.dat
-      std::shared_ptr<const std::string> data_off_ep1, // BattleParamEntry.dat
-      std::shared_ptr<const std::string> data_off_ep2, // BattleParamEntry_lab.dat
-      std::shared_ptr<const std::string> data_off_ep4); // BattleParamEntry_ep4.dat
-
-  const Table& get_table(bool solo, Episode episode) const;
-
-private:
-  struct File {
-    std::shared_ptr<const std::string> data;
-    const Table* table;
-  };
-
-  // Indexed as [online/offline][episode]
-  std::array<std::array<File, 3>, 2> files;
-};
+#pragma once
+
+#include <inttypes.h>
+
+#include <array>
+#include <memory>
+#include <phosg/Encoding.hh>
+#include <random>
+#include <string>
+#include <vector>
+
+#include "EnemyType.hh"
+#include "LevelTable.hh"
+#include "StaticGameData.hh"
+#include "Text.hh"
+
+class BattleParamsIndex {
+public:
+  // These files are little-endian, even on PSO GC.
+
+  struct AttackData {
+    /* 00 */ le_int16_t unknown_a1;
+    /* 02 */ le_int16_t atp;
+    /* 04 */ le_int16_t ata_bonus;
+    /* 06 */ le_uint16_t unknown_a4;
+    /* 08 */ le_float distance_x;
+    /* 0C */ le_uint32_t angle_x; // Out of 0x10000 (high 16 bits are unused)
+    /* 10 */ le_float distance_y;
+    /* 14 */ le_uint16_t unknown_a8;
+    /* 16 */ le_uint16_t unknown_a9;
+    /* 18 */ le_uint16_t unknown_a10;
+    /* 1A */ le_uint16_t unknown_a11;
+    /* 1C */ le_uint32_t unknown_a12;
+    /* 20 */ le_uint32_t unknown_a13;
+    /* 24 */ le_uint32_t unknown_a14;
+    /* 28 */ le_uint32_t unknown_a15;
+    /* 2C */ le_uint32_t unknown_a16;
+    /* 30 */
+  } __packed_ws__(AttackData, 0x30);
+
+  struct ResistData {
+    /* 00 */ le_int16_t evp_bonus;
+    /* 02 */ le_uint16_t efr;
+    /* 04 */ le_uint16_t eic;
+    /* 06 */ le_uint16_t eth;
+    /* 08 */ le_uint16_t elt;
+    /* 0A */ le_uint16_t edk;
+    /* 0C */ le_uint32_t unknown_a6;
+    /* 10 */ le_uint32_t unknown_a7;
+    /* 14 */ le_uint32_t unknown_a8;
+    /* 18 */ le_uint32_t unknown_a9;
+    /* 1C */ le_int32_t dfp_bonus;
+    /* 20 */
+  } __packed_ws__(ResistData, 0x20);
+
+  struct MovementData {
+    /* 00 */ le_float idle_move_speed;
+    /* 04 */ le_float idle_animation_speed;
+    /* 08 */ le_float move_speed;
+    /* 0C */ le_float animation_speed;
+    /* 10 */ le_float unknown_a1;
+    /* 14 */ le_float unknown_a2;
+    /* 18 */ le_uint32_t unknown_a3;
+    /* 1C */ le_uint32_t unknown_a4;
+    /* 20 */ le_uint32_t unknown_a5;
+    /* 24 */ le_uint32_t unknown_a6;
+    /* 28 */ le_uint32_t unknown_a7;
+    /* 2C */ le_uint32_t unknown_a8;
+    /* 30 */
+  } __packed_ws__(MovementData, 0x30);
+
+  struct Table {
+    /* 0000 */ parray<parray<PlayerStats, 0x60>, 4> stats;
+    /* 3600 */ parray<parray<AttackData, 0x60>, 4> attack_data;
+    /* 7E00 */ parray<parray<ResistData, 0x60>, 4> resist_data;
+    /* AE00 */ parray<parray<MovementData, 0x60>, 4> movement_data;
+    /* F600 */
+
+    void print(FILE* stream) const;
+  } __packed_ws__(Table, 0xF600);
+
+  BattleParamsIndex(
+      std::shared_ptr<const std::string> data_on_ep1, // BattleParamEntry_on.dat
+      std::shared_ptr<const std::string> data_on_ep2, // BattleParamEntry_lab_on.dat
+      std::shared_ptr<const std::string> data_on_ep4, // BattleParamEntry_ep4_on.dat
+      std::shared_ptr<const std::string> data_off_ep1, // BattleParamEntry.dat
+      std::shared_ptr<const std::string> data_off_ep2, // BattleParamEntry_lab.dat
+      std::shared_ptr<const std::string> data_off_ep4); // BattleParamEntry_ep4.dat
+
+  const Table& get_table(bool solo, Episode episode) const;
+
+private:
+  struct File {
+    std::shared_ptr<const std::string> data;
+    const Table* table;
+  };
+
+  // Indexed as [online/offline][episode]
+  std::array<std::array<File, 3>, 2> files;
+};

src/CatSession.cc

@@ -1,188 +1,188 @@
-#include "CatSession.hh"
-
-#include <arpa/inet.h>
-#include <ctype.h>
-#include <errno.h>
-#include <event2/buffer.h>
-#include <event2/bufferevent.h>
-#include <event2/event.h>
-#include <event2/listener.h>
-#include <fcntl.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <unistd.h>
-
-#include <algorithm>
-#include <iostream>
-#include <phosg/Encoding.hh>
-#include <phosg/Filesystem.hh>
-#include <phosg/Network.hh>
-#include <phosg/Random.hh>
-#include <phosg/Strings.hh>
-#include <phosg/Time.hh>
-
-#include "Loggers.hh"
-#include "PSOProtocol.hh"
-#include "ProxyCommands.hh"
-#include "ReceiveCommands.hh"
-#include "ReceiveSubcommands.hh"
-#include "SendCommands.hh"
-
-using namespace std;
-
-CatSession::exit_shell::exit_shell() : runtime_error("shell exited") {}
-
-CatSession::CatSession(
-    shared_ptr<struct event_base> base,
-    const struct sockaddr_storage& remote,
-    Version version,
-    shared_ptr<const PSOBBEncryption::KeyFile> bb_key_file)
-    : log(string_printf("[CatSession:%s] ", name_for_enum(version)), proxy_server_log.min_level),
-      base(base),
-      read_event(event_new(this->base.get(), 0, EV_READ | EV_PERSIST, CatSession::dispatch_read_stdin, this), event_free),
-      channel(version, 1, CatSession::dispatch_on_channel_input, CatSession::dispatch_on_channel_error, this, "CatSession"),
-      bb_key_file(bb_key_file) {
-
-  if (remote.ss_family != AF_INET) {
-    throw runtime_error("remote is not AF_INET");
-  }
-
-  string netloc_str = render_sockaddr_storage(remote);
-  this->log.info("Connecting to %s", netloc_str.c_str());
-
-  struct bufferevent* bev = bufferevent_socket_new(
-      this->base.get(), -1, BEV_OPT_CLOSE_ON_FREE | BEV_OPT_DEFER_CALLBACKS);
-  if (!bev) {
-    throw runtime_error(string_printf("failed to open socket (%d)", EVUTIL_SOCKET_ERROR()));
-  }
-  this->channel.set_bufferevent(bev, 0);
-
-  if (bufferevent_socket_connect(this->channel.bev.get(),
-          reinterpret_cast<const sockaddr*>(&remote), sizeof(struct sockaddr_in)) != 0) {
-    throw runtime_error(string_printf("failed to connect (%d)", EVUTIL_SOCKET_ERROR()));
-  }
-
-  event_add(this->read_event.get(), nullptr);
-  this->poll.add(0, POLLIN);
-}
-
-void CatSession::execute_command(const std::string& command) {
-  string full_cmd = parse_data_string(command, nullptr, ParseDataFlags::ALLOW_FILES);
-  send_command_with_header(this->channel, full_cmd.data(), full_cmd.size());
-}
-
-void CatSession::dispatch_on_channel_input(
-    Channel& ch, uint16_t command, uint32_t flag, std::string& data) {
-  auto* session = reinterpret_cast<CatSession*>(ch.context_obj);
-  session->on_channel_input(command, flag, data);
-}
-
-void CatSession::on_channel_input(
-    uint16_t command, uint32_t flag, std::string& data) {
-  if (!uses_v4_encryption(this->channel.version)) {
-    if (command == 0x02 || command == 0x17 || command == 0x91 || command == 0x9B) {
-      const auto& cmd = check_size_t<S_ServerInitDefault_DC_PC_V3_02_17_91_9B>(data, 0xFFFF);
-      if (uses_v3_encryption(this->channel.version)) {
-        this->channel.crypt_in = make_shared<PSOV3Encryption>(cmd.server_key);
-        this->channel.crypt_out = make_shared<PSOV3Encryption>(cmd.client_key);
-        this->log.info("Enabled V3 encryption (server key %08" PRIX32 ", client key %08" PRIX32 ")",
-            cmd.server_key.load(), cmd.client_key.load());
-      } else { // PC, DC, or patch server
-        this->channel.crypt_in = make_shared<PSOV2Encryption>(cmd.server_key);
-        this->channel.crypt_out = make_shared<PSOV2Encryption>(cmd.client_key);
-        this->log.info("Enabled V2 encryption (server key %08" PRIX32 ", client key %08" PRIX32 ")",
-            cmd.server_key.load(), cmd.client_key.load());
-      }
-    }
-  } else { // BB
-    if (command == 0x03 || command == 0x9B) {
-      if (!this->bb_key_file) {
-        throw runtime_error("BB encryption requires a key file");
-      }
-      const auto& cmd = check_size_t<S_ServerInitDefault_BB_03_9B>(data, 0xFFFF);
-      this->channel.crypt_in = make_shared<PSOBBEncryption>(*this->bb_key_file, &cmd.server_key[0], sizeof(cmd.server_key));
-      this->channel.crypt_out = make_shared<PSOBBEncryption>(*this->bb_key_file, &cmd.client_key[0], sizeof(cmd.client_key));
-      this->log.info("Enabled BB encryption");
-    }
-  }
-
-  // TODO: Use the iovec form of print_data here instead of
-  // prepend_command_header (which copies the string)
-  string full_cmd = prepend_command_header(
-      this->channel.version, this->channel.crypt_in.get(), command, flag, data);
-  print_data(stdout, full_cmd, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::OFFSET_16_BITS);
-}
-
-void CatSession::dispatch_on_channel_error(Channel& ch, short events) {
-  auto* session = reinterpret_cast<CatSession*>(ch.context_obj);
-  session->on_channel_error(events);
-}
-
-void CatSession::on_channel_error(short events) {
-  if (events & BEV_EVENT_CONNECTED) {
-    this->log.info("Channel connected");
-  }
-  if (events & BEV_EVENT_ERROR) {
-    int err = EVUTIL_SOCKET_ERROR();
-    this->log.warning("Error %d (%s) in unlinked client stream", err,
-        evutil_socket_error_to_string(err));
-  }
-  if (events & (BEV_EVENT_ERROR | BEV_EVENT_EOF)) {
-    this->log.info("Session endpoint has disconnected");
-    this->channel.disconnect();
-    event_base_loopexit(this->base.get(), nullptr);
-  }
-}
-
-void CatSession::dispatch_read_stdin(evutil_socket_t, short, void* ctx) {
-  reinterpret_cast<CatSession*>(ctx)->read_stdin();
-}
-
-void CatSession::read_stdin() {
-  bool any_command_read = false;
-  for (;;) {
-    auto poll_result = this->poll.poll();
-    short fd_events = 0;
-    try {
-      fd_events = poll_result.at(0);
-    } catch (const out_of_range&) {
-    }
-
-    if (!(fd_events & POLLIN)) {
-      break;
-    }
-
-    string command(2048, '\0');
-    if (!fgets(command.data(), command.size(), stdin)) {
-      if (!any_command_read) {
-        // ctrl+d probably; we should exit
-        fputc('\n', stderr);
-        event_base_loopexit(this->base.get(), nullptr);
-        return;
-      } else {
-        break; // probably not EOF; just no more commands for now
-      }
-    }
-
-    // trim the extra data off the string
-    size_t len = strlen(command.c_str());
-    if (len == 0) {
-      break;
-    }
-    if (command[len - 1] == '\n') {
-      len--;
-    }
-    command.resize(len);
-    any_command_read = true;
-
-    try {
-      execute_command(command);
-    } catch (const exit_shell&) {
-      event_base_loopexit(this->base.get(), nullptr);
-      return;
-    } catch (const exception& e) {
-      fprintf(stderr, "FAILED: %s\n", e.what());
-    }
-  }
-}
+#include "CatSession.hh"
+
+#include <arpa/inet.h>
+#include <ctype.h>
+#include <errno.h>
+#include <event2/buffer.h>
+#include <event2/bufferevent.h>
+#include <event2/event.h>
+#include <event2/listener.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+
+#include <algorithm>
+#include <iostream>
+#include <phosg/Encoding.hh>
+#include <phosg/Filesystem.hh>
+#include <phosg/Network.hh>
+#include <phosg/Random.hh>
+#include <phosg/Strings.hh>
+#include <phosg/Time.hh>
+
+#include "Loggers.hh"
+#include "PSOProtocol.hh"
+#include "ProxyCommands.hh"
+#include "ReceiveCommands.hh"
+#include "ReceiveSubcommands.hh"
+#include "SendCommands.hh"
+
+using namespace std;
+
+CatSession::exit_shell::exit_shell() : runtime_error("shell exited") {}
+
+CatSession::CatSession(
+    shared_ptr<struct event_base> base,
+    const struct sockaddr_storage& remote,
+    Version version,
+    shared_ptr<const PSOBBEncryption::KeyFile> bb_key_file)
+    : log(string_printf("[CatSession:%s] ", name_for_enum(version)), proxy_server_log.min_level),
+      base(base),
+      read_event(event_new(this->base.get(), 0, EV_READ | EV_PERSIST, CatSession::dispatch_read_stdin, this), event_free),
+      channel(version, 1, CatSession::dispatch_on_channel_input, CatSession::dispatch_on_channel_error, this, "CatSession"),
+      bb_key_file(bb_key_file) {
+
+  if (remote.ss_family != AF_INET) {
+    throw runtime_error("remote is not AF_INET");
+  }
+
+  string netloc_str = render_sockaddr_storage(remote);
+  this->log.info("Connecting to %s", netloc_str.c_str());
+
+  struct bufferevent* bev = bufferevent_socket_new(
+      this->base.get(), -1, BEV_OPT_CLOSE_ON_FREE | BEV_OPT_DEFER_CALLBACKS);
+  if (!bev) {
+    throw runtime_error(string_printf("failed to open socket (%d)", EVUTIL_SOCKET_ERROR()));
+  }
+  this->channel.set_bufferevent(bev, 0);
+
+  if (bufferevent_socket_connect(this->channel.bev.get(),
+          reinterpret_cast<const sockaddr*>(&remote), sizeof(struct sockaddr_in)) != 0) {
+    throw runtime_error(string_printf("failed to connect (%d)", EVUTIL_SOCKET_ERROR()));
+  }
+
+  event_add(this->read_event.get(), nullptr);
+  this->poll.add(0, POLLIN);
+}
+
+void CatSession::execute_command(const std::string& command) {
+  string full_cmd = parse_data_string(command, nullptr, ParseDataFlags::ALLOW_FILES);
+  send_command_with_header(this->channel, full_cmd.data(), full_cmd.size());
+}
+
+void CatSession::dispatch_on_channel_input(
+    Channel& ch, uint16_t command, uint32_t flag, std::string& data) {
+  auto* session = reinterpret_cast<CatSession*>(ch.context_obj);
+  session->on_channel_input(command, flag, data);
+}
+
+void CatSession::on_channel_input(
+    uint16_t command, uint32_t flag, std::string& data) {
+  if (!uses_v4_encryption(this->channel.version)) {
+    if (command == 0x02 || command == 0x17 || command == 0x91 || command == 0x9B) {
+      const auto& cmd = check_size_t<S_ServerInitDefault_DC_PC_V3_02_17_91_9B>(data, 0xFFFF);
+      if (uses_v3_encryption(this->channel.version)) {
+        this->channel.crypt_in = make_shared<PSOV3Encryption>(cmd.server_key);
+        this->channel.crypt_out = make_shared<PSOV3Encryption>(cmd.client_key);
+        this->log.info("Enabled V3 encryption (server key %08" PRIX32 ", client key %08" PRIX32 ")",
+            cmd.server_key.load(), cmd.client_key.load());
+      } else { // PC, DC, or patch server
+        this->channel.crypt_in = make_shared<PSOV2Encryption>(cmd.server_key);
+        this->channel.crypt_out = make_shared<PSOV2Encryption>(cmd.client_key);
+        this->log.info("Enabled V2 encryption (server key %08" PRIX32 ", client key %08" PRIX32 ")",
+            cmd.server_key.load(), cmd.client_key.load());
+      }
+    }
+  } else { // BB
+    if (command == 0x03 || command == 0x9B) {
+      if (!this->bb_key_file) {
+        throw runtime_error("BB encryption requires a key file");
+      }
+      const auto& cmd = check_size_t<S_ServerInitDefault_BB_03_9B>(data, 0xFFFF);
+      this->channel.crypt_in = make_shared<PSOBBEncryption>(*this->bb_key_file, &cmd.server_key[0], sizeof(cmd.server_key));
+      this->channel.crypt_out = make_shared<PSOBBEncryption>(*this->bb_key_file, &cmd.client_key[0], sizeof(cmd.client_key));
+      this->log.info("Enabled BB encryption");
+    }
+  }
+
+  // TODO: Use the iovec form of print_data here instead of
+  // prepend_command_header (which copies the string)
+  string full_cmd = prepend_command_header(
+      this->channel.version, this->channel.crypt_in.get(), command, flag, data);
+  print_data(stdout, full_cmd, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::OFFSET_16_BITS);
+}
+
+void CatSession::dispatch_on_channel_error(Channel& ch, short events) {
+  auto* session = reinterpret_cast<CatSession*>(ch.context_obj);
+  session->on_channel_error(events);
+}
+
+void CatSession::on_channel_error(short events) {
+  if (events & BEV_EVENT_CONNECTED) {
+    this->log.info("Channel connected");
+  }
+  if (events & BEV_EVENT_ERROR) {
+    int err = EVUTIL_SOCKET_ERROR();
+    this->log.warning("Error %d (%s) in unlinked client stream", err,
+        evutil_socket_error_to_string(err));
+  }
+  if (events & (BEV_EVENT_ERROR | BEV_EVENT_EOF)) {
+    this->log.info("Session endpoint has disconnected");
+    this->channel.disconnect();
+    event_base_loopexit(this->base.get(), nullptr);
+  }
+}
+
+void CatSession::dispatch_read_stdin(evutil_socket_t, short, void* ctx) {
+  reinterpret_cast<CatSession*>(ctx)->read_stdin();
+}
+
+void CatSession::read_stdin() {
+  bool any_command_read = false;
+  for (;;) {
+    auto poll_result = this->poll.poll();
+    short fd_events = 0;
+    try {
+      fd_events = poll_result.at(0);
+    } catch (const out_of_range&) {
+    }
+
+    if (!(fd_events & POLLIN)) {
+      break;
+    }
+
+    string command(2048, '\0');
+    if (!fgets(command.data(), command.size(), stdin)) {
+      if (!any_command_read) {
+        // ctrl+d probably; we should exit
+        fputc('\n', stderr);
+        event_base_loopexit(this->base.get(), nullptr);
+        return;
+      } else {
+        break; // probably not EOF; just no more commands for now
+      }
+    }
+
+    // trim the extra data off the string
+    size_t len = strlen(command.c_str());
+    if (len == 0) {
+      break;
+    }
+    if (command[len - 1] == '\n') {
+      len--;
+    }
+    command.resize(len);
+    any_command_read = true;
+
+    try {
+      execute_command(command);
+    } catch (const exit_shell&) {
+      event_base_loopexit(this->base.get(), nullptr);
+      return;
+    } catch (const exception& e) {
+      fprintf(stderr, "FAILED: %s\n", e.what());
+    }
+  }
+}

src/CatSession.hh

@@ -1,54 +1,54 @@
-#pragma once
-
-#include <event2/event.h>
-
-#include <functional>
-#include <map>
-#include <memory>
-#include <phosg/Filesystem.hh>
-#include <string>
-#include <unordered_map>
-#include <unordered_set>
-#include <vector>
-
-#include "PSOEncryption.hh"
-#include "PSOProtocol.hh"
-#include "ServerState.hh"
-
-class CatSession {
-public:
-  CatSession(
-      std::shared_ptr<struct event_base> base,
-      const struct sockaddr_storage& remote,
-      Version version,
-      std::shared_ptr<const PSOBBEncryption::KeyFile> bb_key_file);
-  CatSession(const CatSession&) = delete;
-  CatSession(CatSession&&) = delete;
-  CatSession& operator=(const CatSession&) = delete;
-  CatSession& operator=(CatSession&&) = delete;
-  virtual ~CatSession() = default;
-
-protected:
-  PrefixedLogger log;
-  std::shared_ptr<struct event_base> base;
-  std::unique_ptr<struct event, void (*)(struct event*)> read_event;
-  Poll poll;
-
-  Channel channel;
-  std::shared_ptr<const PSOBBEncryption::KeyFile> bb_key_file;
-
-  class exit_shell : public std::runtime_error {
-  public:
-    exit_shell();
-    ~exit_shell() = default;
-  };
-
-  virtual void execute_command(const std::string& command);
-
-  static void dispatch_read_stdin(evutil_socket_t fd, short events, void* ctx);
-  static void dispatch_on_channel_input(Channel& ch, uint16_t command, uint32_t flag, std::string& msg);
-  static void dispatch_on_channel_error(Channel& ch, short events);
-  void on_channel_input(uint16_t command, uint32_t flag, std::string& msg);
-  void on_channel_error(short events);
-  void read_stdin();
-};
+#pragma once
+
+#include <event2/event.h>
+
+#include <functional>
+#include <map>
+#include <memory>
+#include <phosg/Filesystem.hh>
+#include <string>
+#include <unordered_map>
+#include <unordered_set>
+#include <vector>
+
+#include "PSOEncryption.hh"
+#include "PSOProtocol.hh"
+#include "ServerState.hh"
+
+class CatSession {
+public:
+  CatSession(
+      std::shared_ptr<struct event_base> base,
+      const struct sockaddr_storage& remote,
+      Version version,
+      std::shared_ptr<const PSOBBEncryption::KeyFile> bb_key_file);
+  CatSession(const CatSession&) = delete;
+  CatSession(CatSession&&) = delete;
+  CatSession& operator=(const CatSession&) = delete;
+  CatSession& operator=(CatSession&&) = delete;
+  virtual ~CatSession() = default;
+
+protected:
+  PrefixedLogger log;
+  std::shared_ptr<struct event_base> base;
+  std::unique_ptr<struct event, void (*)(struct event*)> read_event;
+  Poll poll;
+
+  Channel channel;
+  std::shared_ptr<const PSOBBEncryption::KeyFile> bb_key_file;
+
+  class exit_shell : public std::runtime_error {
+  public:
+    exit_shell();
+    ~exit_shell() = default;
+  };
+
+  virtual void execute_command(const std::string& command);
+
+  static void dispatch_read_stdin(evutil_socket_t fd, short events, void* ctx);
+  static void dispatch_on_channel_input(Channel& ch, uint16_t command, uint32_t flag, std::string& msg);
+  static void dispatch_on_channel_error(Channel& ch, short events);
+  void on_channel_input(uint16_t command, uint32_t flag, std::string& msg);
+  void on_channel_error(short events);
+  void read_stdin();
+};

src/Channel.cc

@@ -1,421 +1,421 @@
-#include "Channel.hh"
-
-#include <errno.h>
-#include <event2/buffer.h>
-#include <event2/bufferevent.h>
-#include <event2/event.h>
-#include <string.h>
-#include <unistd.h>
-
-#include <phosg/Network.hh>
-#include <phosg/Time.hh>
-
-#include "Loggers.hh"
-#include "Version.hh"
-
-using namespace std;
-
-extern bool use_terminal_colors;
-
-static void flush_and_free_bufferevent(struct bufferevent* bev) {
-  bufferevent_flush(bev, EV_READ | EV_WRITE, BEV_FINISHED);
-  bufferevent_free(bev);
-}
-
-Channel::Channel(
-    Version version,
-    uint8_t language,
-    on_command_received_t on_command_received,
-    on_error_t on_error,
-    void* context_obj,
-    const string& name,
-    TerminalFormat terminal_send_color,
-    TerminalFormat terminal_recv_color)
-    : bev(nullptr, flush_and_free_bufferevent),
-      virtual_network_id(0),
-      version(version),
-      language(language),
-      name(name),
-      terminal_send_color(terminal_send_color),
-      terminal_recv_color(terminal_recv_color),
-      on_command_received(on_command_received),
-      on_error(on_error),
-      context_obj(context_obj) {
-}
-
-Channel::Channel(
-    struct bufferevent* bev,
-    uint64_t virtual_network_id,
-    Version version,
-    uint8_t language,
-    on_command_received_t on_command_received,
-    on_error_t on_error,
-    void* context_obj,
-    const string& name,
-    TerminalFormat terminal_send_color,
-    TerminalFormat terminal_recv_color)
-    : bev(nullptr, flush_and_free_bufferevent),
-      version(version),
-      language(language),
-      name(name),
-      terminal_send_color(terminal_send_color),
-      terminal_recv_color(terminal_recv_color),
-      on_command_received(on_command_received),
-      on_error(on_error),
-      context_obj(context_obj) {
-  this->set_bufferevent(bev, virtual_network_id);
-}
-
-void Channel::replace_with(
-    Channel&& other,
-    on_command_received_t on_command_received,
-    on_error_t on_error,
-    void* context_obj,
-    const std::string& name) {
-  this->set_bufferevent(other.bev.release(), other.virtual_network_id);
-  this->local_addr = other.local_addr;
-  this->remote_addr = other.remote_addr;
-  this->version = other.version;
-  this->language = other.language;
-  this->crypt_in = other.crypt_in;
-  this->crypt_out = other.crypt_out;
-  this->name = name;
-  this->terminal_send_color = other.terminal_send_color;
-  this->terminal_recv_color = other.terminal_recv_color;
-  this->on_command_received = on_command_received;
-  this->on_error = on_error;
-  this->context_obj = context_obj;
-  other.disconnect(); // Clears crypts, addrs, etc.
-}
-
-void Channel::set_bufferevent(struct bufferevent* bev, uint64_t virtual_network_id) {
-  this->bev.reset(bev);
-  this->virtual_network_id = virtual_network_id;
-
-  if (this->bev.get()) {
-    int fd = bufferevent_getfd(this->bev.get());
-    if (fd < 0) {
-      memset(&this->local_addr, 0, sizeof(this->local_addr));
-      memset(&this->remote_addr, 0, sizeof(this->remote_addr));
-    } else {
-      get_socket_addresses(fd, &this->local_addr, &this->remote_addr);
-    }
-
-    bufferevent_setcb(this->bev.get(), &Channel::dispatch_on_input, nullptr, &Channel::dispatch_on_error, this);
-    bufferevent_enable(this->bev.get(), EV_READ | EV_WRITE);
-
-  } else {
-    memset(&this->local_addr, 0, sizeof(this->local_addr));
-    memset(&this->remote_addr, 0, sizeof(this->remote_addr));
-  }
-}
-
-void Channel::disconnect() {
-  if (this->bev.get()) {
-    // If the output buffer is not empty, move the bufferevent into the draining
-    // pool instead of disconnecting it, to make sure all the data gets sent.
-    struct evbuffer* out_buffer = bufferevent_get_output(this->bev.get());
-    if (evbuffer_get_length(out_buffer) == 0) {
-      this->bev.reset(); // Destructor flushes and frees the bufferevent
-    } else {
-      // The callbacks will free it when all the data is sent or the client
-      // disconnects
-
-      auto on_output = +[](struct bufferevent* bev, void*) -> void {
-        flush_and_free_bufferevent(bev);
-      };
-
-      auto on_error = +[](struct bufferevent* bev, short events, void*) -> void {
-        if (events & BEV_EVENT_ERROR) {
-          int err = EVUTIL_SOCKET_ERROR();
-          channel_exceptions_log.warning(
-              "Disconnecting channel caused error %d (%s)", err,
-              evutil_socket_error_to_string(err));
-        }
-        if (events & (BEV_EVENT_EOF | BEV_EVENT_ERROR)) {
-          bufferevent_flush(bev, EV_WRITE, BEV_FINISHED);
-          bufferevent_free(bev);
-        }
-      };
-
-      struct bufferevent* bev = this->bev.release();
-      bufferevent_setcb(bev, nullptr, on_output, on_error, bev);
-      bufferevent_disable(bev, EV_READ);
-    }
-  }
-
-  memset(&this->local_addr, 0, sizeof(this->local_addr));
-  memset(&this->remote_addr, 0, sizeof(this->remote_addr));
-  this->virtual_network_id = false;
-  this->crypt_in.reset();
-  this->crypt_out.reset();
-}
-
-Channel::Message Channel::recv() {
-  struct evbuffer* buf = bufferevent_get_input(this->bev.get());
-
-  size_t header_size = (this->version == Version::BB_V4) ? 8 : 4;
-  PSOCommandHeader header;
-  if (evbuffer_copyout(buf, &header, header_size) < static_cast<ssize_t>(header_size)) {
-    throw out_of_range("no command available");
-  }
-
-  if (this->crypt_in.get()) {
-    this->crypt_in->decrypt(&header, header_size, false);
-  }
-
-  size_t command_logical_size = header.size(version);
-
-  // If encryption is enabled, BB pads commands to 8-byte boundaries, and this
-  // is not reflected in the size field. This logic does not occur if encryption
-  // is not yet enabled.
-  size_t command_physical_size = (this->crypt_in.get() && (version == Version::BB_V4))
-      ? ((command_logical_size + 7) & ~7)
-      : command_logical_size;
-  if (evbuffer_get_length(buf) < command_physical_size) {
-    throw out_of_range("no command available");
-  }
-
-  // If we get here, then there is a full command in the buffer. Some encryption
-  // algorithms' advancement depends on the decrypted data, so we have to
-  // actually decrypt the header again (with advance=true) to keep them in a
-  // consistent state.
-
-  string header_data(header_size, '\0');
-  if (evbuffer_remove(buf, header_data.data(), header_data.size()) < static_cast<ssize_t>(header_data.size())) {
-    throw logic_error("enough bytes available, but could not remove them");
-  }
-  if (this->crypt_in.get()) {
-    this->crypt_in->decrypt(header_data.data(), header_data.size());
-  }
-
-  string command_data(command_physical_size - header_size, '\0');
-  if (evbuffer_remove(buf, command_data.data(), command_data.size()) < static_cast<ssize_t>(command_data.size())) {
-    throw logic_error("enough bytes available, but could not remove them");
-  }
-
-  if (this->crypt_in.get()) {
-    // Some versions of PSO DC can send commands whose sizes are not a multiple
-    // of 4, but the server is expected to always use a multiple of 4 bytes when
-    // decrypting (the extra cipher bytes are lost). To emulate this behavior,
-    // we have to round up the size for DC commands here.
-    size_t orig_size = command_data.size();
-    command_data.resize((orig_size + 3) & (~3), 0);
-    this->crypt_in->decrypt(command_data.data(), command_data.size());
-    command_data.resize(orig_size);
-  }
-  command_data.resize(command_logical_size - header_size);
-
-  if (command_data_log.should_log(LogLevel::INFO) && (this->terminal_recv_color != TerminalFormat::END)) {
-    if (use_terminal_colors && this->terminal_recv_color != TerminalFormat::NORMAL) {
-      print_color_escape(stderr, this->terminal_recv_color, TerminalFormat::BOLD, TerminalFormat::END);
-    }
-
-    if (version == Version::BB_V4) {
-      command_data_log.info(
-          "Received from %s (version=BB command=%04hX flag=%08" PRIX32 ")",
-          this->name.c_str(),
-          header.command(this->version),
-          header.flag(this->version));
-    } else {
-      command_data_log.info(
-          "Received from %s (version=%s command=%02hX flag=%02" PRIX32 ")",
-          this->name.c_str(),
-          name_for_enum(this->version),
-          header.command(this->version),
-          header.flag(this->version));
-    }
-
-    vector<struct iovec> iovs;
-    iovs.emplace_back(iovec{.iov_base = header_data.data(), .iov_len = header_data.size()});
-    iovs.emplace_back(iovec{.iov_base = command_data.data(), .iov_len = command_data.size()});
-    print_data(stderr, iovs, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
-
-    if (use_terminal_colors && this->terminal_recv_color != TerminalFormat::NORMAL) {
-      print_color_escape(stderr, TerminalFormat::NORMAL, TerminalFormat::END);
-    }
-  }
-
-  return {
-      .command = header.command(this->version),
-      .flag = header.flag(this->version),
-      .data = std::move(command_data),
-  };
-}
-
-void Channel::send(uint16_t cmd, uint32_t flag, bool silent) {
-  this->send(cmd, flag, nullptr, 0, silent);
-}
-
-void Channel::send(uint16_t cmd, uint32_t flag, const std::vector<std::pair<const void*, size_t>> blocks, bool silent) {
-  if (!this->connected()) {
-    channel_exceptions_log.warning("Attempted to send command on closed channel; dropping data");
-    return;
-  }
-
-  size_t size = 0;
-  for (const auto& b : blocks) {
-    size += b.second;
-  }
-
-  string send_data;
-  size_t logical_size;
-  size_t send_data_size = 0;
-  switch (this->version) {
-    case Version::DC_NTE:
-    case Version::DC_V1_11_2000_PROTOTYPE:
-    case Version::DC_V1:
-    case Version::DC_V2:
-    case Version::GC_NTE:
-    case Version::GC_V3:
-    case Version::GC_EP3_NTE:
-    case Version::GC_EP3:
-    case Version::XB_V3: {
-      PSOCommandHeaderDCV3 header;
-      if (this->crypt_out.get() &&
-          (this->version != Version::DC_NTE) &&
-          (this->version != Version::DC_V1_11_2000_PROTOTYPE) &&
-          (this->version != Version::DC_V1)) {
-        send_data_size = (sizeof(header) + size + 3) & ~3;
-      } else {
-        send_data_size = (sizeof(header) + size);
-      }
-      logical_size = send_data_size;
-      header.command = cmd;
-      header.flag = flag;
-      header.size = send_data_size;
-      send_data.append(reinterpret_cast<const char*>(&header), sizeof(header));
-      break;
-    }
-    case Version::PC_PATCH:
-    case Version::BB_PATCH:
-    case Version::PC_NTE:
-    case Version::PC_V2: {
-      PSOCommandHeaderPC header;
-      if (this->crypt_out.get()) {
-        send_data_size = (sizeof(header) + size + 3) & ~3;
-      } else {
-        send_data_size = (sizeof(header) + size);
-      }
-      logical_size = send_data_size;
-      header.size = send_data_size;
-      header.command = cmd;
-      header.flag = flag;
-      send_data.append(reinterpret_cast<const char*>(&header), sizeof(header));
-      break;
-    }
-    case Version::BB_V4: {
-      // BB has an annoying behavior here: command lengths must be multiples of
-      // 4, but the actual data length must be a multiple of 8. If the size
-      // field is not divisible by 8, 4 extra bytes are sent anyway. This
-      // behavior only applies when encryption is enabled - any commands sent
-      // before encryption is enabled have no size restrictions (except they
-      // must include a full header and must fit in the client's receive
-      // buffer), and no implicit extra bytes are sent.
-      PSOCommandHeaderBB header;
-      if (this->crypt_out.get()) {
-        send_data_size = (sizeof(header) + size + 7) & ~7;
-      } else {
-        send_data_size = (sizeof(header) + size);
-      }
-      logical_size = (sizeof(header) + size + 3) & ~3;
-      header.size = logical_size;
-      header.command = cmd;
-      header.flag = flag;
-      send_data.append(reinterpret_cast<const char*>(&header), sizeof(header));
-      break;
-    }
-
-    default:
-      throw logic_error("unimplemented game version in send_command");
-  }
-
-  // All versions of PSO I've seen (so far) have a receive buffer 0x7C00
-  // bytes in size
-  if (send_data_size > 0x7C00) {
-    throw runtime_error("outbound command too large");
-  }
-
-  send_data.reserve(send_data_size);
-  for (const auto& b : blocks) {
-    send_data.append(reinterpret_cast<const char*>(b.first), b.second);
-  }
-  send_data.resize(send_data_size, '\0');
-
-  if (!silent && (command_data_log.should_log(LogLevel::INFO)) && (this->terminal_send_color != TerminalFormat::END)) {
-    if (use_terminal_colors && this->terminal_send_color != TerminalFormat::NORMAL) {
-      print_color_escape(stderr, TerminalFormat::FG_YELLOW, TerminalFormat::BOLD, TerminalFormat::END);
-    }
-    if (version == Version::BB_V4) {
-      command_data_log.info("Sending to %s (version=BB command=%04hX flag=%08" PRIX32 ")",
-          this->name.c_str(), cmd, flag);
-    } else {
-      command_data_log.info("Sending to %s (version=%s command=%02hX flag=%02" PRIX32 ")",
-          this->name.c_str(), name_for_enum(version), cmd, flag);
-    }
-    print_data(stderr, send_data.data(), logical_size, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
-    if (use_terminal_colors && this->terminal_send_color != TerminalFormat::NORMAL) {
-      print_color_escape(stderr, TerminalFormat::NORMAL, TerminalFormat::END);
-    }
-  }
-
-  if (this->crypt_out.get()) {
-    this->crypt_out->encrypt(send_data.data(), send_data.size());
-  }
-
-  struct evbuffer* buf = bufferevent_get_output(this->bev.get());
-  evbuffer_add(buf, send_data.data(), send_data.size());
-}
-
-void Channel::send(uint16_t cmd, uint32_t flag, const void* data, size_t size, bool silent) {
-  this->send(cmd, flag, {make_pair(data, size)}, silent);
-}
-
-void Channel::send(uint16_t cmd, uint32_t flag, const string& data, bool silent) {
-  this->send(cmd, flag, data.data(), data.size(), silent);
-}
-
-void Channel::send(const void* data, size_t size, bool silent) {
-  size_t header_size = (this->version == Version::BB_V4) ? 8 : 4;
-  const auto* header = reinterpret_cast<const PSOCommandHeader*>(data);
-  this->send(
-      header->command(this->version),
-      header->flag(this->version),
-      reinterpret_cast<const uint8_t*>(data) + header_size,
-      size - header_size,
-      silent);
-}
-
-void Channel::send(const string& data, bool silent) {
-  return this->send(data.data(), data.size(), silent);
-}
-
-void Channel::dispatch_on_input(struct bufferevent*, void* ctx) {
-  Channel* ch = reinterpret_cast<Channel*>(ctx);
-  // The client can be disconnected during on_command_received, so we have to
-  // make sure ch->bev is valid every time before calling recv()
-  while (ch->bev.get()) {
-    Message msg;
-    try {
-      msg = ch->recv();
-    } catch (const out_of_range&) {
-      break;
-    } catch (const exception& e) {
-      channel_exceptions_log.warning("Error receiving on channel: %s", e.what());
-      ch->on_error(*ch, BEV_EVENT_ERROR);
-      break;
-    }
-    if (ch->on_command_received) {
-      ch->on_command_received(*ch, msg.command, msg.flag, msg.data);
-    }
-  }
-}
-
-void Channel::dispatch_on_error(struct bufferevent*, short events, void* ctx) {
-  Channel* ch = reinterpret_cast<Channel*>(ctx);
-  if (ch->on_error) {
-    ch->on_error(*ch, events);
-  } else {
-    ch->disconnect();
-  }
-}
+#include "Channel.hh"
+
+#include <errno.h>
+#include <event2/buffer.h>
+#include <event2/bufferevent.h>
+#include <event2/event.h>
+#include <string.h>
+#include <unistd.h>
+
+#include <phosg/Network.hh>
+#include <phosg/Time.hh>
+
+#include "Loggers.hh"
+#include "Version.hh"
+
+using namespace std;
+
+extern bool use_terminal_colors;
+
+static void flush_and_free_bufferevent(struct bufferevent* bev) {
+  bufferevent_flush(bev, EV_READ | EV_WRITE, BEV_FINISHED);
+  bufferevent_free(bev);
+}
+
+Channel::Channel(
+    Version version,
+    uint8_t language,
+    on_command_received_t on_command_received,
+    on_error_t on_error,
+    void* context_obj,
+    const string& name,
+    TerminalFormat terminal_send_color,
+    TerminalFormat terminal_recv_color)
+    : bev(nullptr, flush_and_free_bufferevent),
+      virtual_network_id(0),
+      version(version),
+      language(language),
+      name(name),
+      terminal_send_color(terminal_send_color),
+      terminal_recv_color(terminal_recv_color),
+      on_command_received(on_command_received),
+      on_error(on_error),
+      context_obj(context_obj) {
+}
+
+Channel::Channel(
+    struct bufferevent* bev,
+    uint64_t virtual_network_id,
+    Version version,
+    uint8_t language,
+    on_command_received_t on_command_received,
+    on_error_t on_error,
+    void* context_obj,
+    const string& name,
+    TerminalFormat terminal_send_color,
+    TerminalFormat terminal_recv_color)
+    : bev(nullptr, flush_and_free_bufferevent),
+      version(version),
+      language(language),
+      name(name),
+      terminal_send_color(terminal_send_color),
+      terminal_recv_color(terminal_recv_color),
+      on_command_received(on_command_received),
+      on_error(on_error),
+      context_obj(context_obj) {
+  this->set_bufferevent(bev, virtual_network_id);
+}
+
+void Channel::replace_with(
+    Channel&& other,
+    on_command_received_t on_command_received,
+    on_error_t on_error,
+    void* context_obj,
+    const std::string& name) {
+  this->set_bufferevent(other.bev.release(), other.virtual_network_id);
+  this->local_addr = other.local_addr;
+  this->remote_addr = other.remote_addr;
+  this->version = other.version;
+  this->language = other.language;
+  this->crypt_in = other.crypt_in;
+  this->crypt_out = other.crypt_out;
+  this->name = name;
+  this->terminal_send_color = other.terminal_send_color;
+  this->terminal_recv_color = other.terminal_recv_color;
+  this->on_command_received = on_command_received;
+  this->on_error = on_error;
+  this->context_obj = context_obj;
+  other.disconnect(); // Clears crypts, addrs, etc.
+}
+
+void Channel::set_bufferevent(struct bufferevent* bev, uint64_t virtual_network_id) {
+  this->bev.reset(bev);
+  this->virtual_network_id = virtual_network_id;
+
+  if (this->bev.get()) {
+    int fd = bufferevent_getfd(this->bev.get());
+    if (fd < 0) {
+      memset(&this->local_addr, 0, sizeof(this->local_addr));
+      memset(&this->remote_addr, 0, sizeof(this->remote_addr));
+    } else {
+      get_socket_addresses(fd, &this->local_addr, &this->remote_addr);
+    }
+
+    bufferevent_setcb(this->bev.get(), &Channel::dispatch_on_input, nullptr, &Channel::dispatch_on_error, this);
+    bufferevent_enable(this->bev.get(), EV_READ | EV_WRITE);
+
+  } else {
+    memset(&this->local_addr, 0, sizeof(this->local_addr));
+    memset(&this->remote_addr, 0, sizeof(this->remote_addr));
+  }
+}
+
+void Channel::disconnect() {
+  if (this->bev.get()) {
+    // If the output buffer is not empty, move the bufferevent into the draining
+    // pool instead of disconnecting it, to make sure all the data gets sent.
+    struct evbuffer* out_buffer = bufferevent_get_output(this->bev.get());
+    if (evbuffer_get_length(out_buffer) == 0) {
+      this->bev.reset(); // Destructor flushes and frees the bufferevent
+    } else {
+      // The callbacks will free it when all the data is sent or the client
+      // disconnects
+
+      auto on_output = +[](struct bufferevent* bev, void*) -> void {
+        flush_and_free_bufferevent(bev);
+      };
+
+      auto on_error = +[](struct bufferevent* bev, short events, void*) -> void {
+        if (events & BEV_EVENT_ERROR) {
+          int err = EVUTIL_SOCKET_ERROR();
+          channel_exceptions_log.warning(
+              "Disconnecting channel caused error %d (%s)", err,
+              evutil_socket_error_to_string(err));
+        }
+        if (events & (BEV_EVENT_EOF | BEV_EVENT_ERROR)) {
+          bufferevent_flush(bev, EV_WRITE, BEV_FINISHED);
+          bufferevent_free(bev);
+        }
+      };
+
+      struct bufferevent* bev = this->bev.release();
+      bufferevent_setcb(bev, nullptr, on_output, on_error, bev);
+      bufferevent_disable(bev, EV_READ);
+    }
+  }
+
+  memset(&this->local_addr, 0, sizeof(this->local_addr));
+  memset(&this->remote_addr, 0, sizeof(this->remote_addr));
+  this->virtual_network_id = false;
+  this->crypt_in.reset();
+  this->crypt_out.reset();
+}
+
+Channel::Message Channel::recv() {
+  struct evbuffer* buf = bufferevent_get_input(this->bev.get());
+
+  size_t header_size = (this->version == Version::BB_V4) ? 8 : 4;
+  PSOCommandHeader header;
+  if (evbuffer_copyout(buf, &header, header_size) < static_cast<ssize_t>(header_size)) {
+    throw out_of_range("no command available");
+  }
+
+  if (this->crypt_in.get()) {
+    this->crypt_in->decrypt(&header, header_size, false);
+  }
+
+  size_t command_logical_size = header.size(version);
+
+  // If encryption is enabled, BB pads commands to 8-byte boundaries, and this
+  // is not reflected in the size field. This logic does not occur if encryption
+  // is not yet enabled.
+  size_t command_physical_size = (this->crypt_in.get() && (version == Version::BB_V4))
+      ? ((command_logical_size + 7) & ~7)
+      : command_logical_size;
+  if (evbuffer_get_length(buf) < command_physical_size) {
+    throw out_of_range("no command available");
+  }
+
+  // If we get here, then there is a full command in the buffer. Some encryption
+  // algorithms' advancement depends on the decrypted data, so we have to
+  // actually decrypt the header again (with advance=true) to keep them in a
+  // consistent state.
+
+  string header_data(header_size, '\0');
+  if (evbuffer_remove(buf, header_data.data(), header_data.size()) < static_cast<ssize_t>(header_data.size())) {
+    throw logic_error("enough bytes available, but could not remove them");
+  }
+  if (this->crypt_in.get()) {
+    this->crypt_in->decrypt(header_data.data(), header_data.size());
+  }
+
+  string command_data(command_physical_size - header_size, '\0');
+  if (evbuffer_remove(buf, command_data.data(), command_data.size()) < static_cast<ssize_t>(command_data.size())) {
+    throw logic_error("enough bytes available, but could not remove them");
+  }
+
+  if (this->crypt_in.get()) {
+    // Some versions of PSO DC can send commands whose sizes are not a multiple
+    // of 4, but the server is expected to always use a multiple of 4 bytes when
+    // decrypting (the extra cipher bytes are lost). To emulate this behavior,
+    // we have to round up the size for DC commands here.
+    size_t orig_size = command_data.size();
+    command_data.resize((orig_size + 3) & (~3), 0);
+    this->crypt_in->decrypt(command_data.data(), command_data.size());
+    command_data.resize(orig_size);
+  }
+  command_data.resize(command_logical_size - header_size);
+
+  if (command_data_log.should_log(LogLevel::INFO) && (this->terminal_recv_color != TerminalFormat::END)) {
+    if (use_terminal_colors && this->terminal_recv_color != TerminalFormat::NORMAL) {
+      print_color_escape(stderr, this->terminal_recv_color, TerminalFormat::BOLD, TerminalFormat::END);
+    }
+
+    if (version == Version::BB_V4) {
+      command_data_log.info(
+          "Received from %s (version=BB command=%04hX flag=%08" PRIX32 ")",
+          this->name.c_str(),
+          header.command(this->version),
+          header.flag(this->version));
+    } else {
+      command_data_log.info(
+          "Received from %s (version=%s command=%02hX flag=%02" PRIX32 ")",
+          this->name.c_str(),
+          name_for_enum(this->version),
+          header.command(this->version),
+          header.flag(this->version));
+    }
+
+    vector<struct iovec> iovs;
+    iovs.emplace_back(iovec{.iov_base = header_data.data(), .iov_len = header_data.size()});
+    iovs.emplace_back(iovec{.iov_base = command_data.data(), .iov_len = command_data.size()});
+    print_data(stderr, iovs, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
+
+    if (use_terminal_colors && this->terminal_recv_color != TerminalFormat::NORMAL) {
+      print_color_escape(stderr, TerminalFormat::NORMAL, TerminalFormat::END);
+    }
+  }
+
+  return {
+      .command = header.command(this->version),
+      .flag = header.flag(this->version),
+      .data = std::move(command_data),
+  };
+}
+
+void Channel::send(uint16_t cmd, uint32_t flag, bool silent) {
+  this->send(cmd, flag, nullptr, 0, silent);
+}
+
+void Channel::send(uint16_t cmd, uint32_t flag, const std::vector<std::pair<const void*, size_t>> blocks, bool silent) {
+  if (!this->connected()) {
+    channel_exceptions_log.warning("Attempted to send command on closed channel; dropping data");
+    return;
+  }
+
+  size_t size = 0;
+  for (const auto& b : blocks) {
+    size += b.second;
+  }
+
+  string send_data;
+  size_t logical_size;
+  size_t send_data_size = 0;
+  switch (this->version) {
+    case Version::DC_NTE:
+    case Version::DC_V1_11_2000_PROTOTYPE:
+    case Version::DC_V1:
+    case Version::DC_V2:
+    case Version::GC_NTE:
+    case Version::GC_V3:
+    case Version::GC_EP3_NTE:
+    case Version::GC_EP3:
+    case Version::XB_V3: {
+      PSOCommandHeaderDCV3 header;
+      if (this->crypt_out.get() &&
+          (this->version != Version::DC_NTE) &&
+          (this->version != Version::DC_V1_11_2000_PROTOTYPE) &&
+          (this->version != Version::DC_V1)) {
+        send_data_size = (sizeof(header) + size + 3) & ~3;
+      } else {
+        send_data_size = (sizeof(header) + size);
+      }
+      logical_size = send_data_size;
+      header.command = cmd;
+      header.flag = flag;
+      header.size = send_data_size;
+      send_data.append(reinterpret_cast<const char*>(&header), sizeof(header));
+      break;
+    }
+    case Version::PC_PATCH:
+    case Version::BB_PATCH:
+    case Version::PC_NTE:
+    case Version::PC_V2: {
+      PSOCommandHeaderPC header;
+      if (this->crypt_out.get()) {
+        send_data_size = (sizeof(header) + size + 3) & ~3;
+      } else {
+        send_data_size = (sizeof(header) + size);
+      }
+      logical_size = send_data_size;
+      header.size = send_data_size;
+      header.command = cmd;
+      header.flag = flag;
+      send_data.append(reinterpret_cast<const char*>(&header), sizeof(header));
+      break;
+    }
+    case Version::BB_V4: {
+      // BB has an annoying behavior here: command lengths must be multiples of
+      // 4, but the actual data length must be a multiple of 8. If the size
+      // field is not divisible by 8, 4 extra bytes are sent anyway. This
+      // behavior only applies when encryption is enabled - any commands sent
+      // before encryption is enabled have no size restrictions (except they
+      // must include a full header and must fit in the client's receive
+      // buffer), and no implicit extra bytes are sent.
+      PSOCommandHeaderBB header;
+      if (this->crypt_out.get()) {
+        send_data_size = (sizeof(header) + size + 7) & ~7;
+      } else {
+        send_data_size = (sizeof(header) + size);
+      }
+      logical_size = (sizeof(header) + size + 3) & ~3;
+      header.size = logical_size;
+      header.command = cmd;
+      header.flag = flag;
+      send_data.append(reinterpret_cast<const char*>(&header), sizeof(header));
+      break;
+    }
+
+    default:
+      throw logic_error("unimplemented game version in send_command");
+  }
+
+  // All versions of PSO I've seen (so far) have a receive buffer 0x7C00
+  // bytes in size
+  if (send_data_size > 0x7C00) {
+    throw runtime_error("outbound command too large");
+  }
+
+  send_data.reserve(send_data_size);
+  for (const auto& b : blocks) {
+    send_data.append(reinterpret_cast<const char*>(b.first), b.second);
+  }
+  send_data.resize(send_data_size, '\0');
+
+  if (!silent && (command_data_log.should_log(LogLevel::INFO)) && (this->terminal_send_color != TerminalFormat::END)) {
+    if (use_terminal_colors && this->terminal_send_color != TerminalFormat::NORMAL) {
+      print_color_escape(stderr, TerminalFormat::FG_YELLOW, TerminalFormat::BOLD, TerminalFormat::END);
+    }
+    if (version == Version::BB_V4) {
+      command_data_log.info("Sending to %s (version=BB command=%04hX flag=%08" PRIX32 ")",
+          this->name.c_str(), cmd, flag);
+    } else {
+      command_data_log.info("Sending to %s (version=%s command=%02hX flag=%02" PRIX32 ")",
+          this->name.c_str(), name_for_enum(version), cmd, flag);
+    }
+    print_data(stderr, send_data.data(), logical_size, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
+    if (use_terminal_colors && this->terminal_send_color != TerminalFormat::NORMAL) {
+      print_color_escape(stderr, TerminalFormat::NORMAL, TerminalFormat::END);
+    }
+  }
+
+  if (this->crypt_out.get()) {
+    this->crypt_out->encrypt(send_data.data(), send_data.size());
+  }
+
+  struct evbuffer* buf = bufferevent_get_output(this->bev.get());
+  evbuffer_add(buf, send_data.data(), send_data.size());
+}
+
+void Channel::send(uint16_t cmd, uint32_t flag, const void* data, size_t size, bool silent) {
+  this->send(cmd, flag, {make_pair(data, size)}, silent);
+}
+
+void Channel::send(uint16_t cmd, uint32_t flag, const string& data, bool silent) {
+  this->send(cmd, flag, data.data(), data.size(), silent);
+}
+
+void Channel::send(const void* data, size_t size, bool silent) {
+  size_t header_size = (this->version == Version::BB_V4) ? 8 : 4;
+  const auto* header = reinterpret_cast<const PSOCommandHeader*>(data);
+  this->send(
+      header->command(this->version),
+      header->flag(this->version),
+      reinterpret_cast<const uint8_t*>(data) + header_size,
+      size - header_size,
+      silent);
+}
+
+void Channel::send(const string& data, bool silent) {
+  return this->send(data.data(), data.size(), silent);
+}
+
+void Channel::dispatch_on_input(struct bufferevent*, void* ctx) {
+  Channel* ch = reinterpret_cast<Channel*>(ctx);
+  // The client can be disconnected during on_command_received, so we have to
+  // make sure ch->bev is valid every time before calling recv()
+  while (ch->bev.get()) {
+    Message msg;
+    try {
+      msg = ch->recv();
+    } catch (const out_of_range&) {
+      break;
+    } catch (const exception& e) {
+      channel_exceptions_log.warning("Error receiving on channel: %s", e.what());
+      ch->on_error(*ch, BEV_EVENT_ERROR);
+      break;
+    }
+    if (ch->on_command_received) {
+      ch->on_command_received(*ch, msg.command, msg.flag, msg.data);
+    }
+  }
+}
+
+void Channel::dispatch_on_error(struct bufferevent*, short events, void* ctx) {
+  Channel* ch = reinterpret_cast<Channel*>(ctx);
+  if (ch->on_error) {
+    ch->on_error(*ch, events);
+  } else {
+    ch->disconnect();
+  }
+}

src/Channel.hh

@@ -1,103 +1,103 @@
-#pragma once
-
-#include <netinet/in.h>
-
-#include <memory>
-#include <string>
-
-#include "PSOEncryption.hh"
-#include "PSOProtocol.hh"
-#include "Version.hh"
-
-struct Channel {
-  std::unique_ptr<struct bufferevent, void (*)(struct bufferevent*)> bev;
-  struct sockaddr_storage local_addr;
-  struct sockaddr_storage remote_addr;
-  uint64_t virtual_network_id; // 0 = normal TCP connection
-
-  Version version;
-  uint8_t language;
-  std::shared_ptr<PSOEncryption> crypt_in;
-  std::shared_ptr<PSOEncryption> crypt_out;
-
-  std::string name;
-  TerminalFormat terminal_send_color;
-  TerminalFormat terminal_recv_color;
-
-  struct Message {
-    uint16_t command;
-    uint32_t flag;
-    std::string data;
-  };
-
-  typedef void (*on_command_received_t)(Channel&, uint16_t, uint32_t, std::string&);
-  typedef void (*on_error_t)(Channel&, short);
-
-  on_command_received_t on_command_received;
-  on_error_t on_error;
-  void* context_obj;
-
-  // Creates an unconnected channel
-  Channel(
-      Version version,
-      uint8_t language,
-      on_command_received_t on_command_received,
-      on_error_t on_error,
-      void* context_obj,
-      const std::string& name,
-      TerminalFormat terminal_send_color = TerminalFormat::END,
-      TerminalFormat terminal_recv_color = TerminalFormat::END);
-  // Creates a connected channel
-  Channel(
-      struct bufferevent* bev,
-      uint64_t virtual_network_id,
-      Version version,
-      uint8_t language,
-      on_command_received_t on_command_received,
-      on_error_t on_error,
-      void* context_obj,
-      const std::string& name = "",
-      TerminalFormat terminal_send_color = TerminalFormat::END,
-      TerminalFormat terminal_recv_color = TerminalFormat::END);
-  Channel(const Channel& other) = delete;
-  Channel(Channel&& other) = delete;
-  Channel& operator=(const Channel& other) = delete;
-  Channel& operator=(Channel&& other) = delete;
-
-  void replace_with(
-      Channel&& other,
-      on_command_received_t on_command_received,
-      on_error_t on_error,
-      void* context_obj,
-      const std::string& name = "");
-
-  void set_bufferevent(struct bufferevent* bev, uint64_t virtual_network_id);
-
-  inline bool connected() const {
-    return this->bev.get() != nullptr;
-  }
-  void disconnect();
-
-  // Receives a message. Throws std::out_of_range if no messages are available.
-  Message recv();
-
-  // Sends a message with an automatically-constructed header.
-  void send(uint16_t cmd, uint32_t flag = 0, bool silent = false);
-  void send(uint16_t cmd, uint32_t flag, const void* data, size_t size, bool silent = false);
-  void send(uint16_t cmd, uint32_t flag, const std::vector<std::pair<const void*, size_t>> blocks, bool silent = false);
-  void send(uint16_t cmd, uint32_t flag, const std::string& data, bool silent = false);
-  template <typename CmdT>
-    requires(!std::is_pointer_v<CmdT>)
-  void send(uint16_t cmd, uint32_t flag, const CmdT& data, bool silent = false) {
-    this->send(cmd, flag, &data, sizeof(data), silent);
-  }
-
-  // Sends a message with a pre-existing header (as the first few bytes in the
-  // data)
-  void send(const void* data, size_t size, bool silent = false);
-  void send(const std::string& data, bool silent = false);
-
-private:
-  static void dispatch_on_input(struct bufferevent*, void* ctx);
-  static void dispatch_on_error(struct bufferevent*, short events, void* ctx);
-};
+#pragma once
+
+#include <netinet/in.h>
+
+#include <memory>
+#include <string>
+
+#include "PSOEncryption.hh"
+#include "PSOProtocol.hh"
+#include "Version.hh"
+
+struct Channel {
+  std::unique_ptr<struct bufferevent, void (*)(struct bufferevent*)> bev;
+  struct sockaddr_storage local_addr;
+  struct sockaddr_storage remote_addr;
+  uint64_t virtual_network_id; // 0 = normal TCP connection
+
+  Version version;
+  uint8_t language;
+  std::shared_ptr<PSOEncryption> crypt_in;
+  std::shared_ptr<PSOEncryption> crypt_out;
+
+  std::string name;
+  TerminalFormat terminal_send_color;
+  TerminalFormat terminal_recv_color;
+
+  struct Message {
+    uint16_t command;
+    uint32_t flag;
+    std::string data;
+  };
+
+  typedef void (*on_command_received_t)(Channel&, uint16_t, uint32_t, std::string&);
+  typedef void (*on_error_t)(Channel&, short);
+
+  on_command_received_t on_command_received;
+  on_error_t on_error;
+  void* context_obj;
+
+  // Creates an unconnected channel
+  Channel(
+      Version version,
+      uint8_t language,
+      on_command_received_t on_command_received,
+      on_error_t on_error,
+      void* context_obj,
+      const std::string& name,
+      TerminalFormat terminal_send_color = TerminalFormat::END,
+      TerminalFormat terminal_recv_color = TerminalFormat::END);
+  // Creates a connected channel
+  Channel(
+      struct bufferevent* bev,
+      uint64_t virtual_network_id,
+      Version version,
+      uint8_t language,
+      on_command_received_t on_command_received,
+      on_error_t on_error,
+      void* context_obj,
+      const std::string& name = "",
+      TerminalFormat terminal_send_color = TerminalFormat::END,
+      TerminalFormat terminal_recv_color = TerminalFormat::END);
+  Channel(const Channel& other) = delete;
+  Channel(Channel&& other) = delete;
+  Channel& operator=(const Channel& other) = delete;
+  Channel& operator=(Channel&& other) = delete;
+
+  void replace_with(
+      Channel&& other,
+      on_command_received_t on_command_received,
+      on_error_t on_error,
+      void* context_obj,
+      const std::string& name = "");
+
+  void set_bufferevent(struct bufferevent* bev, uint64_t virtual_network_id);
+
+  inline bool connected() const {
+    return this->bev.get() != nullptr;
+  }
+  void disconnect();
+
+  // Receives a message. Throws std::out_of_range if no messages are available.
+  Message recv();
+
+  // Sends a message with an automatically-constructed header.
+  void send(uint16_t cmd, uint32_t flag = 0, bool silent = false);
+  void send(uint16_t cmd, uint32_t flag, const void* data, size_t size, bool silent = false);
+  void send(uint16_t cmd, uint32_t flag, const std::vector<std::pair<const void*, size_t>> blocks, bool silent = false);
+  void send(uint16_t cmd, uint32_t flag, const std::string& data, bool silent = false);
+  template <typename CmdT>
+    requires(!std::is_pointer_v<CmdT>)
+  void send(uint16_t cmd, uint32_t flag, const CmdT& data, bool silent = false) {
+    this->send(cmd, flag, &data, sizeof(data), silent);
+  }
+
+  // Sends a message with a pre-existing header (as the first few bytes in the
+  // data)
+  void send(const void* data, size_t size, bool silent = false);
+  void send(const std::string& data, bool silent = false);
+
+private:
+  static void dispatch_on_input(struct bufferevent*, void* ctx);
+  static void dispatch_on_error(struct bufferevent*, short events, void* ctx);
+};

src/ChatCommands.hh

@@ -1,14 +1,14 @@
-#pragma once
-
-#include <stdint.h>
-
-#include <memory>
-#include <string>
-
-#include "Client.hh"
-#include "Lobby.hh"
-#include "ProxyServer.hh"
-#include "ServerState.hh"
-
-void on_chat_command(std::shared_ptr<Client> c, const std::string& text);
-void on_chat_command(std::shared_ptr<ProxyServer::LinkedSession> ses, const std::string& text);
+#pragma once
+
+#include <stdint.h>
+
+#include <memory>
+#include <string>
+
+#include "Client.hh"
+#include "Lobby.hh"
+#include "ProxyServer.hh"
+#include "ServerState.hh"
+
+void on_chat_command(std::shared_ptr<Client> c, const std::string& text);
+void on_chat_command(std::shared_ptr<ProxyServer::LinkedSession> ses, const std::string& text);

src/ChoiceSearch.cc

@@ -1,150 +1,150 @@
-#include "ChoiceSearch.hh"
-
-#include <inttypes.h>
-#include <string.h>
-
-#include "Client.hh"
-
-using namespace std;
-
-const vector<ChoiceSearchCategory> CHOICE_SEARCH_CATEGORIES({
-    ChoiceSearchCategory{
-        .id = 0x0001,
-        .name = "Level",
-        .choices = {
-            {0x0000, "Any"},
-            {0x0001, "Own level +/- 5"},
-            {0x0002, "Level 1-10"},
-            {0x0003, "Level 11-20"},
-            {0x0004, "Level 21-40"},
-            {0x0005, "Level 41-60"},
-            {0x0006, "Level 61-80"},
-            {0x0007, "Level 81-100"},
-            {0x0008, "Level 101-120"},
-            {0x0009, "Level 121-160"},
-            {0x000A, "Level 161-200"},
-        },
-        .client_matches = +[](shared_ptr<Client> searcher_c, shared_ptr<Client> target_c, uint16_t choice_id) -> bool {
-          if (choice_id == 0x0000) {
-            return true;
-          }
-          uint32_t target_level = target_c->character()->disp.stats.level + 1;
-          switch (choice_id) {
-            case 0x0001:
-              return (labs(static_cast<int32_t>(target_level - searcher_c->character()->disp.stats.level)) <= 5);
-            case 0x0002:
-              return (target_level <= 10);
-            case 0x0003:
-              return (target_level > 10) && (target_level <= 20);
-            case 0x0004:
-              return (target_level > 20) && (target_level <= 40);
-            case 0x0005:
-              return (target_level > 40) && (target_level <= 60);
-            case 0x0006:
-              return (target_level > 60) && (target_level <= 80);
-            case 0x0007:
-              return (target_level > 80) && (target_level <= 100);
-            case 0x0008:
-              return (target_level > 100) && (target_level <= 120);
-            case 0x0009:
-              return (target_level > 120) && (target_level <= 160);
-            case 0x000A:
-              return (target_level > 160) && (target_level <= 200);
-          }
-          return false;
-        },
-    },
-    ChoiceSearchCategory{
-        .id = 0x0002,
-        .name = "Class",
-        .choices = {
-            {0x0000, "Any"},
-            {0x0010, "Hunter"},
-            {0x0001, "HUmar"},
-            {0x0002, "HUnewearl"},
-            {0x0003, "HUcast"},
-            {0x000A, "HUcaseal"},
-            {0x0011, "Ranger"},
-            {0x0004, "RAmar"},
-            {0x000C, "RAmarl"},
-            {0x0005, "RAcast"},
-            {0x0006, "RAcaseal"},
-            {0x0012, "Force"},
-            {0x000B, "FOmar"},
-            {0x0007, "FOmarl"},
-            {0x0008, "FOnewm"},
-            {0x0009, "FOnewearl"},
-        },
-        .client_matches = +[](shared_ptr<Client>, shared_ptr<Client> target_c, uint16_t choice_id) -> bool {
-          switch (choice_id) {
-            case 0x0000:
-              return true;
-            case 0x0010:
-              return target_c->character()->disp.visual.class_flags & 0x20;
-            case 0x0011:
-              return target_c->character()->disp.visual.class_flags & 0x40;
-            case 0x0012:
-              return target_c->character()->disp.visual.class_flags & 0x80;
-            default:
-              return ((choice_id - 1) == target_c->character()->disp.visual.char_class);
-          }
-        },
-    },
-    ChoiceSearchCategory{
-        .id = 0x0003,
-        .name = "Platform",
-        .choices = {
-            {0x0000, "Any"},
-            {0x0001, "DC betas"},
-            {0x0002, "DC V1"},
-            {0x0003, "DC V2 / PC"},
-            {0x0004, "GC / Xbox Episodes 1&2"},
-            {0x0005, "GC Episode 3"},
-            {0x0006, "BB"},
-        },
-        .client_matches = +[](shared_ptr<Client>, shared_ptr<Client> target_c, uint16_t choice_id) -> bool {
-          if (choice_id == 0x0000) {
-            return true;
-          }
-          switch (target_c->version()) {
-            case Version::DC_NTE:
-            case Version::DC_V1_11_2000_PROTOTYPE:
-              return (choice_id == 0x0001);
-            case Version::DC_V1:
-              return (choice_id == 0x0002);
-            case Version::DC_V2:
-            case Version::PC_NTE:
-            case Version::PC_V2:
-              return (choice_id == 0x0003);
-            case Version::GC_NTE:
-            case Version::GC_V3:
-            case Version::XB_V3:
-              return (choice_id == 0x0004);
-            case Version::GC_EP3_NTE:
-            case Version::GC_EP3:
-              return (choice_id == 0x0005);
-            case Version::BB_V4:
-              return (choice_id == 0x0006);
-            default:
-              return false;
-          }
-        },
-    },
-    ChoiceSearchCategory{
-        .id = 0x0204,
-        .name = "Game mode",
-        .choices = {
-            {0x0000, "Any"},
-            {0x0001, "Normal"},
-            {0x0002, "Hard"},
-            {0x0003, "Very Hard"},
-            {0x0004, "Ultimate"},
-            {0x0005, "Battle"},
-            {0x0006, "Challenge"},
-        },
-        .client_matches = +[](shared_ptr<Client>, shared_ptr<Client> target_c, uint16_t choice_id) -> bool {
-          uint16_t target_choice_id = target_c->character()->choice_search_config.get_setting(0x0204);
-          return (choice_id == 0) || (target_choice_id == 0) || (choice_id == target_choice_id);
-        },
-    },
-});
+#include "ChoiceSearch.hh"
+
+#include <inttypes.h>
+#include <string.h>
+
+#include "Client.hh"
+
+using namespace std;
+
+const vector<ChoiceSearchCategory> CHOICE_SEARCH_CATEGORIES({
+    ChoiceSearchCategory{
+        .id = 0x0001,
+        .name = "Level",
+        .choices = {
+            {0x0000, "Any"},
+            {0x0001, "Own level +/- 5"},
+            {0x0002, "Level 1-10"},
+            {0x0003, "Level 11-20"},
+            {0x0004, "Level 21-40"},
+            {0x0005, "Level 41-60"},
+            {0x0006, "Level 61-80"},
+            {0x0007, "Level 81-100"},
+            {0x0008, "Level 101-120"},
+            {0x0009, "Level 121-160"},
+            {0x000A, "Level 161-200"},
+        },
+        .client_matches = +[](shared_ptr<Client> searcher_c, shared_ptr<Client> target_c, uint16_t choice_id) -> bool {
+          if (choice_id == 0x0000) {
+            return true;
+          }
+          uint32_t target_level = target_c->character()->disp.stats.level + 1;
+          switch (choice_id) {
+            case 0x0001:
+              return (labs(static_cast<int32_t>(target_level - searcher_c->character()->disp.stats.level)) <= 5);
+            case 0x0002:
+              return (target_level <= 10);
+            case 0x0003:
+              return (target_level > 10) && (target_level <= 20);
+            case 0x0004:
+              return (target_level > 20) && (target_level <= 40);
+            case 0x0005:
+              return (target_level > 40) && (target_level <= 60);
+            case 0x0006:
+              return (target_level > 60) && (target_level <= 80);
+            case 0x0007:
+              return (target_level > 80) && (target_level <= 100);
+            case 0x0008:
+              return (target_level > 100) && (target_level <= 120);
+            case 0x0009:
+              return (target_level > 120) && (target_level <= 160);
+            case 0x000A:
+              return (target_level > 160) && (target_level <= 200);
+          }
+          return false;
+        },
+    },
+    ChoiceSearchCategory{
+        .id = 0x0002,
+        .name = "Class",
+        .choices = {
+            {0x0000, "Any"},
+            {0x0010, "Hunter"},
+            {0x0001, "HUmar"},
+            {0x0002, "HUnewearl"},
+            {0x0003, "HUcast"},
+            {0x000A, "HUcaseal"},
+            {0x0011, "Ranger"},
+            {0x0004, "RAmar"},
+            {0x000C, "RAmarl"},
+            {0x0005, "RAcast"},
+            {0x0006, "RAcaseal"},
+            {0x0012, "Force"},
+            {0x000B, "FOmar"},
+            {0x0007, "FOmarl"},
+            {0x0008, "FOnewm"},
+            {0x0009, "FOnewearl"},
+        },
+        .client_matches = +[](shared_ptr<Client>, shared_ptr<Client> target_c, uint16_t choice_id) -> bool {
+          switch (choice_id) {
+            case 0x0000:
+              return true;
+            case 0x0010:
+              return target_c->character()->disp.visual.class_flags & 0x20;
+            case 0x0011:
+              return target_c->character()->disp.visual.class_flags & 0x40;
+            case 0x0012:
+              return target_c->character()->disp.visual.class_flags & 0x80;
+            default:
+              return ((choice_id - 1) == target_c->character()->disp.visual.char_class);
+          }
+        },
+    },
+    ChoiceSearchCategory{
+        .id = 0x0003,
+        .name = "Platform",
+        .choices = {
+            {0x0000, "Any"},
+            {0x0001, "DC betas"},
+            {0x0002, "DC V1"},
+            {0x0003, "DC V2 / PC"},
+            {0x0004, "GC / Xbox Episodes 1&2"},
+            {0x0005, "GC Episode 3"},
+            {0x0006, "BB"},
+        },
+        .client_matches = +[](shared_ptr<Client>, shared_ptr<Client> target_c, uint16_t choice_id) -> bool {
+          if (choice_id == 0x0000) {
+            return true;
+          }
+          switch (target_c->version()) {
+            case Version::DC_NTE:
+            case Version::DC_V1_11_2000_PROTOTYPE:
+              return (choice_id == 0x0001);
+            case Version::DC_V1:
+              return (choice_id == 0x0002);
+            case Version::DC_V2:
+            case Version::PC_NTE:
+            case Version::PC_V2:
+              return (choice_id == 0x0003);
+            case Version::GC_NTE:
+            case Version::GC_V3:
+            case Version::XB_V3:
+              return (choice_id == 0x0004);
+            case Version::GC_EP3_NTE:
+            case Version::GC_EP3:
+              return (choice_id == 0x0005);
+            case Version::BB_V4:
+              return (choice_id == 0x0006);
+            default:
+              return false;
+          }
+        },
+    },
+    ChoiceSearchCategory{
+        .id = 0x0204,
+        .name = "Game mode",
+        .choices = {
+            {0x0000, "Any"},
+            {0x0001, "Normal"},
+            {0x0002, "Hard"},
+            {0x0003, "Very Hard"},
+            {0x0004, "Ultimate"},
+            {0x0005, "Battle"},
+            {0x0006, "Challenge"},
+        },
+        .client_matches = +[](shared_ptr<Client>, shared_ptr<Client> target_c, uint16_t choice_id) -> bool {
+          uint16_t target_choice_id = target_c->character()->choice_search_config.get_setting(0x0204);
+          return (choice_id == 0) || (target_choice_id == 0) || (choice_id == target_choice_id);
+        },
+    },
+});

src/ChoiceSearch.hh

@@ -1,64 +1,64 @@
-#pragma once
-
-#include <functional>
-#include <memory>
-#include <phosg/Encoding.hh>
-#include <string>
-#include <vector>
-
-#include "Text.hh"
-
-class Client;
-
-template <bool IsBigEndian>
-struct ChoiceSearchConfigT {
-  using U16T = typename std::conditional<IsBigEndian, be_uint16_t, le_uint16_t>::type;
-  using U32T = typename std::conditional<IsBigEndian, be_uint32_t, le_uint32_t>::type;
-
-  U32T disabled = 1; // 0 = enabled, 1 = disabled. Unused in command C3
-  struct Entry {
-    U16T parent_choice_id = 0;
-    U16T choice_id = 0;
-  } __packed_ws__(Entry, 4);
-  parray<Entry, 5> entries;
-
-  int32_t get_setting(uint16_t parent_choice_id) const {
-    for (size_t z = 0; z < this->entries.size(); z++) {
-      if (this->entries[z].parent_choice_id == parent_choice_id) {
-        return this->entries[z].choice_id;
-      }
-    }
-    return -1;
-  }
-
-  operator ChoiceSearchConfigT<!IsBigEndian>() const {
-    ChoiceSearchConfigT<!IsBigEndian> ret;
-    ret.disabled = this->disabled.load();
-    for (size_t z = 0; z < this->entries.size(); z++) {
-      auto& ret_e = ret.entries[z];
-      const auto& this_e = this->entries[z];
-      ret_e.parent_choice_id = this_e.parent_choice_id.load();
-      ret_e.choice_id = this_e.choice_id.load();
-    }
-    return ret;
-  }
-} __packed__;
-
-using ChoiceSearchConfig = ChoiceSearchConfigT<false>;
-using ChoiceSearchConfigBE = ChoiceSearchConfigT<true>;
-check_struct_size(ChoiceSearchConfig, 0x18);
-check_struct_size(ChoiceSearchConfigBE, 0x18);
-
-struct ChoiceSearchCategory {
-  struct Choice {
-    uint16_t id;
-    const char* name;
-  };
-
-  uint16_t id;
-  const char* name;
-  std::vector<Choice> choices;
-  std::function<bool(std::shared_ptr<Client> searcher_c, std::shared_ptr<Client> target_c, uint16_t choice_id)> client_matches;
-};
-
-extern const std::vector<ChoiceSearchCategory> CHOICE_SEARCH_CATEGORIES;
+#pragma once
+
+#include <functional>
+#include <memory>
+#include <phosg/Encoding.hh>
+#include <string>
+#include <vector>
+
+#include "Text.hh"
+
+class Client;
+
+template <bool IsBigEndian>
+struct ChoiceSearchConfigT {
+  using U16T = typename std::conditional<IsBigEndian, be_uint16_t, le_uint16_t>::type;
+  using U32T = typename std::conditional<IsBigEndian, be_uint32_t, le_uint32_t>::type;
+
+  U32T disabled = 1; // 0 = enabled, 1 = disabled. Unused in command C3
+  struct Entry {
+    U16T parent_choice_id = 0;
+    U16T choice_id = 0;
+  } __packed_ws__(Entry, 4);
+  parray<Entry, 5> entries;
+
+  int32_t get_setting(uint16_t parent_choice_id) const {
+    for (size_t z = 0; z < this->entries.size(); z++) {
+      if (this->entries[z].parent_choice_id == parent_choice_id) {
+        return this->entries[z].choice_id;
+      }
+    }
+    return -1;
+  }
+
+  operator ChoiceSearchConfigT<!IsBigEndian>() const {
+    ChoiceSearchConfigT<!IsBigEndian> ret;
+    ret.disabled = this->disabled.load();
+    for (size_t z = 0; z < this->entries.size(); z++) {
+      auto& ret_e = ret.entries[z];
+      const auto& this_e = this->entries[z];
+      ret_e.parent_choice_id = this_e.parent_choice_id.load();
+      ret_e.choice_id = this_e.choice_id.load();
+    }
+    return ret;
+  }
+} __packed__;
+
+using ChoiceSearchConfig = ChoiceSearchConfigT<false>;
+using ChoiceSearchConfigBE = ChoiceSearchConfigT<true>;
+check_struct_size(ChoiceSearchConfig, 0x18);
+check_struct_size(ChoiceSearchConfigBE, 0x18);
+
+struct ChoiceSearchCategory {
+  struct Choice {
+    uint16_t id;
+    const char* name;
+  };
+
+  uint16_t id;
+  const char* name;
+  std::vector<Choice> choices;
+  std::function<bool(std::shared_ptr<Client> searcher_c, std::shared_ptr<Client> target_c, uint16_t choice_id)> client_matches;
+};
+
+extern const std::vector<ChoiceSearchCategory> CHOICE_SEARCH_CATEGORIES;

src/Client.hh

@@ -1,405 +1,418 @@
-#pragma once
-
-#include <netinet/in.h>
-
-#include <memory>
-#include <stdexcept>
-
-#include "Account.hh"
-#include "Channel.hh"
-#include "CommandFormats.hh"
-#include "Episode3/BattleRecord.hh"
-#include "Episode3/Tournament.hh"
-#include "FileContentsCache.hh"
-#include "FunctionCompiler.hh"
-#include "PSOEncryption.hh"
-#include "PSOProtocol.hh"
-#include "PatchFileIndex.hh"
-#include "Quest.hh"
-#include "QuestScript.hh"
-#include "TeamIndex.hh"
-#include "Text.hh"
-
-extern const uint64_t CLIENT_CONFIG_MAGIC;
-
-class Server;
-struct Lobby;
-
-class Client : public std::enable_shared_from_this<Client> {
-public:
-  enum class Flag : uint64_t {
-    // clang-format off
-
-    // This mask specifies which flags are sent to the client
-    // TODO: It'd be nice to use a pattern here (e.g. all server-side flags are
-    // in the high bits) but that would require re-recording or manually
-    // rewriting all the tests
-    CLIENT_SIDE_MASK                           = 0xFF3CFFFF7C0FFFFB,
-
-    // Version-related flags
-    CHECKED_FOR_DC_V1_PROTOTYPE                = 0x0000000000000002,
-    NO_D6_AFTER_LOBBY                          = 0x0000000000000100,
-    NO_D6                                      = 0x0000000000000200,
-    FORCE_ENGLISH_LANGUAGE_BB                  = 0x0000000000000400,
-
-    // Flags describing the behavior for send_function_call
-    NO_SEND_FUNCTION_CALL                      = 0x0000000000001000,
-    ENCRYPTED_SEND_FUNCTION_CALL               = 0x0000000000002000,
-    SEND_FUNCTION_CALL_CHECKSUM_ONLY           = 0x0000000000004000,
-    SEND_FUNCTION_CALL_NO_CACHE_PATCH          = 0x0000000000008000,
-    USE_OVERFLOW_FOR_SEND_FUNCTION_CALL        = 0x0000000000010000,
-
-    // State flags
-    LOADING                                    = 0x0000000000100000, // Server-side only
-    LOADING_QUEST                              = 0x0000000000200000, // Server-side only
-    LOADING_RUNNING_JOINABLE_QUEST             = 0x0000000000400000, // Server-side only
-    LOADING_TOURNAMENT                         = 0x0000000000800000, // Server-side only
-    IN_INFORMATION_MENU                        = 0x0000000001000000, // Server-side only
-    AT_WELCOME_MESSAGE                         = 0x0000000002000000, // Server-side only
-    SAVE_ENABLED                               = 0x0000000004000000,
-    HAS_EP3_CARD_DEFS                          = 0x0000000008000000,
-    HAS_EP3_MEDIA_UPDATES                      = 0x0000000010000000,
-    USE_OVERRIDE_RANDOM_SEED                   = 0x0000000020000000,
-    HAS_GUILD_CARD_NUMBER                      = 0x0000000040000000,
-    HAS_AUTO_PATCHES                           = 0x0000004000000000,
-    AT_BANK_COUNTER                            = 0x0000000080000000, // Server-side only
-    SHOULD_SEND_ARTIFICIAL_ITEM_STATE          = 0x0001000000000000, // Server-side only
-    SHOULD_SEND_ARTIFICIAL_ENEMY_AND_SET_STATE = 0x0040000000000000, // Server-side only
-    SHOULD_SEND_ARTIFICIAL_OBJECT_STATE        = 0x0080000000000000, // Server-side only
-    SHOULD_SEND_ARTIFICIAL_FLAG_STATE          = 0x0002000000000000, // Server-side only
-    SHOULD_SEND_ENABLE_SAVE                    = 0x0004000000000000,
-    SWITCH_ASSIST_ENABLED                      = 0x0000000100000000,
-
-    // Cheat mode and option flags
-    INFINITE_HP_ENABLED                        = 0x0000000200000000,
-    INFINITE_TP_ENABLED                        = 0x0000000400000000,
-    DEBUG_ENABLED                              = 0x0000000800000000,
-    ITEM_DROP_NOTIFICATIONS_1                  = 0x0010000000000000,
-    ITEM_DROP_NOTIFICATIONS_2                  = 0x0020000000000000,
-
-    // Proxy option flags
-    PROXY_SAVE_FILES                           = 0x0000001000000000,
-    PROXY_CHAT_COMMANDS_ENABLED                = 0x0000002000000000,
-    PROXY_PLAYER_NOTIFICATIONS_ENABLED         = 0x0000008000000000,
-    PROXY_SUPPRESS_CLIENT_PINGS                = 0x0000010000000000,
-    PROXY_SUPPRESS_REMOTE_LOGIN                = 0x0000020000000000,
-    PROXY_ZERO_REMOTE_GUILD_CARD               = 0x0000040000000000,
-    PROXY_EP3_INFINITE_MESETA_ENABLED          = 0x0000080000000000,
-    PROXY_EP3_INFINITE_TIME_ENABLED            = 0x0000100000000000,
-    PROXY_RED_NAME_ENABLED                     = 0x0000200000000000,
-    PROXY_BLANK_NAME_ENABLED                   = 0x0000400000000000,
-    PROXY_BLOCK_FUNCTION_CALLS                 = 0x0000800000000000,
-    PROXY_EP3_UNMASK_WHISPERS                  = 0x0008000000000000,
-    // clang-format on
-  };
-  enum class ItemDropNotificationMode {
-    NOTHING = 0,
-    RARES_ONLY = 1,
-    ALL_ITEMS = 2,
-    ALL_ITEMS_INCLUDING_MESETA = 3,
-  };
-
-  static constexpr uint64_t DEFAULT_FLAGS = static_cast<uint64_t>(Flag::PROXY_CHAT_COMMANDS_ENABLED);
-
-  struct Config {
-    uint64_t enabled_flags = DEFAULT_FLAGS; // Client::Flag enum
-    uint32_t specific_version = 0;
-    int32_t override_random_seed = 0;
-    uint8_t override_section_id = 0xFF; // FF = no override
-    uint8_t override_lobby_event = 0xFF; // FF = no override
-    uint8_t override_lobby_number = 0x80; // 80 = no override
-    uint32_t proxy_destination_address = 0;
-    uint16_t proxy_destination_port = 0;
-
-    Config() = default;
-
-    bool operator==(const Config& other) const = default;
-    bool operator!=(const Config& other) const = default;
-
-    bool should_update_vs(const Config& other) const;
-
-    [[nodiscard]] static inline bool check_flag(uint64_t enabled_flags, Flag flag) {
-      return !!(enabled_flags & static_cast<uint64_t>(flag));
-    }
-
-    [[nodiscard]] inline bool check_flag(Flag flag) const {
-      return this->check_flag(this->enabled_flags, flag);
-    }
-    inline void set_flag(Flag flag) {
-      this->enabled_flags |= static_cast<uint64_t>(flag);
-    }
-    inline void clear_flag(Flag flag) {
-      this->enabled_flags &= (~static_cast<uint64_t>(flag));
-    }
-    inline void toggle_flag(Flag flag) {
-      this->enabled_flags ^= static_cast<uint64_t>(flag);
-    }
-
-    void set_flags_for_version(Version version, int64_t sub_version);
-
-    ItemDropNotificationMode get_drop_notification_mode() const;
-    void set_drop_notification_mode(ItemDropNotificationMode new_mode);
-
-    template <size_t Bytes>
-    void parse_from(const parray<uint8_t, Bytes>& data) {
-      StringReader r(data.data(), data.size());
-      if (r.get_u32l() != CLIENT_CONFIG_MAGIC) {
-        throw std::invalid_argument("config signature is incorrect");
-      }
-      this->specific_version = r.get_u32l();
-      this->enabled_flags = r.get_u64l();
-      this->override_random_seed = r.get_u32l();
-      this->proxy_destination_address = r.get_u32b();
-      this->proxy_destination_port = r.get_u16l();
-      this->override_section_id = r.get_u8();
-      this->override_lobby_event = r.get_u8();
-      this->override_lobby_number = r.get_u8();
-    }
-
-    template <size_t Bytes>
-    void serialize_into(parray<uint8_t, Bytes>& data) const {
-      StringWriter w;
-      w.put_u32l(CLIENT_CONFIG_MAGIC);
-      w.put_u32l(this->specific_version);
-      w.put_u64l(this->enabled_flags & static_cast<uint64_t>(Flag::CLIENT_SIDE_MASK));
-      w.put_u32l(this->override_random_seed);
-      w.put_u32b(this->proxy_destination_address);
-      w.put_u16l(this->proxy_destination_port);
-      w.put_u8(this->override_section_id);
-      w.put_u8(this->override_lobby_event);
-      w.put_u8(this->override_lobby_number);
-
-      const auto& s = w.str();
-      for (size_t z = 0; z < s.size(); z++) {
-        data[z] = s[z];
-      }
-      data.clear_after(s.size(), 0xFF);
-    }
-  };
-
-  std::weak_ptr<Server> server;
-  uint64_t id;
-  PrefixedLogger log;
-
-  std::shared_ptr<Login> login;
-
-  // Network
-  Channel channel;
-  struct sockaddr_storage next_connection_addr;
-  ServerBehavior server_behavior;
-  bool should_disconnect;
-  bool should_send_to_lobby_server;
-  bool should_send_to_proxy_server;
-  std::unordered_map<std::string, std::function<void()>> disconnect_hooks;
-  std::shared_ptr<XBNetworkLocation> xb_netloc;
-  parray<le_uint32_t, 3> xb_9E_unknown_a1a;
-  uint8_t bb_connection_phase;
-  uint64_t ping_start_time;
-
-  // Lobby/positioning
-  Config config;
-  Config synced_config;
-  std::unique_ptr<parray<le_uint32_t, 0x20>> override_variations;
-  int32_t sub_version;
-  float x;
-  float z;
-  uint32_t floor;
-  std::weak_ptr<Lobby> lobby;
-  uint8_t lobby_client_id;
-  uint8_t lobby_arrow_color;
-  int64_t preferred_lobby_id; // <0 = no preference
-
-  std::unique_ptr<struct event, void (*)(struct event*)> save_game_data_event;
-  std::unique_ptr<struct event, void (*)(struct event*)> send_ping_event;
-  std::unique_ptr<struct event, void (*)(struct event*)> idle_timeout_event;
-  int16_t card_battle_table_number;
-  uint16_t card_battle_table_seat_number;
-  uint16_t card_battle_table_seat_state;
-  std::weak_ptr<Episode3::Tournament::Team> ep3_tournament_team;
-  std::shared_ptr<const Episode3::BattleRecord> ep3_prev_battle_record;
-  std::shared_ptr<const Menu> last_menu_sent;
-  uint32_t last_game_info_requested;
-  struct JoinCommand {
-    uint16_t command;
-    uint32_t flag;
-    std::string data;
-  };
-  std::unique_ptr<std::deque<JoinCommand>> game_join_command_queue;
-
-  // Character / game data
-  struct PendingItemTrade {
-    uint8_t other_client_id;
-    bool confirmed; // true if client has sent a D2 command
-    std::vector<ItemData> items;
-  };
-  struct PendingCardTrade {
-    uint8_t other_client_id;
-    bool confirmed; // true if client has sent an EE D2 command
-    std::vector<std::pair<uint32_t, uint32_t>> card_to_count;
-  };
-  bool should_update_play_time;
-  std::unordered_set<uint32_t> blocked_senders;
-  std::unique_ptr<PlayerDispDataDCPCV3> v1_v2_last_reported_disp;
-  // These are null unless the client is within the trade sequence (D0-D4 or EE commands)
-  std::unique_ptr<PendingItemTrade> pending_item_trade;
-  std::unique_ptr<PendingCardTrade> pending_card_trade;
-  std::shared_ptr<Episode3::PlayerConfig> ep3_config; // Null for non-Ep3
-  int8_t bb_character_index;
-  ItemData bb_identify_result;
-  std::array<std::vector<ItemData>, 3> bb_shop_contents;
-
-  // Miscellaneous (used by chat commands)
-  uint32_t next_exp_value; // next EXP value to give
-  RecentSwitchFlags recent_switch_flags; // used for switch assist
-  bool can_chat;
-  struct PendingCharacterExport {
-    std::shared_ptr<const Account> dest_account;
-    ssize_t character_index = -1;
-    std::shared_ptr<const BBLicense> dest_bb_license; // Only used for $bbchar; null for $savechar
-  };
-  std::unique_ptr<PendingCharacterExport> pending_character_export;
-  std::deque<std::function<void(uint32_t, uint32_t)>> function_call_response_queue;
-
-  // File loading state
-  uint32_t dol_base_addr;
-  std::shared_ptr<DOLFileIndex::File> loading_dol_file;
-  std::unordered_map<std::string, std::shared_ptr<const std::string>> sending_files;
-
-  Client(
-      std::shared_ptr<Server> server,
-      struct bufferevent* bev,
-      uint64_t virtual_network_id,
-      Version version,
-      ServerBehavior server_behavior);
-  ~Client();
-
-  void update_channel_name();
-
-  void reschedule_save_game_data_event();
-  void reschedule_ping_and_timeout_events();
-
-  inline Version version() const {
-    return this->channel.version;
-  }
-  inline uint8_t language() const {
-    return this->channel.language;
-  }
-
-  void convert_account_to_temporary_if_nte();
-
-  void sync_config();
-
-  std::shared_ptr<ServerState> require_server_state() const;
-  std::shared_ptr<Lobby> require_lobby() const;
-
-  std::shared_ptr<const TeamIndex::Team> team() const;
-
-  bool evaluate_quest_availability_expression(
-      std::shared_ptr<const IntegralExpression> expr,
-      std::shared_ptr<const Lobby> game,
-      uint8_t event,
-      uint8_t difficulty,
-      size_t num_players,
-      bool v1_present) const;
-  bool can_see_quest(
-      std::shared_ptr<const Quest> q,
-      std::shared_ptr<const Lobby> game,
-      uint8_t event,
-      uint8_t difficulty,
-      size_t num_players,
-      bool v1_present) const;
-  bool can_play_quest(
-      std::shared_ptr<const Quest> q,
-      std::shared_ptr<const Lobby> game,
-      uint8_t event,
-      uint8_t difficulty,
-      size_t num_players,
-      bool v1_present) const;
-
-  bool can_use_chat_commands() const;
-
-  static void dispatch_save_game_data(evutil_socket_t, short, void* ctx);
-  void save_game_data();
-  static void dispatch_send_ping(evutil_socket_t, short, void* ctx);
-  void send_ping();
-  static void dispatch_idle_timeout(evutil_socket_t, short, void* ctx);
-  void idle_timeout();
-
-  void suspend_timeouts();
-
-  const std::string& get_bb_username() const;
-  void set_bb_username(const std::string& bb_username);
-
-  void create_battle_overlay(std::shared_ptr<const BattleRules> rules, std::shared_ptr<const LevelTable> level_table);
-  void create_challenge_overlay(Version version, size_t template_index, std::shared_ptr<const LevelTable> level_table);
-  inline void delete_overlay() {
-    this->overlay_character_data.reset();
-  }
-  inline bool has_overlay() const {
-    return this->overlay_character_data.get() != nullptr;
-  }
-
-  void import_blocked_senders(const parray<le_uint32_t, 30>& blocked_senders);
-
-  std::shared_ptr<PSOBBBaseSystemFile> system_file(bool allow_load = true);
-  std::shared_ptr<PSOBBCharacterFile> character(bool allow_load = true, bool allow_overlay = true);
-  std::shared_ptr<PSOBBGuildCardFile> guild_card_file(bool allow_load = true);
-  std::shared_ptr<const PSOBBBaseSystemFile> system_file(bool allow_load = true) const;
-  std::shared_ptr<const PSOBBCharacterFile> character(bool allow_load = true, bool allow_overlay = true) const;
-  std::shared_ptr<const PSOBBGuildCardFile> guild_card_file(bool allow_load = true) const;
-
-  void create_character_file(
-      uint32_t guild_card_number,
-      uint8_t language,
-      const PlayerDispDataBBPreview& preview,
-      std::shared_ptr<const LevelTable> level_table);
-
-  std::string system_filename() const;
-  static std::string character_filename(const std::string& bb_username, int8_t index);
-  static std::string backup_character_filename(uint32_t account_id, size_t index);
-  std::string character_filename(int8_t index = -1) const;
-  std::string guild_card_filename() const;
-  std::string shared_bank_filename() const;
-
-  std::string legacy_player_filename() const;
-  std::string legacy_account_filename() const;
-
-  void save_all();
-  void save_system_file() const;
-  static void save_character_file(
-      const std::string& filename,
-      std::shared_ptr<const PSOBBBaseSystemFile> sys,
-      std::shared_ptr<const PSOBBCharacterFile> character);
-  // Note: This function is not const because it updates the player's play time.
-  void save_character_file();
-  void save_guild_card_file() const;
-
-  void load_backup_character(uint32_t account_id, size_t index);
-  void save_and_unload_character();
-
-  PlayerBank& current_bank();
-  std::shared_ptr<PSOBBCharacterFile> current_bank_character();
-  bool use_shared_bank(); // Returns true if the bank exists; false if it was created
-  void use_character_bank(int8_t bb_character_index);
-  void use_default_bank();
-
-  void print_inventory(FILE* stream) const;
-  void print_bank(FILE* stream) const;
-
-private:
-  // The overlay character data is used in battle and challenge modes, when
-  // character data is temporarily replaced in-game. In other play modes and in
-  // lobbies, overlay_character_data is null.
-  std::shared_ptr<PSOBBBaseSystemFile> system_data;
-  std::shared_ptr<PSOBBCharacterFile> overlay_character_data;
-  std::shared_ptr<PSOBBCharacterFile> character_data;
-  std::shared_ptr<PSOBBGuildCardFile> guild_card_data;
-  std::shared_ptr<PlayerBank> external_bank;
-  std::shared_ptr<PSOBBCharacterFile> external_bank_character;
-  int8_t external_bank_character_index;
-  uint64_t last_play_time_update;
-
-  void save_and_clear_external_bank();
-
-  void load_all_files();
-};
+#pragma once
+
+#include <netinet/in.h>
+
+#include <memory>
+#include <stdexcept>
+
+#include "Account.hh"
+#include "Channel.hh"
+#include "CommandFormats.hh"
+#include "Episode3/BattleRecord.hh"
+#include "Episode3/Tournament.hh"
+#include "FileContentsCache.hh"
+#include "FunctionCompiler.hh"
+#include "PSOEncryption.hh"
+#include "PSOProtocol.hh"
+#include "PatchFileIndex.hh"
+#include "Quest.hh"
+#include "QuestScript.hh"
+#include "TeamIndex.hh"
+#include "Text.hh"
+
+extern const uint64_t CLIENT_CONFIG_MAGIC;
+
+class Server;
+struct Lobby;
+class Parsed6x70Data;
+
+class Client : public std::enable_shared_from_this<Client> {
+public:
+  enum class Flag : uint64_t {
+    // clang-format off
+
+    // This mask specifies which flags are sent to the client
+    // TODO: It'd be nice to use a pattern here (e.g. all server-side flags are
+    // in the high bits) but that would require re-recording or manually
+    // rewriting all the tests
+    CLIENT_SIDE_MASK                           = 0xFF3CFFFF7C0BFFFB,
+
+    // Version-related flags
+    CHECKED_FOR_DC_V1_PROTOTYPE                = 0x0000000000000002,
+    NO_D6_AFTER_LOBBY                          = 0x0000000000000100,
+    NO_D6                                      = 0x0000000000000200,
+    FORCE_ENGLISH_LANGUAGE_BB                  = 0x0000000000000400,
+
+    // Flags describing the behavior for send_function_call
+    HAS_SEND_FUNCTION_CALL                     = 0x0000000000001000,
+    ENCRYPTED_SEND_FUNCTION_CALL               = 0x0000000000002000,
+    SEND_FUNCTION_CALL_CHECKSUM_ONLY           = 0x0000000000004000,
+    SEND_FUNCTION_CALL_NO_CACHE_PATCH          = 0x0000000000008000,
+    CAN_RECEIVE_ENABLE_B2_QUEST                = 0x0000000000020000,
+    AWAITING_ENABLE_B2_QUEST                   = 0x0000000000040000, // Server-side only
+
+    // State flags
+    LOADING                                    = 0x0000000000100000, // Server-side only
+    LOADING_QUEST                              = 0x0000000000200000, // Server-side only
+    LOADING_RUNNING_JOINABLE_QUEST             = 0x0000000000400000, // Server-side only
+    LOADING_TOURNAMENT                         = 0x0000000000800000, // Server-side only
+    IN_INFORMATION_MENU                        = 0x0000000001000000, // Server-side only
+    AT_WELCOME_MESSAGE                         = 0x0000000002000000, // Server-side only
+    SAVE_ENABLED                               = 0x0000000004000000,
+    HAS_EP3_CARD_DEFS                          = 0x0000000008000000,
+    HAS_EP3_MEDIA_UPDATES                      = 0x0000000010000000,
+    USE_OVERRIDE_RANDOM_SEED                   = 0x0000000020000000,
+    HAS_GUILD_CARD_NUMBER                      = 0x0000000040000000,
+    HAS_AUTO_PATCHES                           = 0x0000004000000000,
+    AT_BANK_COUNTER                            = 0x0000000080000000, // Server-side only
+    SHOULD_SEND_ARTIFICIAL_ITEM_STATE          = 0x0001000000000000, // Server-side only
+    SHOULD_SEND_ARTIFICIAL_ENEMY_AND_SET_STATE = 0x0040000000000000, // Server-side only
+    SHOULD_SEND_ARTIFICIAL_OBJECT_STATE        = 0x0080000000000000, // Server-side only
+    SHOULD_SEND_ARTIFICIAL_FLAG_STATE          = 0x0002000000000000, // Server-side only
+    SHOULD_SEND_ARTIFICIAL_PLAYER_STATES       = 0x0200000000000000, // Server-side only
+    SHOULD_SEND_ENABLE_SAVE                    = 0x0004000000000000,
+    SWITCH_ASSIST_ENABLED                      = 0x0000000100000000,
+    IS_CLIENT_CUSTOMIZATION                    = 0x0100000000000000,
+
+    // Cheat mode and option flags
+    INFINITE_HP_ENABLED                        = 0x0000000200000000,
+    INFINITE_TP_ENABLED                        = 0x0000000400000000,
+    DEBUG_ENABLED                              = 0x0000000800000000,
+    ITEM_DROP_NOTIFICATIONS_1                  = 0x0010000000000000,
+    ITEM_DROP_NOTIFICATIONS_2                  = 0x0020000000000000,
+
+    // Proxy option flags
+    PROXY_SAVE_FILES                           = 0x0000001000000000,
+    PROXY_CHAT_COMMANDS_ENABLED                = 0x0000002000000000,
+    PROXY_PLAYER_NOTIFICATIONS_ENABLED         = 0x0000008000000000,
+    PROXY_SUPPRESS_CLIENT_PINGS                = 0x0000010000000000,
+    PROXY_SUPPRESS_REMOTE_LOGIN                = 0x0000020000000000,
+    PROXY_ZERO_REMOTE_GUILD_CARD               = 0x0000040000000000,
+    PROXY_EP3_INFINITE_MESETA_ENABLED          = 0x0000080000000000,
+    PROXY_EP3_INFINITE_TIME_ENABLED            = 0x0000100000000000,
+    PROXY_RED_NAME_ENABLED                     = 0x0000200000000000,
+    PROXY_BLANK_NAME_ENABLED                   = 0x0000400000000000,
+    PROXY_BLOCK_FUNCTION_CALLS                 = 0x0000800000000000,
+    PROXY_EP3_UNMASK_WHISPERS                  = 0x0008000000000000,
+    PROXY_VIRTUAL_CLIENT                       = 0x0400000000000000,
+    // clang-format on
+  };
+  enum class ItemDropNotificationMode {
+    NOTHING = 0,
+    RARES_ONLY = 1,
+    ALL_ITEMS = 2,
+    ALL_ITEMS_INCLUDING_MESETA = 3,
+  };
+
+  static constexpr uint64_t DEFAULT_FLAGS = static_cast<uint64_t>(Flag::PROXY_CHAT_COMMANDS_ENABLED);
+
+  struct Config {
+    uint64_t enabled_flags = DEFAULT_FLAGS; // Client::Flag enum
+    uint32_t specific_version = 0;
+    int32_t override_random_seed = 0;
+    uint8_t override_section_id = 0xFF; // FF = no override
+    uint8_t override_lobby_event = 0xFF; // FF = no override
+    uint8_t override_lobby_number = 0x80; // 80 = no override
+    uint32_t proxy_destination_address = 0;
+    uint16_t proxy_destination_port = 0;
+
+    Config() = default;
+
+    bool operator==(const Config& other) const = default;
+    bool operator!=(const Config& other) const = default;
+
+    bool should_update_vs(const Config& other) const;
+
+    [[nodiscard]] static inline bool check_flag(uint64_t enabled_flags, Flag flag) {
+      return !!(enabled_flags & static_cast<uint64_t>(flag));
+    }
+
+    [[nodiscard]] inline bool check_flag(Flag flag) const {
+      return this->check_flag(this->enabled_flags, flag);
+    }
+    inline void set_flag(Flag flag) {
+      this->enabled_flags |= static_cast<uint64_t>(flag);
+    }
+    inline void clear_flag(Flag flag) {
+      this->enabled_flags &= (~static_cast<uint64_t>(flag));
+    }
+    inline void toggle_flag(Flag flag) {
+      this->enabled_flags ^= static_cast<uint64_t>(flag);
+    }
+
+    void set_flags_for_version(Version version, int64_t sub_version);
+
+    ItemDropNotificationMode get_drop_notification_mode() const;
+    void set_drop_notification_mode(ItemDropNotificationMode new_mode);
+
+    template <size_t Bytes>
+    void parse_from(const parray<uint8_t, Bytes>& data) {
+      StringReader r(data.data(), data.size());
+      if (r.get_u32l() != CLIENT_CONFIG_MAGIC) {
+        throw std::invalid_argument("config signature is incorrect");
+      }
+      this->specific_version = r.get_u32l();
+      this->enabled_flags = r.get_u64l();
+      this->override_random_seed = r.get_u32l();
+      this->proxy_destination_address = r.get_u32b();
+      this->proxy_destination_port = r.get_u16l();
+      this->override_section_id = r.get_u8();
+      this->override_lobby_event = r.get_u8();
+      this->override_lobby_number = r.get_u8();
+    }
+
+    template <size_t Bytes>
+    void serialize_into(parray<uint8_t, Bytes>& data) const {
+      StringWriter w;
+      w.put_u32l(CLIENT_CONFIG_MAGIC);
+      w.put_u32l(this->specific_version);
+      w.put_u64l(this->enabled_flags & static_cast<uint64_t>(Flag::CLIENT_SIDE_MASK));
+      w.put_u32l(this->override_random_seed);
+      w.put_u32b(this->proxy_destination_address);
+      w.put_u16l(this->proxy_destination_port);
+      w.put_u8(this->override_section_id);
+      w.put_u8(this->override_lobby_event);
+      w.put_u8(this->override_lobby_number);
+
+      const auto& s = w.str();
+      for (size_t z = 0; z < s.size(); z++) {
+        data[z] = s[z];
+      }
+      data.clear_after(s.size(), 0xFF);
+    }
+  };
+
+  std::weak_ptr<Server> server;
+  uint64_t id;
+  PrefixedLogger log;
+
+  std::shared_ptr<Login> login;
+
+  // Network
+  Channel channel;
+  struct sockaddr_storage next_connection_addr;
+  ServerBehavior server_behavior;
+  bool should_disconnect;
+  bool should_send_to_lobby_server;
+  bool should_send_to_proxy_server;
+  std::unordered_map<std::string, std::function<void()>> disconnect_hooks;
+  std::shared_ptr<XBNetworkLocation> xb_netloc;
+  parray<le_uint32_t, 3> xb_9E_unknown_a1a;
+  uint8_t bb_connection_phase;
+  uint64_t ping_start_time;
+
+  // Lobby/positioning
+  Config config;
+  Config synced_config;
+  std::unique_ptr<parray<le_uint32_t, 0x20>> override_variations;
+  int32_t sub_version;
+  float x;
+  float z;
+  uint32_t floor;
+  std::weak_ptr<Lobby> lobby;
+  uint8_t lobby_client_id;
+  uint8_t lobby_arrow_color;
+  int64_t preferred_lobby_id; // <0 = no preference
+
+  std::unique_ptr<struct event, void (*)(struct event*)> save_game_data_event;
+  std::unique_ptr<struct event, void (*)(struct event*)> send_ping_event;
+  std::unique_ptr<struct event, void (*)(struct event*)> idle_timeout_event;
+  int16_t card_battle_table_number;
+  uint16_t card_battle_table_seat_number;
+  uint16_t card_battle_table_seat_state;
+  std::weak_ptr<Episode3::Tournament::Team> ep3_tournament_team;
+  std::shared_ptr<const Episode3::BattleRecord> ep3_prev_battle_record;
+  std::shared_ptr<const Menu> last_menu_sent;
+  uint32_t last_game_info_requested;
+  struct JoinCommand {
+    uint16_t command;
+    uint32_t flag;
+    std::string data;
+  };
+  std::unique_ptr<std::deque<JoinCommand>> game_join_command_queue;
+
+  // Character / game data
+  struct PendingItemTrade {
+    uint8_t other_client_id;
+    bool confirmed; // true if client has sent a D2 command
+    std::vector<ItemData> items;
+  };
+  struct PendingCardTrade {
+    uint8_t other_client_id;
+    bool confirmed; // true if client has sent an EE D2 command
+    std::vector<std::pair<uint32_t, uint32_t>> card_to_count;
+  };
+  bool should_update_play_time;
+  std::unordered_set<uint32_t> blocked_senders;
+  std::unique_ptr<PlayerDispDataDCPCV3> v1_v2_last_reported_disp;
+  std::shared_ptr<Parsed6x70Data> last_reported_6x70;
+  // These are null unless the client is within the trade sequence (D0-D4 or EE commands)
+  std::unique_ptr<PendingItemTrade> pending_item_trade;
+  std::unique_ptr<PendingCardTrade> pending_card_trade;
+  uint32_t telepipe_lobby_id;
+  G_SetTelepipeState_6x68 telepipe_state;
+  std::shared_ptr<Episode3::PlayerConfig> ep3_config; // Null for non-Ep3
+  int8_t bb_character_index;
+  ItemData bb_identify_result;
+  std::array<std::vector<ItemData>, 3> bb_shop_contents;
+
+  // Miscellaneous (used by chat commands)
+  uint32_t next_exp_value; // next EXP value to give
+  RecentSwitchFlags recent_switch_flags; // used for switch assist
+  bool can_chat;
+  struct PendingCharacterExport {
+    std::shared_ptr<const Account> dest_account;
+    ssize_t character_index = -1;
+    std::shared_ptr<const BBLicense> dest_bb_license; // Only used for $bbchar; null for $savechar
+  };
+  std::unique_ptr<PendingCharacterExport> pending_character_export;
+  std::deque<std::function<void(uint32_t, uint32_t)>> function_call_response_queue;
+
+  // File loading state
+  uint32_t dol_base_addr;
+  std::shared_ptr<DOLFileIndex::File> loading_dol_file;
+  std::unordered_map<std::string, std::shared_ptr<const std::string>> sending_files;
+
+  Client(
+      std::shared_ptr<Server> server,
+      struct bufferevent* bev,
+      uint64_t virtual_network_id,
+      Version version,
+      ServerBehavior server_behavior);
+  ~Client();
+
+  void update_channel_name();
+
+  void reschedule_save_game_data_event();
+  void reschedule_ping_and_timeout_events();
+
+  inline Version version() const {
+    return this->channel.version;
+  }
+  inline uint8_t language() const {
+    return this->channel.language;
+  }
+
+  void convert_account_to_temporary_if_nte();
+
+  void sync_config();
+
+  std::shared_ptr<ServerState> require_server_state() const;
+  std::shared_ptr<Lobby> require_lobby() const;
+
+  std::shared_ptr<const TeamIndex::Team> team() const;
+
+  bool evaluate_quest_availability_expression(
+      std::shared_ptr<const IntegralExpression> expr,
+      std::shared_ptr<const Lobby> game,
+      uint8_t event,
+      uint8_t difficulty,
+      size_t num_players,
+      bool v1_present) const;
+  bool can_see_quest(
+      std::shared_ptr<const Quest> q,
+      std::shared_ptr<const Lobby> game,
+      uint8_t event,
+      uint8_t difficulty,
+      size_t num_players,
+      bool v1_present) const;
+  bool can_play_quest(
+      std::shared_ptr<const Quest> q,
+      std::shared_ptr<const Lobby> game,
+      uint8_t event,
+      uint8_t difficulty,
+      size_t num_players,
+      bool v1_present) const;
+
+  bool can_use_chat_commands() const;
+
+  static void dispatch_save_game_data(evutil_socket_t, short, void* ctx);
+  void save_game_data();
+  static void dispatch_send_ping(evutil_socket_t, short, void* ctx);
+  void send_ping();
+  static void dispatch_idle_timeout(evutil_socket_t, short, void* ctx);
+  void idle_timeout();
+
+  void suspend_timeouts();
+
+  const std::string& get_bb_username() const;
+  void set_bb_username(const std::string& bb_username);
+
+  void create_battle_overlay(std::shared_ptr<const BattleRules> rules, std::shared_ptr<const LevelTable> level_table);
+  void create_challenge_overlay(Version version, size_t template_index, std::shared_ptr<const LevelTable> level_table);
+  inline void delete_overlay() {
+    this->overlay_character_data.reset();
+  }
+  inline bool has_overlay() const {
+    return this->overlay_character_data.get() != nullptr;
+  }
+
+  void import_blocked_senders(const parray<le_uint32_t, 30>& blocked_senders);
+
+  std::shared_ptr<PSOBBBaseSystemFile> system_file(bool allow_load = true);
+  std::shared_ptr<PSOBBCharacterFile> character(bool allow_load = true, bool allow_overlay = true);
+  std::shared_ptr<PSOBBGuildCardFile> guild_card_file(bool allow_load = true);
+  std::shared_ptr<const PSOBBBaseSystemFile> system_file(bool allow_load = true) const;
+  std::shared_ptr<const PSOBBCharacterFile> character(bool allow_load = true, bool allow_overlay = true) const;
+  std::shared_ptr<const PSOBBGuildCardFile> guild_card_file(bool allow_load = true) const;
+
+  void create_character_file(
+      uint32_t guild_card_number,
+      uint8_t language,
+      const PlayerDispDataBBPreview& preview,
+      std::shared_ptr<const LevelTable> level_table);
+
+  std::string system_filename() const;
+  static std::string character_filename(const std::string& bb_username, int8_t index);
+  static std::string backup_character_filename(uint32_t account_id, size_t index, bool is_ep3);
+  std::string character_filename(int8_t index = -1) const;
+  std::string guild_card_filename() const;
+  std::string shared_bank_filename() const;
+
+  std::string legacy_player_filename() const;
+  std::string legacy_account_filename() const;
+
+  void save_all();
+  void save_system_file() const;
+  static void save_character_file(
+      const std::string& filename,
+      std::shared_ptr<const PSOBBBaseSystemFile> sys,
+      std::shared_ptr<const PSOBBCharacterFile> character);
+  static void save_ep3_character_file(
+      const std::string& filename,
+      const PSOGCEp3CharacterFile::Character& character);
+  // Note: This function is not const because it updates the player's play time.
+  void save_character_file();
+  void save_guild_card_file() const;
+
+  void load_backup_character(uint32_t account_id, size_t index);
+  std::shared_ptr<PSOGCEp3CharacterFile::Character> load_ep3_backup_character(uint32_t account_id, size_t index);
+  void save_and_unload_character();
+
+  PlayerBank200& current_bank();
+  std::shared_ptr<PSOBBCharacterFile> current_bank_character();
+  bool use_shared_bank(); // Returns true if the bank exists; false if it was created
+  void use_character_bank(int8_t bb_character_index);
+  void use_default_bank();
+
+  void print_inventory(FILE* stream) const;
+  void print_bank(FILE* stream) const;
+
+private:
+  // The overlay character data is used in battle and challenge modes, when
+  // character data is temporarily replaced in-game. In other play modes and in
+  // lobbies, overlay_character_data is null.
+  std::shared_ptr<PSOBBBaseSystemFile> system_data;
+  std::shared_ptr<PSOBBCharacterFile> overlay_character_data;
+  std::shared_ptr<PSOBBCharacterFile> character_data;
+  std::shared_ptr<PSOBBGuildCardFile> guild_card_data;
+  std::shared_ptr<PlayerBank200> external_bank;
+  std::shared_ptr<PSOBBCharacterFile> external_bank_character;
+  int8_t external_bank_character_index;
+  uint64_t last_play_time_update;
+
+  void save_and_clear_external_bank();
+
+  void load_all_files();
+  void update_character_data_after_load(std::shared_ptr<PSOBBCharacterFile> character_data);
+};

src/CommonItemSet.cc

@@ -16,6 +16,16 @@ JSON to_json(const parray<IntT, Count>& v) {
   return ret;
 }
 
+template <typename IntT, size_t Count>
+void from_json_into(const JSON& json, parray<IntT, Count>& ret) {
+  if (json.size() != Count) {
+    throw runtime_error("incorrect array length");
+  }
+  for (size_t z = 0; z < Count; z++) {
+    ret[z] = json.at(z).as_int();
+  }
+}
+
 template <typename IntT, size_t Count>
 JSON to_json(const parray<CommonItemSet::Table::Range<IntT>, Count>& v) {
   auto ret = JSON::list();
@@ -25,6 +35,16 @@ JSON to_json(const parray<CommonItemSet::Table::Range<IntT>, Count>& v) {
   return ret;
 }
 
+template <typename IntT, size_t Count>
+void from_json_into(const JSON& json, parray<CommonItemSet::Table::Range<IntT>, Count>& ret) {
+  if (json.size() != Count) {
+    throw runtime_error("incorrect array length");
+  }
+  for (size_t z = 0; z < Count; z++) {
+    from_json_into(json.at(z), ret[z]);
+  }
+}
+
 template <typename IntT>
 JSON to_json(const CommonItemSet::Table::Range<IntT>& v) {
   if (v.min == v.max) {
@@ -34,6 +54,22 @@ JSON to_json(const CommonItemSet::Table::Range<IntT>& v) {
   }
 }
 
+template <typename IntT>
+void from_json_into(const JSON& json, CommonItemSet::Table::Range<IntT>& ret) {
+  if (json.is_int()) {
+    IntT v = json.as_int();
+    ret.min = v;
+    ret.max = v;
+  } else {
+    const auto& l = json.as_list();
+    if (l.size() != 2) {
+      throw runtime_error("incorrect range list length");
+    }
+    ret.min = l.at(0)->as_int();
+    ret.max = l.at(1)->as_int();
+  }
+}
+
 template <typename IntT, size_t Count1, size_t Count2>
 JSON to_json(const parray<parray<IntT, Count2>, Count1>& v) {
   auto ret = JSON::list();
@@ -43,6 +79,262 @@ JSON to_json(const parray<parray<IntT, Count2>, Count1>& v) {
   return ret;
 }
 
+template <typename IntT, size_t Count1, size_t Count2>
+void from_json_into(const JSON& json, parray<parray<IntT, Count2>, Count1>& ret) {
+  if (json.size() != Count1) {
+    throw runtime_error("incorrect array length");
+  }
+  for (size_t z = 0; z < Count1; z++) {
+    from_json_into(json.at(z), ret[z]);
+  }
+}
+
+template <typename IntT, size_t Count1, size_t Count2>
+void from_json_into(const JSON& json, parray<parray<CommonItemSet::Table::Range<IntT>, Count2>, Count1>& ret) {
+  if (json.size() != Count1) {
+    throw runtime_error("incorrect array length");
+  }
+  for (size_t z = 0; z < Count1; z++) {
+    from_json_into(json.at(z), ret[z]);
+  }
+}
+
+CommonItemSet::Table::Table(const JSON& json, Episode episode)
+    : episode(episode) {
+  from_json_into(json.at("BaseWeaponTypeProbTable"), this->base_weapon_type_prob_table);
+  from_json_into(json.at("SubtypeBaseTable"), this->subtype_base_table);
+  from_json_into(json.at("SubtypeAreaLengthTable"), this->subtype_area_length_table);
+  from_json_into(json.at("GrindProbTable"), this->grind_prob_table);
+  from_json_into(json.at("ArmorShieldTypeIndexProbTable"), this->armor_shield_type_index_prob_table);
+  from_json_into(json.at("ArmorSlotCountProbTable"), this->armor_slot_count_prob_table);
+  from_json_into(json.at("BoxMesetaRanges"), this->box_meseta_ranges);
+  this->has_rare_bonus_value_prob_table = json.at("HasRareBonusValueProbTable").as_bool();
+  from_json_into(json.at("BonusValueProbTable"), this->bonus_value_prob_table);
+  from_json_into(json.at("NonRareBonusProbSpec"), this->nonrare_bonus_prob_spec);
+  from_json_into(json.at("BonusTypeProbTable"), this->bonus_type_prob_table);
+  from_json_into(json.at("SpecialMult"), this->special_mult);
+  from_json_into(json.at("SpecialPercent"), this->special_percent);
+  from_json_into(json.at("ToolClassProbTable"), this->tool_class_prob_table);
+  from_json_into(json.at("TechniqueIndexProbTable"), this->technique_index_prob_table);
+  from_json_into(json.at("TechniqueLevelRanges"), this->technique_level_ranges);
+  this->armor_or_shield_type_bias = json.at("ArmorOrShieldTypeBias").as_int();
+  from_json_into(json.at("UnitMaxStarsTable"), this->unit_max_stars_table);
+  from_json_into(json.at("BoxItemClassProbTable"), this->box_item_class_prob_table);
+
+  const auto& enemy_meseta_ranges_json = json.at("EnemyMesetaRanges").as_dict();
+  const auto& enemy_type_drop_probs_json = json.at("EnemyTypeDropProbs").as_dict();
+  const auto& enemy_item_classes_json = json.at("EnemyItemClasses").as_dict();
+  for (size_t z = 0; z < 0x64; z++) {
+    static const array<Episode, 3> episodes = {Episode::EP1, Episode::EP2, Episode::EP4};
+    for (Episode episode : episodes) {
+      for (auto type : enemy_types_for_rare_table_index(episode, z)) {
+        string name = string_printf("%s:%s", abbreviation_for_episode(episode), name_for_enum(type));
+        from_json_into(*enemy_meseta_ranges_json.at(name), this->enemy_meseta_ranges[z]);
+        this->enemy_type_drop_probs[z] = enemy_type_drop_probs_json.at(name)->as_int();
+        this->enemy_item_classes[z] = enemy_item_classes_json.at(name)->as_int();
+      }
+    }
+  }
+}
+
+static const char* name_for_common_item_class(uint8_t item_class) {
+  switch (item_class) {
+    case 0x00:
+      return "WEAPON ";
+    case 0x01:
+      return "ARMOR  ";
+    case 0x02:
+      return "SHIELD ";
+    case 0x03:
+      return "UNIT   ";
+    case 0x04:
+      return "TOOL   ";
+    case 0x05:
+      return "MESETA ";
+    case 0x06:
+      return "NOTHING";
+    default:
+      return "UNKNOWN";
+  }
+}
+
+void CommonItemSet::Table::print(FILE* stream) const {
+  const auto& meseta_ranges = this->enemy_meseta_ranges;
+  const auto& drop_probs = this->enemy_type_drop_probs;
+  const auto& item_classes = this->enemy_item_classes;
+  fprintf(stream, "Enemy tables:\n");
+  fprintf(stream, "  ##   $LOW  $HIGH  DAR%%  ITEM        ENEMIES\n");
+  for (size_t z = 0; z < 0x64; z++) {
+    string enemies_str;
+    for (EnemyType enemy_type : enemy_types_for_rare_table_index(this->episode, z)) {
+      if (!enemies_str.empty()) {
+        enemies_str += ", ";
+      }
+      enemies_str += name_for_enum(enemy_type);
+    }
+    if (drop_probs[z]) {
+      fprintf(stream, "  %02zX  %5hu  %5hu  %3hhu%%  %02hX:%s  %s\n",
+          z, meseta_ranges[z].min, meseta_ranges[z].max, drop_probs[z], item_classes[z],
+          name_for_common_item_class(item_classes[z]), enemies_str.c_str());
+    } else {
+      fprintf(stream, "  %02zX  -----  -----    0%%  --          %s\n", z, enemies_str.c_str());
+    }
+  }
+
+  static const array<const char*, 12> base_weapon_type_names = {
+      "SABER   ",
+      "SWORD   ",
+      "DAGGER  ",
+      "PARTISAN",
+      "SLICER  ",
+      "HANDGUN ",
+      "RIFLE   ",
+      "MECHGUN ",
+      "SHOT    ",
+      "CANE    ",
+      "ROD     ",
+      "WAND    ",
+  };
+  fprintf(stream, "Base weapon config:\n");
+  fprintf(stream, "  TYPE         PROB  [SB  AL]  FLOORS\n");
+  for (size_t z = 0; z < 12; z++) {
+    uint8_t floor_to_class[10];
+    if (this->subtype_base_table[z] < 0) {
+      size_t start_floor = std::min<size_t>(-this->subtype_area_length_table[z], 10);
+      for (size_t x = 0; x < start_floor; x++) {
+        floor_to_class[x] = 0xFF;
+      }
+      for (size_t x = start_floor; x < 10; x++) {
+        floor_to_class[x] = (x - start_floor) / this->subtype_area_length_table[z];
+      }
+    } else {
+      for (size_t x = 0; x < 10; x++) {
+        floor_to_class[x] = this->subtype_base_table[z] + (x / this->subtype_area_length_table[z]);
+      }
+    }
+    fprintf(stream, "  %02zX:%s  %3hhu%%  [%02hhX  %02hhX]  %02hhX %02hhX %02hhX %02hhX %02hhX %02hhX %02hhX %02hhX %02hhX %02hhX\n",
+        z, base_weapon_type_names[z], this->base_weapon_type_prob_table[z],
+        this->subtype_base_table[z], this->subtype_area_length_table[z],
+        floor_to_class[0], floor_to_class[1], floor_to_class[2], floor_to_class[3], floor_to_class[4],
+        floor_to_class[5], floor_to_class[6], floor_to_class[7], floor_to_class[8], floor_to_class[9]);
+  }
+
+  fprintf(stream, "Box configuration:\n");
+  fprintf(stream, "  AR   $LOW  $HIGH  WEP%%  ARM%%  SHD%%  UNI%%   TL%%  MST%%   NO%%\n");
+  for (size_t z = 0; z < 10; z++) {
+    fprintf(stream, "  %02zX  %5hu  %5hu  %3hhu%%  %3hhu%%  %3hhu%%  %3hhu%%  %3hhu%%  %3hhu%%  %3hhu%%\n",
+        z, this->box_meseta_ranges[z].min, this->box_meseta_ranges[z].max,
+        this->box_item_class_prob_table[0][z],
+        this->box_item_class_prob_table[1][z],
+        this->box_item_class_prob_table[2][z],
+        this->box_item_class_prob_table[3][z],
+        this->box_item_class_prob_table[4][z],
+        this->box_item_class_prob_table[5][z],
+        this->box_item_class_prob_table[6][z]);
+  }
+
+  fprintf(stream, "Weapon drops:\n");
+  fprintf(stream, "  Grinds:\n");
+  fprintf(stream, "    GD  AR0%%  AR1%%  AR2%%  AR3%%\n");
+  for (size_t z = 0; z < 9; z++) {
+    fprintf(stream, "    +%zu  %3hhd%%  %3hhd%%  %3hhd%%  %3hhd%%\n", z,
+        this->grind_prob_table[z][0], this->grind_prob_table[z][1],
+        this->grind_prob_table[z][2], this->grind_prob_table[z][3]);
+  }
+  fprintf(stream, "  Bonus value table:\n");
+  fprintf(stream, "    ID");
+  for (int8_t v = -10; v <= 100; v += 5) {
+    fprintf(stream, "  %5hhd%%", v);
+  }
+  fputc('\n', stream);
+  for (size_t z = 0; z < (this->has_rare_bonus_value_prob_table ? 6 : 5); z++) {
+    fprintf(stream, "    %02zX", z);
+    for (size_t x = 0; x < 0x17; x++) {
+      fprintf(stream, "  %5hu#", this->bonus_value_prob_table[x][z]);
+    }
+    fputc('\n', stream);
+  }
+  fprintf(stream, "  Area config tables:\n");
+  fprintf(stream, "    AR  BONUS  SP   NO%%  NTV%%   AB%%  MAC%%  DRK%%  HIT%%  SM  SPC%%\n");
+  for (size_t z = 0; z < 10; z++) {
+    fprintf(stream, "    %02zX  %02hhX %02hhX  %02hhX  %3hhu%%  %3hhu%%  %3hhu%%  %3hhu%%  %3hhu%%  %3hhu%%  %02hhX  %3hhu%%\n",
+        z, this->nonrare_bonus_prob_spec[0][z], this->nonrare_bonus_prob_spec[1][z], this->nonrare_bonus_prob_spec[2][z],
+        this->bonus_type_prob_table[0][z], this->bonus_type_prob_table[1][z], this->bonus_type_prob_table[2][z],
+        this->bonus_type_prob_table[3][z], this->bonus_type_prob_table[4][z], this->bonus_type_prob_table[5][z],
+        this->special_mult[z], this->special_percent[z]);
+  }
+
+  fprintf(stream, "  Tool class table:\n");
+  fprintf(stream, "    CS     A1     A2     A3     A4     A5     A6     A7     A8     A9    A10\n");
+  for (size_t tool_class = 0; tool_class < this->tool_class_prob_table.size(); tool_class++) {
+    fprintf(stream, "    %02zX", tool_class);
+    for (size_t area_norm = 0; area_norm < 10; area_norm++) {
+      fprintf(stream, "  %5hu", this->tool_class_prob_table[tool_class][area_norm]);
+    }
+    fputc('\n', stream);
+  }
+
+  static const array<const char*, 19> technique_names = {
+      "FOIE    ",
+      "GIFOIE  ",
+      "RAFOIE  ",
+      "BARTA   ",
+      "GIBARTA ",
+      "RABARTA ",
+      "ZONDE   ",
+      "GIZONDE ",
+      "RAZONDE ",
+      "GRANTS  ",
+      "DEBAND  ",
+      "JELLEN  ",
+      "ZALURE  ",
+      "SHIFTA  ",
+      "RYUKER  ",
+      "RESTA   ",
+      "ANTI    ",
+      "REVERSER",
+      "MEGID   ",
+  };
+
+  fprintf(stream, "  Technique table:\n");
+  fprintf(stream, "    TECH                   A1            A2            A3            A4            A5            A6            A7            A8            A9           A10\n");
+  for (size_t tech_num = 0; tech_num < this->technique_index_prob_table.size(); tech_num++) {
+    fprintf(stream, "    %02zX:%s", tech_num, technique_names[tech_num]);
+    for (size_t area_norm = 0; area_norm < 10; area_norm++) {
+      uint16_t prob = this->technique_index_prob_table[tech_num][area_norm];
+      if (prob) {
+        const auto& level_range = this->technique_level_ranges[tech_num][area_norm];
+        size_t min_level = level_range.min + 1;
+        size_t max_level = level_range.max + 1;
+        fprintf(stream, "  %5hu[%2zu-%2zu]", prob, min_level, max_level);
+      } else {
+        fprintf(stream, "      0[-----]");
+      }
+    }
+    fputc('\n', stream);
+  }
+
+  fprintf(stream, "  Armor/shield type bias: %hhu\n", this->armor_or_shield_type_bias);
+
+  fprintf(stream, "  Armor/shield type index table:\n");
+  fprintf(stream, "    TY  PROB\n");
+  for (size_t z = 0; z < 5; z++) {
+    fprintf(stream, "    %02zX  %3hhu%%\n", z, this->armor_shield_type_index_prob_table[z]);
+  }
+
+  fprintf(stream, "  Armor/shield slot count table:\n");
+  fprintf(stream, "    #S  PROB\n");
+  for (size_t z = 0; z < 5; z++) {
+    fprintf(stream, "    %02zX  %3hhu%%\n", z, this->armor_slot_count_prob_table[z]);
+  }
+
+  fprintf(stream, "  Unit maximum stars table:\n");
+  fprintf(stream, "    AR   #*\n");
+  for (size_t z = 0; z < 10; z++) {
+    fprintf(stream, "    %02zX  %3hhu\n", z, this->unit_max_stars_table[z]);
+  }
+}
+
 JSON CommonItemSet::Table::json() const {
   JSON enemy_meseta_ranges_json = JSON::dict();
   JSON enemy_type_drop_probs_json = JSON::dict();
@@ -111,7 +403,28 @@ JSON CommonItemSet::json() const {
   return modes_dict;
 }
 
-CommonItemSet::Table::Table(const StringReader& r, bool is_big_endian, bool is_v3) {
+void CommonItemSet::print(FILE* stream) const {
+  static const array<GameMode, 4> modes = {GameMode::NORMAL, GameMode::BATTLE, GameMode::CHALLENGE, GameMode::SOLO};
+  for (const auto& mode : modes) {
+    static const array<Episode, 3> episodes = {Episode::EP1, Episode::EP2, Episode::EP4};
+    for (const auto& episode : episodes) {
+      for (uint8_t difficulty = 0; difficulty < 4; difficulty++) {
+        for (uint8_t section_id = 0; section_id < 10; section_id++) {
+          try {
+            auto table = this->get_table(episode, mode, difficulty, section_id);
+            fprintf(stream, "============ %s %s %s %s\n",
+                name_for_mode(mode), name_for_episode(episode), name_for_difficulty(difficulty), name_for_section_id(section_id));
+            table->print(stream);
+          } catch (const runtime_error&) {
+          }
+        }
+      }
+    }
+  }
+}
+
+CommonItemSet::Table::Table(const StringReader& r, bool is_big_endian, bool is_v3, Episode episode)
+    : episode(episode) {
   if (is_big_endian) {
     this->parse_itempt_t<true>(r, is_v3);
   } else {
@@ -179,41 +492,6 @@ void CommonItemSet::Table::parse_itempt_t(const StringReader& r, bool is_v3) {
   this->box_item_class_prob_table = r.pget<parray<parray<uint8_t, 10>, 7>>(offsets.box_item_class_prob_table_offset);
 }
 
-void CommonItemSet::Table::print_enemy_table(FILE* stream) const {
-  const auto& meseta_ranges = this->enemy_meseta_ranges;
-  const auto& drop_probs = this->enemy_type_drop_probs;
-  const auto& item_classes = this->enemy_item_classes;
-  // const parray<Range<uint16_t>, 0x64>& enemy_meseta_ranges() const;
-  //   const parray<uint8_t, 0x64>& enemy_type_drop_probs() const;
-  //   const parray<uint8_t, 0x64>& enemy_item_classes() const;
-  fprintf(stream, "##  $_LOW  $_HIGH  DAR  ITEM\n");
-  for (size_t z = 0; z < 0x64; z++) {
-    const char* item_class_name = "__UNKNOWN__";
-    switch (item_classes[z]) {
-      case 0x00:
-        item_class_name = "WEAPON";
-        break;
-      case 0x01:
-        item_class_name = "ARMOR";
-        break;
-      case 0x02:
-        item_class_name = "SHIELD";
-        break;
-      case 0x03:
-        item_class_name = "UNIT";
-        break;
-      case 0x04:
-        item_class_name = "TOOL";
-        break;
-      case 0x05:
-        item_class_name = "MESETA";
-        break;
-    }
-    fprintf(stream, "%02zX  %5hu   %5hu  %3hhu  %02hX (%s)\n",
-        z, meseta_ranges[z].min, meseta_ranges[z].max, drop_probs[z], item_classes[z], item_class_name);
-  }
-}
-
 uint16_t CommonItemSet::key_for_table(Episode episode, GameMode mode, uint8_t difficulty, uint8_t secid) {
   // Bits: -----EEEMMDDSSSS
   return (((static_cast<uint16_t>(episode) << 8) & 0x0700) |
@@ -241,7 +519,7 @@ AFSV2CommonItemSet::AFSV2CommonItemSet(
     for (size_t section_id = 0; section_id < 10; section_id++) {
       auto entry = pt_afs.get(difficulty * 10 + section_id);
       StringReader r(entry.first, entry.second);
-      auto table = make_shared<Table>(r, false, false);
+      auto table = make_shared<Table>(r, false, false, Episode::EP1);
       this->tables.emplace(this->key_for_table(Episode::EP1, GameMode::NORMAL, difficulty, section_id), table);
       this->tables.emplace(this->key_for_table(Episode::EP1, GameMode::BATTLE, difficulty, section_id), table);
       this->tables.emplace(this->key_for_table(Episode::EP1, GameMode::SOLO, difficulty, section_id), table);
@@ -253,7 +531,7 @@ AFSV2CommonItemSet::AFSV2CommonItemSet(
   AFSArchive ct_afs(ct_afs_data);
   for (size_t difficulty = 0; difficulty < 4; difficulty++) {
     auto r = ct_afs.get_reader(difficulty * 10);
-    auto table = make_shared<Table>(r, false, false);
+    auto table = make_shared<Table>(r, false, false, Episode::EP1);
     for (size_t section_id = 0; section_id < 10; section_id++) {
       this->tables.emplace(this->key_for_table(Episode::EP1, GameMode::CHALLENGE, difficulty, section_id), table);
     }
@@ -305,7 +583,7 @@ GSLV3V4CommonItemSet::GSLV3V4CommonItemSet(std::shared_ptr<const std::string> gs
             throw;
           }
         }
-        auto table = make_shared<Table>(r, is_big_endian, true);
+        auto table = make_shared<Table>(r, is_big_endian, true, episode);
         this->tables.emplace(this->key_for_table(episode, GameMode::NORMAL, difficulty, section_id), table);
         this->tables.emplace(this->key_for_table(episode, GameMode::BATTLE, difficulty, section_id), table);
         this->tables.emplace(this->key_for_table(episode, GameMode::SOLO, difficulty, section_id), table);
@@ -315,7 +593,7 @@ GSLV3V4CommonItemSet::GSLV3V4CommonItemSet(std::shared_ptr<const std::string> gs
     if (episode != Episode::EP4) {
       for (size_t difficulty = 0; difficulty < 4; difficulty++) {
         auto r = gsl.get_reader(filename_for_table(episode, difficulty, 0, true));
-        auto table = make_shared<Table>(r, is_big_endian, true);
+        auto table = make_shared<Table>(r, is_big_endian, true, episode);
         for (size_t section_id = 0; section_id < 10; section_id++) {
           this->tables.emplace(this->key_for_table(episode, GameMode::CHALLENGE, difficulty, section_id), table);
         }
@@ -324,6 +602,33 @@ GSLV3V4CommonItemSet::GSLV3V4CommonItemSet(std::shared_ptr<const std::string> gs
   }
 }
 
+JSONCommonItemSet::JSONCommonItemSet(const JSON& json) {
+  for (const auto& mode_it : json.as_dict()) {
+    static const unordered_map<string, GameMode> mode_keys(
+        {{"Normal", GameMode::NORMAL}, {"Battle", GameMode::BATTLE}, {"Challenge", GameMode::CHALLENGE}, {"Solo", GameMode::SOLO}});
+    GameMode mode = mode_keys.at(mode_it.first);
+
+    for (const auto& episode_it : mode_it.second->as_dict()) {
+      static const unordered_map<string, Episode> episode_keys(
+          {{"Episode1", Episode::EP1}, {"Episode2", Episode::EP2}, {"Episode4", Episode::EP4}});
+      Episode episode = episode_keys.at(episode_it.first);
+
+      for (const auto& difficulty_it : episode_it.second->as_dict()) {
+        static const unordered_map<string, uint8_t> difficulty_keys(
+            {{"Normal", 0}, {"Hard", 1}, {"VeryHard", 2}, {"Ultimate", 3}});
+        uint8_t difficulty = difficulty_keys.at(difficulty_it.first);
+
+        for (const auto& section_id_it : difficulty_it.second->as_dict()) {
+          uint8_t section_id = section_id_for_name(section_id_it.first);
+          this->tables.emplace(
+              this->key_for_table(episode, mode, difficulty, section_id),
+              make_shared<Table>(*section_id_it.second, episode));
+        }
+      }
+    }
+  }
+}
+
 RELFileSet::RELFileSet(std::shared_ptr<const std::string> data)
     : data(data),
       r(*this->data) {}

src/CommonItemSet.hh

@@ -14,7 +14,8 @@ public:
   class Table {
   public:
     Table() = delete;
-    Table(const StringReader& r, bool big_endian, bool is_v3);
+    Table(const JSON& json, Episode episode);
+    Table(const StringReader& r, bool big_endian, bool is_v3, Episode episode);
 
     template <typename IntT>
     struct Range {
@@ -22,6 +23,7 @@ public:
       IntT max;
     } __packed__;
 
+    Episode episode;
     parray<uint8_t, 0x0C> base_weapon_type_prob_table;
     parray<int8_t, 0x0C> subtype_base_table;
     parray<uint8_t, 0x0C> subtype_area_length_table;
@@ -45,8 +47,8 @@ public:
     parray<uint8_t, 0x0A> unit_max_stars_table;
     parray<parray<uint8_t, 10>, 7> box_item_class_prob_table;
 
-    void print_enemy_table(FILE* stream) const;
     JSON json() const;
+    void print(FILE* stream) const;
 
   private:
     template <bool IsBigEndian>
@@ -263,6 +265,7 @@ public:
 
   std::shared_ptr<const Table> get_table(Episode episode, GameMode mode, uint8_t difficulty, uint8_t secid) const;
   JSON json() const;
+  void print(FILE* stream) const;
 
 protected:
   CommonItemSet() = default;
@@ -282,6 +285,11 @@ public:
   GSLV3V4CommonItemSet(std::shared_ptr<const std::string> gsl_data, bool is_big_endian);
 };
 
+class JSONCommonItemSet : public CommonItemSet {
+public:
+  explicit JSONCommonItemSet(const JSON& json);
+};
+
 // Note: There are clearly better ways of doing this, but this implementation
 // closely follows what the original code in the client does.
 template <typename ItemT, size_t MaxCount>

src/Compression.hh

@@ -1,226 +1,226 @@
-#pragma once
-
-#include <stddef.h>
-
-#include <array>
-#include <deque>
-#include <functional>
-#include <phosg/Tools.hh>
-#include <string>
-
-#include "Text.hh"
-
-enum class CompressPhase {
-  INDEX = 0,
-  CONSTRUCT_PATHS,
-  BACKTRACE_OPTIMAL_PATH,
-  GENERATE_RESULT,
-};
-
-template <>
-const char* name_for_enum<CompressPhase>(CompressPhase v);
-
-typedef std::function<void(CompressPhase phase, size_t input_progress, size_t input_size, size_t output_size)> ProgressCallback;
-
-////////////////////////////////////////////////////////////////////////////////
-// PRS compression
-////////////////////////////////////////////////////////////////////////////////
-
-// Use this class if you need to compress from multiple input buffers, or need
-// to compress multiple chunks and don't want to copy their contents
-// unnecessarily. (For most common use cases, use prs_compress, below, instead.)
-// To use this class, instantiate it, then call .add() one or more times, then
-// call .close() and use the returned string as the compressed result.
-class PRSCompressor {
-public:
-  // compression_level specifies how aggressively to search for alternate paths:
-  //   -1: Don't perform any compression at all, but produce output that can be
-  //       understood by prs_decompress. The output will be about 9/8 the size
-  //       of the input.
-  //   0:  Greedily search for the longest backreference at every point. Don't
-  //       consider any alternate paths. Generally offers a good balance between
-  //       speed and output size.
-  //   1:  Consider two paths at each point when a backreference is found: using
-  //       the backreference or ignoring it.
-  //   2+: Consider further chains of paths at each point. Using values 2 or
-  //       greater for compression_level generally yields diminishing returns.
-  explicit PRSCompressor(ssize_t compression_level = 0, ProgressCallback progress_fn = nullptr);
-  ~PRSCompressor() = default;
-
-  // Adds more input data to be compressed, which logically comes after all
-  // previous data provided via add() calls. Cannot be called after close() is
-  // called.
-  void add(const void* data, size_t size);
-  void add(const std::string& data);
-
-  // Ends compression and returns the complete compressed result. It's OK to
-  // std::move() from the returned string reference.
-  std::string& close();
-
-  // Returns the total number of bytes passed to add() calls so far.
-  inline size_t input_size() const {
-    return this->input_bytes;
-  }
-
-private:
-  template <size_t Size>
-  struct WrappedLog {
-    parray<uint8_t, Size> data;
-
-    WrappedLog() : data(0) {}
-    ~WrappedLog() = default;
-
-    inline uint8_t at(size_t offset) const {
-      return this->data[offset % this->data.size()];
-    }
-    inline uint8_t& at(size_t offset) {
-      return this->data[offset % this->data.size()];
-    }
-  };
-
-  template <size_t Size>
-  struct IndexedLog : WrappedLog<Size> {
-    size_t offset;
-    size_t size;
-    std::array<std::deque<size_t>, 0x100> index;
-
-    IndexedLog()
-        : WrappedLog<Size>(),
-          offset(0),
-          size(0) {}
-    ~IndexedLog() = default;
-
-    inline size_t end_offset() const {
-      return this->offset + this->size;
-    }
-
-    void push_back(uint8_t v) {
-      if (this->size == Size) {
-        this->pop_front();
-      }
-      size_t write_offset = this->offset + this->size;
-      this->at(write_offset) = v;
-      this->index[v].push_back(write_offset);
-      this->size++;
-    }
-    uint8_t pop_back() {
-      if (!this->size) {
-        throw std::logic_error("pop_back called on empty IndexedLog");
-      }
-      this->size--;
-      size_t offset = this->offset + this->size;
-      uint8_t v = this->at(offset);
-      this->index[v].pop_back();
-      return v;
-    }
-    uint8_t pop_front() {
-      uint8_t v = this->at(this->offset);
-      this->index[v].pop_front();
-      this->offset++;
-      this->size--;
-      return v;
-    }
-    const std::deque<size_t>& find(uint8_t v) {
-      return this->index[v];
-    }
-  };
-
-  void add_byte(uint8_t v);
-  void advance();
-  void move_forward_data_to_reverse_log(size_t size);
-  void advance_literal();
-  void advance_short_copy(ssize_t offset, size_t size);
-  void advance_long_copy(ssize_t offset, size_t size);
-  void advance_extended_copy(ssize_t offset, size_t size);
-  void write_control(bool z);
-  void flush_control();
-
-  ssize_t compression_level;
-  ProgressCallback progress_fn;
-  bool closed;
-
-  size_t control_byte_offset;
-  uint16_t pending_control_bits;
-
-  size_t input_bytes;
-  WrappedLog<0x101> forward_log;
-  IndexedLog<0x2000> reverse_log;
-
-  StringWriter output;
-};
-
-// These functions use PRSCompressor to compress a buffer of data. This is
-// essentially a shortcut for constructing a PRSCompressor, calling .add() on
-// it once, then calling .close().
-std::string prs_compress(
-    const void* vdata,
-    size_t size,
-    ssize_t compression_level = 0,
-    ProgressCallback progress_fn = nullptr);
-std::string prs_compress(
-    const std::string& data,
-    ssize_t compression_level = 0,
-    ProgressCallback progress_fn = nullptr);
-
-// A faster form of prs_compress that doesn't have a tunable compression level.
-std::string prs_compress_indexed(
-    const void* vdata,
-    size_t size,
-    ProgressCallback progress_fn = nullptr);
-std::string prs_compress_indexed(
-    const std::string& data,
-    ProgressCallback progress_fn = nullptr);
-
-// Compresses data using PRS to the smallest possible output size. This function
-// is slow, but produces results significantly smaller than even Sega's original
-// compressor.
-std::string prs_compress_optimal(const void* vdata, size_t size, ProgressCallback progress_fn = nullptr);
-std::string prs_compress_optimal(const std::string& data, ProgressCallback progress_fn = nullptr);
-
-// Compresses data using PRS to the LARGEST possible output size. There is no
-// practical use for this function except for amusement.
-std::string prs_compress_pessimal(const void* vdata, size_t size);
-
-// Decompresses PRS-compressed data.
-struct PRSDecompressResult {
-  std::string data;
-  size_t input_bytes_used;
-};
-PRSDecompressResult prs_decompress_with_meta(const void* data, size_t size, size_t max_output_size = 0, bool allow_unterminated = false);
-PRSDecompressResult prs_decompress_with_meta(const std::string& data, size_t max_output_size = 0, bool allow_unterminated = false);
-std::string prs_decompress(const void* data, size_t size, size_t max_output_size = 0, bool allow_unterminated = false);
-std::string prs_decompress(const std::string& data, size_t max_output_size = 0, bool allow_unterminated = false);
-
-// Returns the decompressed size of PRS-compressed data, without actually
-// decompressing it.
-size_t prs_decompress_size(const void* data, size_t size, size_t max_output_size = 0, bool allow_unterminated = false);
-size_t prs_decompress_size(const std::string& data, size_t max_output_size = 0, bool allow_unterminated = false);
-
-// Prints the command stream from a PRS-compressed buffer.
-void prs_disassemble(FILE* stream, const void* data, size_t size);
-void prs_disassemble(FILE* stream, const std::string& data);
-
-////////////////////////////////////////////////////////////////////////////////
-// BC0 compression
-////////////////////////////////////////////////////////////////////////////////
-
-// Compresses data using the BC0 algorithm. Like with PRS, the optimal variant
-// is slow, but produces the smallest possible output.
-std::string bc0_compress_optimal(
-    const void* in_data_v,
-    size_t in_size,
-    ProgressCallback progress_fn = nullptr);
-std::string bc0_compress(const std::string& data, ProgressCallback progress_fn = nullptr);
-std::string bc0_compress(const void* in_data_v, size_t in_size, ProgressCallback progress_fn = nullptr);
-
-// Encodes data in a BC0-compatible format without compression (similar to using
-// compression_level=-1 with prs_compress).
-std::string bc0_encode(const void* in_data_v, size_t in_size);
-
-// Decompresses BC0-compressed data.
-std::string bc0_decompress(const std::string& data);
-std::string bc0_decompress(const void* data, size_t size);
-
-// Prints the command stream from a BC0-compressed buffer.
-void bc0_disassemble(FILE* stream, const std::string& data);
-void bc0_disassemble(FILE* stream, const void* data, size_t size);
+#pragma once
+
+#include <stddef.h>
+
+#include <array>
+#include <deque>
+#include <functional>
+#include <phosg/Tools.hh>
+#include <string>
+
+#include "Text.hh"
+
+enum class CompressPhase {
+  INDEX = 0,
+  CONSTRUCT_PATHS,
+  BACKTRACE_OPTIMAL_PATH,
+  GENERATE_RESULT,
+};
+
+template <>
+const char* name_for_enum<CompressPhase>(CompressPhase v);
+
+typedef std::function<void(CompressPhase phase, size_t input_progress, size_t input_size, size_t output_size)> ProgressCallback;
+
+////////////////////////////////////////////////////////////////////////////////
+// PRS compression
+////////////////////////////////////////////////////////////////////////////////
+
+// Use this class if you need to compress from multiple input buffers, or need
+// to compress multiple chunks and don't want to copy their contents
+// unnecessarily. (For most common use cases, use prs_compress, below, instead.)
+// To use this class, instantiate it, then call .add() one or more times, then
+// call .close() and use the returned string as the compressed result.
+class PRSCompressor {
+public:
+  // compression_level specifies how aggressively to search for alternate paths:
+  //   -1: Don't perform any compression at all, but produce output that can be
+  //       understood by prs_decompress. The output will be about 9/8 the size
+  //       of the input.
+  //   0:  Greedily search for the longest backreference at every point. Don't
+  //       consider any alternate paths. Generally offers a good balance between
+  //       speed and output size.
+  //   1:  Consider two paths at each point when a backreference is found: using
+  //       the backreference or ignoring it.
+  //   2+: Consider further chains of paths at each point. Using values 2 or
+  //       greater for compression_level generally yields diminishing returns.
+  explicit PRSCompressor(ssize_t compression_level = 0, ProgressCallback progress_fn = nullptr);
+  ~PRSCompressor() = default;
+
+  // Adds more input data to be compressed, which logically comes after all
+  // previous data provided via add() calls. Cannot be called after close() is
+  // called.
+  void add(const void* data, size_t size);
+  void add(const std::string& data);
+
+  // Ends compression and returns the complete compressed result. It's OK to
+  // std::move() from the returned string reference.
+  std::string& close();
+
+  // Returns the total number of bytes passed to add() calls so far.
+  inline size_t input_size() const {
+    return this->input_bytes;
+  }
+
+private:
+  template <size_t Size>
+  struct WrappedLog {
+    parray<uint8_t, Size> data;
+
+    WrappedLog() : data(0) {}
+    ~WrappedLog() = default;
+
+    inline uint8_t at(size_t offset) const {
+      return this->data[offset % this->data.size()];
+    }
+    inline uint8_t& at(size_t offset) {
+      return this->data[offset % this->data.size()];
+    }
+  };
+
+  template <size_t Size>
+  struct IndexedLog : WrappedLog<Size> {
+    size_t offset;
+    size_t size;
+    std::array<std::deque<size_t>, 0x100> index;
+
+    IndexedLog()
+        : WrappedLog<Size>(),
+          offset(0),
+          size(0) {}
+    ~IndexedLog() = default;
+
+    inline size_t end_offset() const {
+      return this->offset + this->size;
+    }
+
+    void push_back(uint8_t v) {
+      if (this->size == Size) {
+        this->pop_front();
+      }
+      size_t write_offset = this->offset + this->size;
+      this->at(write_offset) = v;
+      this->index[v].push_back(write_offset);
+      this->size++;
+    }
+    uint8_t pop_back() {
+      if (!this->size) {
+        throw std::logic_error("pop_back called on empty IndexedLog");
+      }
+      this->size--;
+      size_t offset = this->offset + this->size;
+      uint8_t v = this->at(offset);
+      this->index[v].pop_back();
+      return v;
+    }
+    uint8_t pop_front() {
+      uint8_t v = this->at(this->offset);
+      this->index[v].pop_front();
+      this->offset++;
+      this->size--;
+      return v;
+    }
+    const std::deque<size_t>& find(uint8_t v) {
+      return this->index[v];
+    }
+  };
+
+  void add_byte(uint8_t v);
+  void advance();
+  void move_forward_data_to_reverse_log(size_t size);
+  void advance_literal();
+  void advance_short_copy(ssize_t offset, size_t size);
+  void advance_long_copy(ssize_t offset, size_t size);
+  void advance_extended_copy(ssize_t offset, size_t size);
+  void write_control(bool z);
+  void flush_control();
+
+  ssize_t compression_level;
+  ProgressCallback progress_fn;
+  bool closed;
+
+  size_t control_byte_offset;
+  uint16_t pending_control_bits;
+
+  size_t input_bytes;
+  WrappedLog<0x101> forward_log;
+  IndexedLog<0x2000> reverse_log;
+
+  StringWriter output;
+};
+
+// These functions use PRSCompressor to compress a buffer of data. This is
+// essentially a shortcut for constructing a PRSCompressor, calling .add() on
+// it once, then calling .close().
+std::string prs_compress(
+    const void* vdata,
+    size_t size,
+    ssize_t compression_level = 0,
+    ProgressCallback progress_fn = nullptr);
+std::string prs_compress(
+    const std::string& data,
+    ssize_t compression_level = 0,
+    ProgressCallback progress_fn = nullptr);
+
+// A faster form of prs_compress that doesn't have a tunable compression level.
+std::string prs_compress_indexed(
+    const void* vdata,
+    size_t size,
+    ProgressCallback progress_fn = nullptr);
+std::string prs_compress_indexed(
+    const std::string& data,
+    ProgressCallback progress_fn = nullptr);
+
+// Compresses data using PRS to the smallest possible output size. This function
+// is slow, but produces results significantly smaller than even Sega's original
+// compressor.
+std::string prs_compress_optimal(const void* vdata, size_t size, ProgressCallback progress_fn = nullptr);
+std::string prs_compress_optimal(const std::string& data, ProgressCallback progress_fn = nullptr);
+
+// Compresses data using PRS to the LARGEST possible output size. There is no
+// practical use for this function except for amusement.
+std::string prs_compress_pessimal(const void* vdata, size_t size);
+
+// Decompresses PRS-compressed data.
+struct PRSDecompressResult {
+  std::string data;
+  size_t input_bytes_used;
+};
+PRSDecompressResult prs_decompress_with_meta(const void* data, size_t size, size_t max_output_size = 0, bool allow_unterminated = false);
+PRSDecompressResult prs_decompress_with_meta(const std::string& data, size_t max_output_size = 0, bool allow_unterminated = false);
+std::string prs_decompress(const void* data, size_t size, size_t max_output_size = 0, bool allow_unterminated = false);
+std::string prs_decompress(const std::string& data, size_t max_output_size = 0, bool allow_unterminated = false);
+
+// Returns the decompressed size of PRS-compressed data, without actually
+// decompressing it.
+size_t prs_decompress_size(const void* data, size_t size, size_t max_output_size = 0, bool allow_unterminated = false);
+size_t prs_decompress_size(const std::string& data, size_t max_output_size = 0, bool allow_unterminated = false);
+
+// Prints the command stream from a PRS-compressed buffer.
+void prs_disassemble(FILE* stream, const void* data, size_t size);
+void prs_disassemble(FILE* stream, const std::string& data);
+
+////////////////////////////////////////////////////////////////////////////////
+// BC0 compression
+////////////////////////////////////////////////////////////////////////////////
+
+// Compresses data using the BC0 algorithm. Like with PRS, the optimal variant
+// is slow, but produces the smallest possible output.
+std::string bc0_compress_optimal(
+    const void* in_data_v,
+    size_t in_size,
+    ProgressCallback progress_fn = nullptr);
+std::string bc0_compress(const std::string& data, ProgressCallback progress_fn = nullptr);
+std::string bc0_compress(const void* in_data_v, size_t in_size, ProgressCallback progress_fn = nullptr);
+
+// Encodes data in a BC0-compatible format without compression (similar to using
+// compression_level=-1 with prs_compress).
+std::string bc0_encode(const void* in_data_v, size_t in_size);
+
+// Decompresses BC0-compressed data.
+std::string bc0_decompress(const std::string& data);
+std::string bc0_decompress(const void* data, size_t size);
+
+// Prints the command stream from a BC0-compressed buffer.
+void bc0_disassemble(FILE* stream, const std::string& data);
+void bc0_disassemble(FILE* stream, const void* data, size_t size);

src/DNSServer.cc

@@ -1,121 +1,121 @@
-#include "DNSServer.hh"
-
-#include <netinet/in.h>
-#include <poll.h>
-#include <stdio.h>
-#include <string.h>
-#include <unistd.h>
-
-#include <phosg/Encoding.hh>
-#include <phosg/Network.hh>
-#include <phosg/Strings.hh>
-#include <string>
-#include <vector>
-
-#include "Loggers.hh"
-#include "NetworkAddresses.hh"
-
-using namespace std;
-
-DNSServer::DNSServer(
-    shared_ptr<struct event_base> base,
-    uint32_t local_connect_address,
-    uint32_t external_connect_address,
-    shared_ptr<const IPV4RangeSet> banned_ipv4_ranges)
-    : base(base),
-      local_connect_address(local_connect_address),
-      external_connect_address(external_connect_address),
-      banned_ipv4_ranges(banned_ipv4_ranges) {}
-
-DNSServer::~DNSServer() {
-  for (const auto& it : this->fd_to_receive_event) {
-    close(it.first);
-  }
-}
-
-void DNSServer::listen(const std::string& socket_path) {
-  this->add_socket(::listen(socket_path, 0, 0));
-}
-
-void DNSServer::listen(const std::string& addr, int port) {
-  this->add_socket(::listen(addr, port, 0));
-}
-
-void DNSServer::listen(int port) {
-  this->add_socket(::listen("", port, 0));
-}
-
-void DNSServer::add_socket(int fd) {
-  unique_ptr<struct event, void (*)(struct event*)> e(
-      event_new(this->base.get(), fd, EV_READ | EV_PERSIST, &DNSServer::dispatch_on_receive_message, this),
-      event_free);
-  event_add(e.get(), nullptr);
-  this->fd_to_receive_event.emplace(fd, std::move(e));
-}
-
-void DNSServer::dispatch_on_receive_message(evutil_socket_t fd,
-    short events, void* ctx) {
-  reinterpret_cast<DNSServer*>(ctx)->on_receive_message(fd, events);
-}
-
-string DNSServer::response_for_query(const void* vdata, size_t size, uint32_t resolved_address) {
-  if (size < 0x0C) {
-    throw invalid_argument("query too small");
-  }
-
-  const char* data = reinterpret_cast<const char*>(vdata);
-  size_t name_len = strlen(&data[12]) + 1;
-
-  be_uint32_t be_resolved_address = resolved_address;
-
-  string response;
-  response.append(data, 2);
-  response.append("\x81\x80\x00\x01\x00\x01\x00\x00\x00\x00", 10);
-  response.append(&data[12], name_len);
-  response.append("\x00\x01\x00\x01\xC0\x0C\x00\x01\x00\x01\x00\x00\x00\x3C\x00\x04", 16);
-  response.append(reinterpret_cast<const char*>(&be_resolved_address), 4);
-  return response;
-}
-
-string DNSServer::response_for_query(
-    const string& query, uint32_t resolved_address) {
-  return DNSServer::response_for_query(query.data(), query.size(), resolved_address);
-}
-
-void DNSServer::on_receive_message(int fd, short) {
-  for (;;) {
-    struct sockaddr_storage remote;
-    socklen_t remote_size = sizeof(sockaddr_in);
-    memset(&remote, 0, remote_size);
-
-    string input(2048, 0);
-    ssize_t bytes = recvfrom(fd, const_cast<char*>(input.data()), input.size(),
-        0, reinterpret_cast<sockaddr*>(&remote), &remote_size);
-
-    if (bytes < 0) {
-      if (errno != EAGAIN) {
-        dns_server_log.error("input error %d", errno);
-        throw runtime_error("cannot read from udp socket");
-      }
-      break;
-
-    } else if (bytes == 0) {
-      break;
-
-    } else if (bytes < 0x0C) {
-      dns_server_log.warning("input query too small");
-      print_data(stderr, input.data(), bytes);
-
-    } else if (!this->banned_ipv4_ranges->check(remote)) {
-      input.resize(bytes);
-      const sockaddr_in* remote_sin = reinterpret_cast<const sockaddr_in*>(&remote);
-      uint32_t remote_address = ntohl(remote_sin->sin_addr.s_addr);
-      uint32_t connect_address = is_local_address(remote_address)
-          ? this->local_connect_address
-          : this->external_connect_address;
-      string response = this->response_for_query(input, connect_address);
-      sendto(fd, response.data(), response.size(), 0,
-          reinterpret_cast<const sockaddr*>(&remote), remote_size);
-    }
-  }
-}
+#include "DNSServer.hh"
+
+#include <netinet/in.h>
+#include <poll.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+
+#include <phosg/Encoding.hh>
+#include <phosg/Network.hh>
+#include <phosg/Strings.hh>
+#include <string>
+#include <vector>
+
+#include "Loggers.hh"
+#include "NetworkAddresses.hh"
+
+using namespace std;
+
+DNSServer::DNSServer(
+    shared_ptr<struct event_base> base,
+    uint32_t local_connect_address,
+    uint32_t external_connect_address,
+    shared_ptr<const IPV4RangeSet> banned_ipv4_ranges)
+    : base(base),
+      local_connect_address(local_connect_address),
+      external_connect_address(external_connect_address),
+      banned_ipv4_ranges(banned_ipv4_ranges) {}
+
+DNSServer::~DNSServer() {
+  for (const auto& it : this->fd_to_receive_event) {
+    close(it.first);
+  }
+}
+
+void DNSServer::listen(const std::string& socket_path) {
+  this->add_socket(::listen(socket_path, 0, 0));
+}
+
+void DNSServer::listen(const std::string& addr, int port) {
+  this->add_socket(::listen(addr, port, 0));
+}
+
+void DNSServer::listen(int port) {
+  this->add_socket(::listen("", port, 0));
+}
+
+void DNSServer::add_socket(int fd) {
+  unique_ptr<struct event, void (*)(struct event*)> e(
+      event_new(this->base.get(), fd, EV_READ | EV_PERSIST, &DNSServer::dispatch_on_receive_message, this),
+      event_free);
+  event_add(e.get(), nullptr);
+  this->fd_to_receive_event.emplace(fd, std::move(e));
+}
+
+void DNSServer::dispatch_on_receive_message(evutil_socket_t fd,
+    short events, void* ctx) {
+  reinterpret_cast<DNSServer*>(ctx)->on_receive_message(fd, events);
+}
+
+string DNSServer::response_for_query(const void* vdata, size_t size, uint32_t resolved_address) {
+  if (size < 0x0C) {
+    throw invalid_argument("query too small");
+  }
+
+  const char* data = reinterpret_cast<const char*>(vdata);
+  size_t name_len = strlen(&data[12]) + 1;
+
+  be_uint32_t be_resolved_address = resolved_address;
+
+  string response;
+  response.append(data, 2);
+  response.append("\x81\x80\x00\x01\x00\x01\x00\x00\x00\x00", 10);
+  response.append(&data[12], name_len);
+  response.append("\x00\x01\x00\x01\xC0\x0C\x00\x01\x00\x01\x00\x00\x00\x3C\x00\x04", 16);
+  response.append(reinterpret_cast<const char*>(&be_resolved_address), 4);
+  return response;
+}
+
+string DNSServer::response_for_query(
+    const string& query, uint32_t resolved_address) {
+  return DNSServer::response_for_query(query.data(), query.size(), resolved_address);
+}
+
+void DNSServer::on_receive_message(int fd, short) {
+  for (;;) {
+    struct sockaddr_storage remote;
+    socklen_t remote_size = sizeof(sockaddr_in);
+    memset(&remote, 0, remote_size);
+
+    string input(2048, 0);
+    ssize_t bytes = recvfrom(fd, const_cast<char*>(input.data()), input.size(),
+        0, reinterpret_cast<sockaddr*>(&remote), &remote_size);
+
+    if (bytes < 0) {
+      if (errno != EAGAIN) {
+        dns_server_log.error("input error %d", errno);
+        throw runtime_error("cannot read from udp socket");
+      }
+      break;
+
+    } else if (bytes == 0) {
+      break;
+
+    } else if (bytes < 0x0C) {
+      dns_server_log.warning("input query too small");
+      print_data(stderr, input.data(), bytes);
+
+    } else if (!this->banned_ipv4_ranges->check(remote)) {
+      input.resize(bytes);
+      const sockaddr_in* remote_sin = reinterpret_cast<const sockaddr_in*>(&remote);
+      uint32_t remote_address = ntohl(remote_sin->sin_addr.s_addr);
+      uint32_t connect_address = is_local_address(remote_address)
+          ? this->local_connect_address
+          : this->external_connect_address;
+      string response = this->response_for_query(input, connect_address);
+      sendto(fd, response.data(), response.size(), 0,
+          reinterpret_cast<const sockaddr*>(&remote), remote_size);
+    }
+  }
+}

src/DNSServer.hh

@@ -1,44 +1,44 @@
-#pragma once
-
-#include <event2/event.h>
-
-#include <memory>
-#include <set>
-#include <string>
-#include <unordered_map>
-
-#include "IPV4RangeSet.hh"
-
-class DNSServer {
-public:
-  DNSServer(
-      std::shared_ptr<struct event_base> base,
-      uint32_t local_connect_address,
-      uint32_t external_connect_address,
-      std::shared_ptr<const IPV4RangeSet> banned_ipv4_ranges);
-  DNSServer(const DNSServer&) = delete;
-  DNSServer(DNSServer&&) = delete;
-  virtual ~DNSServer();
-
-  inline void set_banned_ipv4_ranges(std::shared_ptr<const IPV4RangeSet> banned_ipv4_ranges) {
-    this->banned_ipv4_ranges = banned_ipv4_ranges;
-  }
-
-  void listen(const std::string& socket_path);
-  void listen(const std::string& addr, int port);
-  void listen(int port);
-  void add_socket(int fd);
-
-  static std::string response_for_query(const void* vdata, size_t size, uint32_t resolved_address);
-  static std::string response_for_query(const std::string& query, uint32_t resolved_address);
-
-private:
-  std::shared_ptr<struct event_base> base;
-  std::unordered_map<int, std::unique_ptr<struct event, void (*)(struct event*)>> fd_to_receive_event;
-  uint32_t local_connect_address;
-  uint32_t external_connect_address;
-  std::shared_ptr<const IPV4RangeSet> banned_ipv4_ranges;
-
-  static void dispatch_on_receive_message(evutil_socket_t fd, short events, void* ctx);
-  void on_receive_message(int fd, short event);
-};
+#pragma once
+
+#include <event2/event.h>
+
+#include <memory>
+#include <set>
+#include <string>
+#include <unordered_map>
+
+#include "IPV4RangeSet.hh"
+
+class DNSServer {
+public:
+  DNSServer(
+      std::shared_ptr<struct event_base> base,
+      uint32_t local_connect_address,
+      uint32_t external_connect_address,
+      std::shared_ptr<const IPV4RangeSet> banned_ipv4_ranges);
+  DNSServer(const DNSServer&) = delete;
+  DNSServer(DNSServer&&) = delete;
+  virtual ~DNSServer();
+
+  inline void set_banned_ipv4_ranges(std::shared_ptr<const IPV4RangeSet> banned_ipv4_ranges) {
+    this->banned_ipv4_ranges = banned_ipv4_ranges;
+  }
+
+  void listen(const std::string& socket_path);
+  void listen(const std::string& addr, int port);
+  void listen(int port);
+  void add_socket(int fd);
+
+  static std::string response_for_query(const void* vdata, size_t size, uint32_t resolved_address);
+  static std::string response_for_query(const std::string& query, uint32_t resolved_address);
+
+private:
+  std::shared_ptr<struct event_base> base;
+  std::unordered_map<int, std::unique_ptr<struct event, void (*)(struct event*)>> fd_to_receive_event;
+  uint32_t local_connect_address;
+  uint32_t external_connect_address;
+  std::shared_ptr<const IPV4RangeSet> banned_ipv4_ranges;
+
+  static void dispatch_on_receive_message(evutil_socket_t fd, short events, void* ctx);
+  void on_receive_message(int fd, short event);
+};

src/EnemyType.hh

@@ -1,149 +1,149 @@
-#pragma once
-
-#include <inttypes.h>
-
-#include <phosg/Tools.hh>
-
-#include "StaticGameData.hh"
-
-enum class EnemyType {
-  UNKNOWN = -1,
-  NONE = 0,
-  NON_ENEMY_NPC,
-  AL_RAPPY,
-  ASTARK,
-  BA_BOOTA,
-  BARBA_RAY,
-  BARBAROUS_WOLF,
-  BEE_L,
-  BEE_R,
-  BOOMA,
-  BOOTA,
-  BULCLAW,
-  BULK,
-  CANADINE,
-  CANADINE_GROUP,
-  CANANE,
-  CHAOS_BRINGER,
-  CHAOS_SORCERER,
-  CLAW,
-  DARK_BELRA,
-  DARK_FALZ_1,
-  DARK_FALZ_2,
-  DARK_FALZ_3,
-  DARK_GUNNER,
-  DARVANT,
-  DARVANT_ULTIMATE,
-  DE_ROL_LE,
-  DE_ROL_LE_BODY,
-  DE_ROL_LE_MINE,
-  DEATH_GUNNER,
-  DEL_LILY,
-  DEL_RAPPY,
-  DEL_RAPPY_ALT,
-  DELBITER,
-  DELDEPTH,
-  DELSABER,
-  DIMENIAN,
-  DOLMDARL,
-  DOLMOLM,
-  DORPHON,
-  DORPHON_ECLAIR,
-  DRAGON,
-  DUBCHIC,
-  DUBWITCH, // Has no entry in battle params
-  EGG_RAPPY,
-  EPSIGUARD,
-  EPSILON,
-  EVIL_SHARK,
-  GAEL,
-  GAL_GRYPHON,
-  GARANZ,
-  GEE,
-  GI_GUE,
-  GIBBLES,
-  GIGOBOOMA,
-  GILLCHIC,
-  GIRTABLULU,
-  GOBOOMA,
-  GOL_DRAGON,
-  GORAN,
-  GORAN_DETONATOR,
-  GRASS_ASSASSIN,
-  GUIL_SHARK,
-  HALLO_RAPPY,
-  HIDOOM,
-  HILDEBEAR,
-  HILDEBLUE,
-  ILL_GILL,
-  KONDRIEU,
-  LA_DIMENIAN,
-  LOVE_RAPPY,
-  MERICAROL,
-  MERICUS,
-  MERIKLE,
-  MERILLIA,
-  MERILTAS,
-  MERISSA_A,
-  MERISSA_AA,
-  MIGIUM,
-  MONEST,
-  MORFOS,
-  MOTHMANT,
-  NANO_DRAGON,
-  NAR_LILY,
-  OLGA_FLOW_1,
-  OLGA_FLOW_2,
-  PAL_SHARK,
-  PAN_ARMS,
-  PAZUZU,
-  PAZUZU_ALT,
-  PIG_RAY,
-  POFUILLY_SLIME,
-  POUILLY_SLIME,
-  POISON_LILY,
-  PYRO_GORAN,
-  RAG_RAPPY,
-  RECOBOX,
-  RECON,
-  SAINT_MILLION,
-  SAINT_RAPPY,
-  SAND_RAPPY,
-  SAND_RAPPY_ALT,
-  SATELLITE_LIZARD,
-  SATELLITE_LIZARD_ALT,
-  SAVAGE_WOLF,
-  SHAMBERTIN,
-  SINOW_BEAT,
-  SINOW_BERILL,
-  SINOW_GOLD,
-  SINOW_SPIGELL,
-  SINOW_ZELE,
-  SINOW_ZOA,
-  SO_DIMENIAN,
-  UL_GIBBON,
-  VOL_OPT_1,
-  VOL_OPT_2,
-  VOL_OPT_AMP,
-  VOL_OPT_CORE,
-  VOL_OPT_MONITOR,
-  VOL_OPT_PILLAR,
-  YOWIE,
-  YOWIE_ALT,
-  ZE_BOOTA,
-  ZOL_GIBBON,
-  ZU,
-  ZU_ALT,
-  MAX_ENEMY_TYPE,
-};
-
-template <>
-const char* name_for_enum<EnemyType>(EnemyType type);
-template <>
-EnemyType enum_for_name<EnemyType>(const char* name);
-
-bool enemy_type_valid_for_episode(Episode episode, EnemyType enemy_type);
-uint8_t battle_param_index_for_enemy_type(Episode episode, EnemyType enemy_type);
-uint8_t rare_table_index_for_enemy_type(EnemyType enemy_type);
-const std::vector<EnemyType>& enemy_types_for_rare_table_index(Episode episode, uint8_t rt_index);
-bool enemy_type_is_rare(EnemyType type);
+#pragma once
+
+#include <inttypes.h>
+
+#include <phosg/Tools.hh>
+
+#include "StaticGameData.hh"
+
+enum class EnemyType {
+  UNKNOWN = -1,
+  NONE = 0,
+  NON_ENEMY_NPC,
+  AL_RAPPY,
+  ASTARK,
+  BA_BOOTA,
+  BARBA_RAY,
+  BARBAROUS_WOLF,
+  BEE_L,
+  BEE_R,
+  BOOMA,
+  BOOTA,
+  BULCLAW,
+  BULK,
+  CANADINE,
+  CANADINE_GROUP,
+  CANANE,
+  CHAOS_BRINGER,
+  CHAOS_SORCERER,
+  CLAW,
+  DARK_BELRA,
+  DARK_FALZ_1,
+  DARK_FALZ_2,
+  DARK_FALZ_3,
+  DARK_GUNNER,
+  DARVANT,
+  DARVANT_ULTIMATE,
+  DE_ROL_LE,
+  DE_ROL_LE_BODY,
+  DE_ROL_LE_MINE,
+  DEATH_GUNNER,
+  DEL_LILY,
+  DEL_RAPPY,
+  DEL_RAPPY_ALT,
+  DELBITER,
+  DELDEPTH,
+  DELSABER,
+  DIMENIAN,
+  DOLMDARL,
+  DOLMOLM,
+  DORPHON,
+  DORPHON_ECLAIR,
+  DRAGON,
+  DUBCHIC,
+  DUBWITCH, // Has no entry in battle params
+  EGG_RAPPY,
+  EPSIGUARD,
+  EPSILON,
+  EVIL_SHARK,
+  GAEL,
+  GAL_GRYPHON,
+  GARANZ,
+  GEE,
+  GI_GUE,
+  GIBBLES,
+  GIGOBOOMA,
+  GILLCHIC,
+  GIRTABLULU,
+  GOBOOMA,
+  GOL_DRAGON,
+  GORAN,
+  GORAN_DETONATOR,
+  GRASS_ASSASSIN,
+  GUIL_SHARK,
+  HALLO_RAPPY,
+  HIDOOM,
+  HILDEBEAR,
+  HILDEBLUE,
+  ILL_GILL,
+  KONDRIEU,
+  LA_DIMENIAN,
+  LOVE_RAPPY,
+  MERICAROL,
+  MERICUS,
+  MERIKLE,
+  MERILLIA,
+  MERILTAS,
+  MERISSA_A,
+  MERISSA_AA,
+  MIGIUM,
+  MONEST,
+  MORFOS,
+  MOTHMANT,
+  NANO_DRAGON,
+  NAR_LILY,
+  OLGA_FLOW_1,
+  OLGA_FLOW_2,
+  PAL_SHARK,
+  PAN_ARMS,
+  PAZUZU,
+  PAZUZU_ALT,
+  PIG_RAY,
+  POFUILLY_SLIME,
+  POUILLY_SLIME,
+  POISON_LILY,
+  PYRO_GORAN,
+  RAG_RAPPY,
+  RECOBOX,
+  RECON,
+  SAINT_MILLION,
+  SAINT_RAPPY,
+  SAND_RAPPY,
+  SAND_RAPPY_ALT,
+  SATELLITE_LIZARD,
+  SATELLITE_LIZARD_ALT,
+  SAVAGE_WOLF,
+  SHAMBERTIN,
+  SINOW_BEAT,
+  SINOW_BERILL,
+  SINOW_GOLD,
+  SINOW_SPIGELL,
+  SINOW_ZELE,
+  SINOW_ZOA,
+  SO_DIMENIAN,
+  UL_GIBBON,
+  VOL_OPT_1,
+  VOL_OPT_2,
+  VOL_OPT_AMP,
+  VOL_OPT_CORE,
+  VOL_OPT_MONITOR,
+  VOL_OPT_PILLAR,
+  YOWIE,
+  YOWIE_ALT,
+  ZE_BOOTA,
+  ZOL_GIBBON,
+  ZU,
+  ZU_ALT,
+  MAX_ENEMY_TYPE,
+};
+
+template <>
+const char* name_for_enum<EnemyType>(EnemyType type);
+template <>
+EnemyType enum_for_name<EnemyType>(const char* name);
+
+bool enemy_type_valid_for_episode(Episode episode, EnemyType enemy_type);
+uint8_t battle_param_index_for_enemy_type(Episode episode, EnemyType enemy_type);
+uint8_t rare_table_index_for_enemy_type(EnemyType enemy_type);
+const std::vector<EnemyType>& enemy_types_for_rare_table_index(Episode episode, uint8_t rt_index);
+bool enemy_type_is_rare(EnemyType type);

src/Episode3/BattleRecord.cc

@@ -12,7 +12,7 @@ namespace Episode3 {
 void BattleRecord::PlayerEntry::print(FILE* stream) const {
   // TODO: Format this nicely somehow. Maybe factor out the functions in
   // QuestScript that format some of these structures
-  print_data(stream, this, sizeof(this));
+  print_data(stream, this, sizeof(*this), 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
 }
 
 BattleRecord::Event::Event(StringReader& r) {
@@ -96,29 +96,30 @@ void BattleRecord::Event::print(FILE* stream) const {
       for (const auto& player : this->players) {
         fprintf(stream, " %02" PRIX32, player.lobby_data.client_id.load());
       }
+      fputc('\n', stream);
       for (const auto& player : this->players) {
         player.print(stream);
       }
       break;
     case Type::BATTLE_COMMAND:
       fprintf(stream, "BATTLE_COMMAND\n");
-      print_data(stream, this->data);
+      print_data(stream, this->data, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
       break;
     case Type::GAME_COMMAND:
       fprintf(stream, "GAME_COMMAND\n");
-      print_data(stream, this->data);
+      print_data(stream, this->data, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
       break;
     case Type::EP3_GAME_COMMAND:
       fprintf(stream, "EP3_GAME_COMMAND\n");
-      print_data(stream, this->data);
+      print_data(stream, this->data, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
       break;
     case Type::CHAT_MESSAGE:
       fprintf(stream, "CHAT_MESSAGE %08" PRIX32 "\n", this->guild_card_number);
-      print_data(stream, this->data);
+      print_data(stream, this->data, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
       break;
     case Type::SERVER_DATA_COMMAND:
       fprintf(stream, "SERVER_DATA_COMMAND\n");
-      print_data(stream, this->data);
+      print_data(stream, this->data, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
       break;
     default:
       throw runtime_error("unknown event type in battle record");
@@ -255,6 +256,20 @@ void BattleRecord::add_random_data(const void* data, size_t size) {
   this->random_stream.append(reinterpret_cast<const char*>(data), size);
 }
 
+vector<string> BattleRecord::get_all_server_data_commands() const {
+  vector<string> ret;
+  for (const auto& event : this->events) {
+    if (event.type == Event::Type::SERVER_DATA_COMMAND) {
+      ret.emplace_back(event.data);
+    }
+  }
+  return ret;
+}
+
+const string& BattleRecord::get_random_stream() const {
+  return this->random_stream;
+}
+
 bool BattleRecord::is_map_definition_event(const Event& ev) {
   if (ev.type == Event::Type::BATTLE_COMMAND) {
     auto& header = check_size_t<G_CardBattleCommandHeader>(ev.data, 0xFFFF);
@@ -331,7 +346,7 @@ void BattleRecord::set_battle_start_timestamp() {
     }
   }
   for (; it != this->events.end(); it++) {
-    if (it->type == Event::Type::BATTLE_COMMAND) {
+    if ((it->type == Event::Type::BATTLE_COMMAND) || (it->type == Event::Type::SERVER_DATA_COMMAND)) {
       new_events.emplace_back(std::move(*it));
     }
   }
@@ -373,7 +388,7 @@ shared_ptr<const BattleRecord> BattleRecordPlayer::get_record() const {
   return this->record;
 }
 
-void BattleRecordPlayer::set_lobby(std::shared_ptr<Lobby> l) {
+void BattleRecordPlayer::set_lobby(shared_ptr<Lobby> l) {
   this->lobby = l;
 }
 

src/Episode3/BattleRecord.hh

@@ -86,6 +86,9 @@ public:
 
   void print(FILE* stream) const;
 
+  std::vector<std::string> get_all_server_data_commands() const;
+  const std::string& get_random_stream() const;
+
 private:
   static constexpr uint64_t SIGNATURE_V1 = 0x14C946D56D1DAC50;
   static constexpr uint64_t SIGNATURE_V2 = 0xD01E5EC12853C377;

src/Episode3/Card.cc

@@ -396,8 +396,8 @@ int16_t Card::compute_defense_power_for_attacker_card(shared_ptr<const Card> att
     }
   }
 
-  s->card_special->apply_action_conditions(3, attacker_card, this->shared_from_this(), 0x08, nullptr);
-  s->card_special->apply_action_conditions(3, attacker_card, this->shared_from_this(), 0x10, nullptr);
+  s->card_special->apply_action_conditions(EffectWhen::BEFORE_ANY_CARD_ATTACK, attacker_card, this->shared_from_this(), 0x08, nullptr);
+  s->card_special->apply_action_conditions(EffectWhen::BEFORE_ANY_CARD_ATTACK, attacker_card, this->shared_from_this(), 0x10, nullptr);
   return this->action_metadata.defense_power + this->action_metadata.defense_bonus;
 }
 
@@ -982,7 +982,7 @@ void Card::compute_action_chain_results(bool apply_action_conditions, bool ignor
 
   if (apply_action_conditions) {
     auto this_sh = this->shared_from_this();
-    s->card_special->apply_action_conditions(3, this_sh, this_sh, 1, nullptr);
+    s->card_special->apply_action_conditions(EffectWhen::BEFORE_ANY_CARD_ATTACK, this_sh, this_sh, 1, nullptr);
     log.debug("applied action conditions (1)");
   } else {
     log.debug("skipped applying action conditions (1)");
@@ -1120,7 +1120,7 @@ void Card::compute_action_chain_results(bool apply_action_conditions, bool ignor
 
   if (apply_action_conditions) {
     auto this_sh = this->shared_from_this();
-    s->card_special->apply_action_conditions(0x03, this_sh, this_sh, 2, nullptr);
+    s->card_special->apply_action_conditions(EffectWhen::BEFORE_ANY_CARD_ATTACK, this_sh, this_sh, 2, nullptr);
     log.debug("applied action conditions (2)");
     if (!is_nte && this->action_chain.check_flag(0x100)) {
       this->action_chain.chain.damage = min<int16_t>(this->action_chain.chain.damage + 5, 99);
@@ -1171,7 +1171,7 @@ void Card::unknown_80237F98(bool require_condition_20_or_21) {
   for (ssize_t z = 8; z >= 0; z--) {
     if (this->action_chain.conditions[z].type != ConditionType::NONE) {
       if (!require_condition_20_or_21 ||
-          s->card_special->condition_has_when_20_or_21(this->action_chain.conditions[z])) {
+          s->card_special->condition_applies_on_sc_or_item_attack(this->action_chain.conditions[z])) {
         ActionState as;
         auto& cond = this->action_chain.conditions[z];
         if (!s->card_special->is_card_targeted_by_condition(cond, as, this->shared_from_this())) {
@@ -1219,7 +1219,9 @@ void Card::move_phase_before() {
 }
 
 void Card::unknown_80236374(shared_ptr<Card> other_card, const ActionState* as) {
-  auto log = this->server()->log_stack(string_printf("unknown_80236374(@%04hX #%04hX, @%04hX #%04hX): ", this->get_card_ref(), this->get_card_id(), other_card->get_card_ref(), other_card->get_card_id()));
+  auto s = this->server();
+  auto log = s->log_stack(string_printf("unknown_80236374(@%04hX #%04hX, @%04hX #%04hX): ", this->get_card_ref(), this->get_card_id(), other_card->get_card_ref(), other_card->get_card_id()));
+
   auto check_card = [&](shared_ptr<Card> card) -> void {
     if (card) {
       if (!card->unknown_80236554(other_card, as)) {
@@ -1231,25 +1233,21 @@ void Card::unknown_80236374(shared_ptr<Card> other_card, const ActionState* as)
   };
 
   for (size_t client_id = 0; client_id < 4; client_id++) {
-    auto ps = this->server()->player_states[client_id];
-    if (ps) {
-      if (this->server()->get_current_team_turn2() != ps->get_team_id()) {
-        check_card(ps->get_sc_card());
-        for (size_t set_index = 0; set_index < 8; set_index++) {
-          check_card(ps->get_set_card(set_index));
-        }
+    auto ps = s->player_states[client_id];
+    if (ps && (s->get_current_team_turn2() != ps->get_team_id())) {
+      check_card(ps->get_sc_card());
+      for (size_t set_index = 0; set_index < 8; set_index++) {
+        check_card(ps->get_set_card(set_index));
       }
     }
   }
 
   for (size_t client_id = 0; client_id < 4; client_id++) {
-    auto ps = this->server()->player_states[client_id];
-    if (ps) {
-      if (this->server()->get_current_team_turn2() == ps->get_team_id()) {
-        check_card(ps->get_sc_card());
-        for (size_t set_index = 0; set_index < 8; set_index++) {
-          check_card(ps->get_set_card(set_index));
-        }
+    auto ps = s->player_states[client_id];
+    if (ps && (s->get_current_team_turn2() == ps->get_team_id())) {
+      check_card(ps->get_sc_card());
+      for (size_t set_index = 0; set_index < 8; set_index++) {
+        check_card(ps->get_set_card(set_index));
       }
     }
   }
@@ -1404,8 +1402,8 @@ bool Card::unknown_80236554(shared_ptr<Card> other_card, const ActionState* as)
   log.debug("last attack damage stats cleared");
 
   if (other_card) {
-    s->card_special->apply_action_conditions(0x03, other_card, this->shared_from_this(), 0x20, as);
-    s->card_special->apply_action_conditions(0x17, other_card, this->shared_from_this(), 0x40, as);
+    s->card_special->apply_action_conditions(EffectWhen::BEFORE_ANY_CARD_ATTACK, other_card, this->shared_from_this(), 0x20, as);
+    s->card_special->apply_action_conditions(EffectWhen::BEFORE_THIS_CARD_ATTACKED, other_card, this->shared_from_this(), 0x40, as);
     if (other_card->action_chain.check_flag(0x20000)) {
       this->action_metadata.attack_bonus = 0;
       return ret;
@@ -1520,7 +1518,7 @@ void Card::apply_attack_result() {
 
     this->compute_action_chain_results(true, false);
     if (!this->action_chain.check_flag(0x40)) {
-      s->card_special->unknown_8024997C(this->shared_from_this());
+      s->card_special->apply_effects_before_attack(this->shared_from_this());
     }
 
     this->compute_action_chain_results(true, false);
@@ -1560,21 +1558,21 @@ void Card::apply_attack_result() {
       }
     }
 
-    this->compute_action_chain_results(1, 0);
+    this->compute_action_chain_results(true, false);
     if (!this->action_chain.check_flag(0x40)) {
-      s->card_special->unknown_8024997C(this->shared_from_this());
+      s->card_special->apply_effects_before_attack(this->shared_from_this());
     }
     if (!(this->card_flags & 2)) {
-      this->compute_action_chain_results(1, 0);
+      this->compute_action_chain_results(true, false);
       s->card_special->check_for_attack_interference(this->shared_from_this());
     }
-    this->compute_action_chain_results(1, 0);
+    this->compute_action_chain_results(true, false);
     this->unknown_80236374(this->shared_from_this(), nullptr);
     this->unknown_802362D8(this->shared_from_this());
   }
 
   if (!this->action_chain.check_flag(0x40)) {
-    s->card_special->unknown_8024A394(this->shared_from_this());
+    s->card_special->apply_effects_after_attack(this->shared_from_this());
   }
   ps->stats.num_attacks_given++;
 

src/Episode3/CardSpecial.cc

@@ -79,7 +79,7 @@ void CardSpecial::AttackEnvStats::clear() {
   this->target_attack_bonus = 0;
   this->last_attack_preliminary_damage = 0;
   this->last_attack_damage = 0;
-  this->total_last_attack_damage = 0;
+  this->final_last_attack_damage = 0;
   this->last_attack_damage_count = 0;
   this->target_current_hp = 0;
 }
@@ -107,7 +107,7 @@ void CardSpecial::AttackEnvStats::print(FILE* stream) const {
   fprintf(stream, "(ef)  non_target_team_num_set_cards      = %" PRIu32 "\n", this->non_target_team_num_set_cards);
   fprintf(stream, "(ehp) target_current_hp                  = %" PRIu32 "\n", this->target_current_hp);
   fprintf(stream, "(f)   num_set_cards                      = %" PRIu32 "\n", this->num_set_cards);
-  fprintf(stream, "(fdm) total_last_attack_damage           = %" PRIu32 "\n", this->total_last_attack_damage);
+  fprintf(stream, "(fdm) final_last_attack_damage           = %" PRIu32 "\n", this->final_last_attack_damage);
   fprintf(stream, "(ff)  target_team_num_set_cards          = %" PRIu32 "\n", this->target_team_num_set_cards);
   fprintf(stream, "(gn)  num_gun_type_items                 = %" PRIu32 "\n", this->num_gun_type_items);
   fprintf(stream, "(hf)  num_item_or_creature_cards_in_hand = %" PRIu32 "\n", this->num_item_or_creature_cards_in_hand);
@@ -239,7 +239,7 @@ void CardSpecial::adjust_dice_boost_if_team_has_condition_52(
 }
 
 void CardSpecial::apply_action_conditions(
-    uint8_t when,
+    EffectWhen when,
     shared_ptr<const Card> attacker_card,
     shared_ptr<Card> defender_card,
     uint32_t flags,
@@ -252,8 +252,7 @@ void CardSpecial::apply_action_conditions(
       temp_as = *as;
     }
   } else {
-    temp_as = this->create_defense_state_for_card_pair_action_chains(
-        attacker_card, defender_card);
+    temp_as = this->create_defense_state_for_card_pair_action_chains(attacker_card, defender_card);
   }
 
   this->apply_defense_conditions(temp_as, when, defender_card, flags);
@@ -291,7 +290,7 @@ bool CardSpecial::apply_attribute_guard_if_possible(
 }
 
 bool CardSpecial::apply_defense_condition(
-    uint8_t when,
+    EffectWhen when,
     Condition* defender_cond,
     uint8_t cond_index,
     const ActionState& defense_state,
@@ -328,7 +327,7 @@ bool CardSpecial::apply_defense_condition(
     return false;
   }
 
-  if ((when == 0x02) && (defender_cond->type == ConditionType::GUOM) && (flags & 4)) {
+  if ((when == EffectWhen::AFTER_ANY_CARD_ATTACK) && (defender_cond->type == ConditionType::GUOM) && (flags & 4)) {
     CardShortStatus stat = defender_card->get_short_status();
     if (stat.card_flags & 4) {
       G_ApplyConditionEffect_Ep3_6xB4x06 cmd;
@@ -347,7 +346,7 @@ bool CardSpecial::apply_defense_condition(
 
   if (s->options.is_nte()) {
     auto defender_ps = defender_card->player_state();
-    if ((when == 0x0F) && (flags & 4) && (defender_cond->type == ConditionType::DROP) && defender_ps) {
+    if ((when == EffectWhen::BEFORE_DRAW_PHASE) && (flags & 4) && (defender_cond->type == ConditionType::DROP) && defender_ps) {
       auto defender_sc_card = defender_ps->get_sc_card();
       uint8_t defender_team_id = defender_ps->get_team_id();
       if (defender_sc_card && s->team_exp[defender_team_id]) {
@@ -364,7 +363,7 @@ bool CardSpecial::apply_defense_condition(
     }
   }
 
-  if ((when == 0x04) && (flags & 4) && !defender_has_ability_trap && (defender_cond->type == ConditionType::ACID)) {
+  if ((when == EffectWhen::BEFORE_DICE_PHASE_THIS_TEAM_TURN) && (flags & 4) && !defender_has_ability_trap && (defender_cond->type == ConditionType::ACID)) {
     int16_t hp = defender_card->get_current_hp();
     if (hp > 0) {
       this->send_6xB4x06_for_stat_delta(defender_card, defender_cond->card_ref, 0x20, -1, 0, 1);
@@ -418,12 +417,11 @@ bool CardSpecial::apply_defense_condition(
 
 bool CardSpecial::apply_defense_conditions(
     const ActionState& as,
-    uint8_t when,
+    EffectWhen when,
     shared_ptr<Card> defender_card,
     uint32_t flags) {
   for (size_t z = 0; z < 9; z++) {
-    this->apply_defense_condition(
-        when, &defender_card->action_chain.conditions[z], z, as, defender_card, flags, 0);
+    this->apply_defense_condition(when, &defender_card->action_chain.conditions[z], z, as, defender_card, flags, 0);
   }
   return true;
 }
@@ -812,7 +810,7 @@ CardSpecial::AttackEnvStats CardSpecial::compute_attack_env_stats(
   int32_t total_last_attack_damage = 0;
   size_t last_attack_damage_count = 0;
   this->sum_last_attack_damage(nullptr, &total_last_attack_damage, &last_attack_damage_count);
-  ast.total_last_attack_damage = total_last_attack_damage;
+  ast.final_last_attack_damage = total_last_attack_damage;
   ast.last_attack_damage_count = last_attack_damage_count;
 
   if (!target_card) {
@@ -1238,13 +1236,14 @@ void CardSpecial::compute_team_dice_bonus(uint8_t team_id) {
   s->team_dice_bonus[team_id] = min<uint8_t>(value, 8);
 }
 
-bool CardSpecial::condition_has_when_20_or_21(const Condition& cond) const {
+bool CardSpecial::condition_applies_on_sc_or_item_attack(const Condition& cond) const {
   auto ce = this->server()->definition_for_card_ref(cond.card_ref);
   if (!ce) {
     return false;
   }
-  uint8_t when = ce->def.effects[cond.card_definition_effect_index].when;
-  return ((when == 0x20) || (when == 0x21));
+  EffectWhen when = ce->def.effects[cond.card_definition_effect_index].when;
+  return ((when == EffectWhen::AFTER_CREATURE_OR_HUNTER_SC_ATTACK) ||
+      (when == EffectWhen::BEFORE_CREATURE_OR_HUNTER_SC_ATTACK));
 }
 
 size_t CardSpecial::count_action_cards_with_condition_for_all_current_attacks(
@@ -1410,7 +1409,7 @@ bool CardSpecial::evaluate_effect_arg2_condition(
     uint16_t set_card_ref,
     uint16_t sc_card_ref,
     uint8_t random_percent,
-    uint8_t when) const {
+    EffectWhen when) const {
   // Note: In the original code, as and dice_roll were optional pointers, but
   // they are non-null at all callsites, so we've replaced them with references
   // (and eliminated the null checks within this function).
@@ -1650,7 +1649,7 @@ bool CardSpecial::evaluate_effect_arg2_condition(
       // or comment it appropriately.
       if (is_nte) {
         return (v < set_card->unknown_a9);
-      } else if (when == 4) {
+      } else if (when == EffectWhen::BEFORE_DICE_PHASE_THIS_TEAM_TURN) {
         uint32_t y = set_card->unknown_a9 & 0xFFFFFFFE;
         if ((set_card->unknown_a9 > 0) &&
             (y == (y / (v & 0xFFFFFFFE)) * (v & 0xFFFFFFFE))) {
@@ -3519,7 +3518,7 @@ void CardSpecial::on_card_set(shared_ptr<PlayerState> ps, uint16_t card_ref) {
   uint16_t sc_card_ref = sc_card ? sc_card->get_card_ref() : 0xFFFF;
 
   ActionState as;
-  this->evaluate_and_apply_effects(0x01, card_ref, as, sc_card_ref);
+  this->evaluate_and_apply_effects(EffectWhen::CARD_SET, card_ref, as, sc_card_ref);
 }
 
 const CardDefinition::Effect* CardSpecial::original_definition_for_condition(const Condition& cond) const {
@@ -3827,7 +3826,7 @@ int16_t CardSpecial::max_all_attack_bonuses(size_t* out_count) const {
   return max_attack_bonus;
 }
 
-void CardSpecial::unknown_80244AA8(shared_ptr<Card> card) {
+void CardSpecial::apply_effects_after_card_move(shared_ptr<Card> card) {
   ActionState as = this->create_attack_state_from_card_action_chain(card);
 
   bool is_nte = this->server()->options.is_nte();
@@ -3847,12 +3846,12 @@ void CardSpecial::unknown_80244AA8(shared_ptr<Card> card) {
         }
       }
     }
-    this->apply_defense_conditions(as, 0x27, card, 0x04);
-    this->evaluate_and_apply_effects(0x27, card->get_card_ref(), as, 0xFFFF);
+    this->apply_defense_conditions(as, EffectWhen::BEFORE_MOVE_PHASE_AND_AFTER_CARD_MOVE_FINAL, card, 0x04);
+    this->evaluate_and_apply_effects(EffectWhen::BEFORE_MOVE_PHASE_AND_AFTER_CARD_MOVE_FINAL, card->get_card_ref(), as, 0xFFFF);
   }
 
-  this->apply_defense_conditions(as, 0x13, card, is_nte ? 0x1F : 0x04);
-  this->evaluate_and_apply_effects(0x13, card->get_card_ref(), as, 0xFFFF);
+  this->apply_defense_conditions(as, EffectWhen::AFTER_CARD_MOVE, card, is_nte ? 0x1F : 0x04);
+  this->evaluate_and_apply_effects(EffectWhen::AFTER_CARD_MOVE, card->get_card_ref(), as, 0xFFFF);
 }
 
 void CardSpecial::check_for_defense_interference(
@@ -3938,20 +3937,20 @@ void CardSpecial::check_for_defense_interference(
 }
 
 void CardSpecial::evaluate_and_apply_effects(
-    uint8_t when,
+    EffectWhen when,
     uint16_t set_card_ref,
     const ActionState& as,
     uint16_t sc_card_ref,
     bool apply_defense_condition_to_all_cards,
     uint16_t apply_defense_condition_to_card_ref) {
   auto s = this->server();
-  auto log = s->log_stack(string_printf("evaluate_and_apply_effects(%02hhX, @%04hX, @%04hX): ", when, set_card_ref, sc_card_ref));
+  auto log = s->log_stack(string_printf("evaluate_and_apply_effects(%s, @%04hX, @%04hX): ", name_for_enum(when), set_card_ref, sc_card_ref));
   bool is_nte = s->options.is_nte();
 
   {
     string as_str = as.str(s);
-    log.debug("when=%02hhX, set_card_ref=@%04hX, as=%s, sc_card_ref=@%04hX, apply_defense_condition_to_all_cards=%s, apply_defense_condition_to_card_ref=@%04hX",
-        when, set_card_ref, as_str.c_str(), sc_card_ref, apply_defense_condition_to_all_cards ? "true" : "false", apply_defense_condition_to_card_ref);
+    log.debug("when=%s, set_card_ref=@%04hX, as=%s, sc_card_ref=@%04hX, apply_defense_condition_to_all_cards=%s, apply_defense_condition_to_card_ref=@%04hX",
+        name_for_enum(when), set_card_ref, as_str.c_str(), sc_card_ref, apply_defense_condition_to_all_cards ? "true" : "false", apply_defense_condition_to_card_ref);
   }
 
   if (!is_nte) {
@@ -4016,7 +4015,7 @@ void CardSpecial::evaluate_and_apply_effects(
     string card_effect_str = card_effect.str();
     effect_log.debug("effect: %s", card_effect_str.c_str());
     if (card_effect.when != when) {
-      effect_log.debug("does not apply (effect.when=%02hhX, when=%02" PRIX32 ")", card_effect.when, when);
+      effect_log.debug("does not apply (effect.when=%s, when=%s)", name_for_enum(card_effect.when), name_for_enum(when));
       continue;
     }
 
@@ -4428,10 +4427,10 @@ void CardSpecial::on_card_destroyed(
       attacker_card, destroyed_card);
 
   uint16_t destroyed_card_ref = destroyed_card->get_card_ref();
-  this->evaluate_and_apply_effects(0x05, destroyed_card_ref, defense_as, 0xFFFF);
+  this->evaluate_and_apply_effects(EffectWhen::CARD_DESTROYED, destroyed_card_ref, defense_as, 0xFFFF);
   for (size_t z = 0; (z < 8) && (defense_as.action_card_refs[z] != 0xFFFF); z++) {
     this->evaluate_and_apply_effects(
-        0x05, defense_as.action_card_refs[z], defense_as, destroyed_card->get_card_ref());
+        EffectWhen::CARD_DESTROYED, defense_as.action_card_refs[z], defense_as, destroyed_card->get_card_ref());
   }
 
   if (attacker_card) {
@@ -4673,9 +4672,9 @@ vector<shared_ptr<const Card>> CardSpecial::filter_cards_by_range(
   return ret;
 }
 
-void CardSpecial::unknown_8024AAB8(const ActionState& as) {
+void CardSpecial::apply_effects_after_attack_target_resolution(const ActionState& as) {
   auto s = this->server();
-  auto log = s->log_stack("unknown_8024AAB8: ");
+  auto log = s->log_stack("apply_effects_after_attack_target_resolution: ");
   string as_str = as.str(s);
   log.debug("as=%s", as_str.c_str());
 
@@ -4687,31 +4686,37 @@ void CardSpecial::unknown_8024AAB8(const ActionState& as) {
 
     if (this->send_6xB4x06_if_card_ref_invalid(as.original_attacker_card_ref, 0x1F) == 0xFFFF) {
       this->evaluate_and_apply_effects(
-          0x01, as.action_card_refs[z], as, this->send_6xB4x06_if_card_ref_invalid(as.attacker_card_ref, 0x21));
+          EffectWhen::CARD_SET,
+          as.action_card_refs[z],
+          as,
+          this->send_6xB4x06_if_card_ref_invalid(as.attacker_card_ref, 0x21));
       this->evaluate_and_apply_effects(
-          0x0B, as.action_card_refs[z], as, this->send_6xB4x06_if_card_ref_invalid(as.attacker_card_ref, 0x22));
+          EffectWhen::AFTER_ATTACK_TARGET_RESOLUTION,
+          as.action_card_refs[z],
+          as,
+          this->send_6xB4x06_if_card_ref_invalid(as.attacker_card_ref, 0x22));
     } else {
       uint16_t card_ref = this->send_6xB4x06_if_card_ref_invalid(as.target_card_refs[0], 0x20);
       if (card_ref != 0xFFFF) {
-        this->evaluate_and_apply_effects(0x01, as.action_card_refs[z], as, card_ref);
-        this->evaluate_and_apply_effects(0x15, as.action_card_refs[z], as, card_ref);
+        this->evaluate_and_apply_effects(EffectWhen::CARD_SET, as.action_card_refs[z], as, card_ref);
+        this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_15, as.action_card_refs[z], as, card_ref);
       }
     }
   }
 
-  if (as.original_attacker_card_ref == 0xffff) {
+  if (as.original_attacker_card_ref == 0xFFFF) {
     uint16_t card_ref1 = this->send_6xB4x06_if_card_ref_invalid(as.attacker_card_ref, 0x23);
     uint16_t card_ref2 = this->send_6xB4x06_if_card_ref_invalid(as.attacker_card_ref, 0x25);
-    this->evaluate_and_apply_effects(0x33, card_ref2, as, card_ref1);
+    this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_33, card_ref2, as, card_ref1);
     card_ref1 = this->send_6xB4x06_if_card_ref_invalid(as.attacker_card_ref, 0x24);
     card_ref2 = this->send_6xB4x06_if_card_ref_invalid(as.attacker_card_ref, 0x26);
-    this->evaluate_and_apply_effects(0x34, card_ref2, as, card_ref1);
+    this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_34, card_ref2, as, card_ref1);
     for (size_t z = 0; (z < 4 * 9) && (as.target_card_refs[z] != 0xFFFF); z++) {
       uint16_t card_ref = this->send_6xB4x06_if_card_ref_invalid(as.action_card_refs[z], 0x27);
       if (card_ref == 0xFFFF) {
         break;
       }
-      this->evaluate_and_apply_effects(0x35, as.target_card_refs[z], as, as.attacker_card_ref);
+      this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_35, as.target_card_refs[z], as, as.attacker_card_ref);
     }
   }
 }
@@ -4719,11 +4724,11 @@ void CardSpecial::unknown_8024AAB8(const ActionState& as) {
 void CardSpecial::move_phase_before_for_card(shared_ptr<Card> card) {
   bool is_nte = this->server()->options.is_nte();
   ActionState as = this->create_attack_state_from_card_action_chain(card);
-  this->apply_defense_conditions(as, 0x09, card, is_nte ? 0x1F : 0x04);
-  this->evaluate_and_apply_effects(0x09, card->get_card_ref(), as, 0xFFFF);
+  this->apply_defense_conditions(as, EffectWhen::BEFORE_MOVE_PHASE, card, is_nte ? 0x1F : 0x04);
+  this->evaluate_and_apply_effects(EffectWhen::BEFORE_MOVE_PHASE, card->get_card_ref(), as, 0xFFFF);
   if (!is_nte) {
-    this->apply_defense_conditions(as, 0x27, card, 0x04);
-    this->evaluate_and_apply_effects(0x27, card->get_card_ref(), as, 0xFFFF);
+    this->apply_defense_conditions(as, EffectWhen::BEFORE_MOVE_PHASE_AND_AFTER_CARD_MOVE_FINAL, card, 0x04);
+    this->evaluate_and_apply_effects(EffectWhen::BEFORE_MOVE_PHASE_AND_AFTER_CARD_MOVE_FINAL, card->get_card_ref(), as, 0xFFFF);
   }
 }
 
@@ -4750,19 +4755,19 @@ void CardSpecial::dice_phase_before_for_card(shared_ptr<Card> card) {
   }
 
   if (!is_nte) {
-    this->apply_defense_conditions(as, 0x46, card, 0x04);
-    this->evaluate_and_apply_effects(0x46, card->get_card_ref(), as, sc_card_ref);
+    this->apply_defense_conditions(as, EffectWhen::BEFORE_DICE_PHASE_ALL_TURNS_FINAL, card, 0x04);
+    this->evaluate_and_apply_effects(EffectWhen::BEFORE_DICE_PHASE_ALL_TURNS_FINAL, card->get_card_ref(), as, sc_card_ref);
   }
   if (ps->is_team_turn()) {
-    this->apply_defense_conditions(as, 0x04, card, 0x04);
-    this->evaluate_and_apply_effects(0x04, card->get_card_ref(), as, sc_card_ref);
+    this->apply_defense_conditions(as, EffectWhen::BEFORE_DICE_PHASE_THIS_TEAM_TURN, card, 0x04);
+    this->evaluate_and_apply_effects(EffectWhen::BEFORE_DICE_PHASE_THIS_TEAM_TURN, card->get_card_ref(), as, sc_card_ref);
   }
 }
 
-template <uint8_t When1, uint8_t When2>
+template <EffectWhen When1, EffectWhen When2>
 void CardSpecial::apply_effects_on_phase_change_t(shared_ptr<Card> unknown_p2, const ActionState* existing_as) {
   auto s = this->server();
-  auto log = s->log_stack(string_printf("apply_effects_on_phase_change_t<%02hhX, %02hhX>(@%04hX #%04hX): ", When1, When2, unknown_p2->get_card_ref(), unknown_p2->get_card_id()));
+  auto log = s->log_stack(string_printf("apply_effects_on_phase_change_t<%s, %s>(@%04hX #%04hX): ", name_for_enum(When1), name_for_enum(When2), unknown_p2->get_card_ref(), unknown_p2->get_card_id()));
   bool is_nte = s->options.is_nte();
 
   ActionState as;
@@ -4799,17 +4804,17 @@ void CardSpecial::apply_effects_on_phase_change_t(shared_ptr<Card> unknown_p2, c
 }
 
 void CardSpecial::draw_phase_before_for_card(shared_ptr<Card> unknown_p2) {
-  this->apply_effects_on_phase_change_t<0x0F, 0x0A>(unknown_p2);
+  this->apply_effects_on_phase_change_t<EffectWhen::BEFORE_DRAW_PHASE, EffectWhen::UNKNOWN_0A>(unknown_p2);
 }
 
 void CardSpecial::action_phase_before_for_card(shared_ptr<Card> unknown_p2) {
   if (unknown_p2->player_state()->is_team_turn()) {
-    this->apply_effects_on_phase_change_t<0x0E, 0x0A>(unknown_p2);
+    this->apply_effects_on_phase_change_t<EffectWhen::BEFORE_ACT_PHASE, EffectWhen::UNKNOWN_0A>(unknown_p2);
   }
 }
 
 void CardSpecial::unknown_8024945C(shared_ptr<Card> unknown_p2, const ActionState* existing_as) {
-  this->apply_effects_on_phase_change_t<0x0A, 0x0A>(unknown_p2, this->server()->options.is_nte() ? nullptr : existing_as);
+  this->apply_effects_on_phase_change_t<EffectWhen::UNKNOWN_0A, EffectWhen::UNKNOWN_0A>(unknown_p2, this->server()->options.is_nte() ? nullptr : existing_as);
 }
 
 void CardSpecial::unknown_8024966C(shared_ptr<Card> unknown_p2, const ActionState* existing_as) {
@@ -4828,38 +4833,38 @@ void CardSpecial::unknown_8024966C(shared_ptr<Card> unknown_p2, const ActionStat
   auto ce = unknown_p2->get_definition();
   auto defender_card = (ce && (ce->def.type == CardType::ITEM) && card) ? card : unknown_p2;
 
-  this->apply_defense_conditions(as, 0x3D, unknown_p2, 4);
-  this->apply_defense_conditions(as, 0x3E, unknown_p2, 4);
+  this->apply_defense_conditions(as, EffectWhen::ATTACK_STAT_OVERRIDES, unknown_p2, 4);
+  this->apply_defense_conditions(as, EffectWhen::ATTACK_DAMAGE_ADJUSTMENT, unknown_p2, 4);
   if (defender_card) {
-    this->apply_defense_conditions(as, 0x22, defender_card, 4);
+    this->apply_defense_conditions(as, EffectWhen::UNKNOWN_22, defender_card, 4);
   }
 
   for (size_t z = 0; (z < 4 * 9) && (as.target_card_refs[z] != 0xFFFF); z++) {
     auto card = this->server()->card_for_set_card_ref(as.target_card_refs[z]);
     if (card) {
       ActionState defense_as = this->create_defense_state_for_card_pair_action_chains(unknown_p2, card);
-      this->apply_defense_conditions(defense_as, 0x3D, card, 4);
-      this->apply_defense_conditions(defense_as, 0x3F, card, 4);
+      this->apply_defense_conditions(defense_as, EffectWhen::ATTACK_STAT_OVERRIDES, card, 4);
+      this->apply_defense_conditions(defense_as, EffectWhen::DEFENSE_DAMAGE_ADJUSTMENT, card, 4);
     }
   }
 
-  this->evaluate_and_apply_effects(0x3D, unknown_p2->get_card_ref(), as, card_ref);
-  this->evaluate_and_apply_effects(0x3E, unknown_p2->get_card_ref(), as, card_ref);
+  this->evaluate_and_apply_effects(EffectWhen::ATTACK_STAT_OVERRIDES, unknown_p2->get_card_ref(), as, card_ref);
+  this->evaluate_and_apply_effects(EffectWhen::ATTACK_DAMAGE_ADJUSTMENT, unknown_p2->get_card_ref(), as, card_ref);
   if (defender_card) {
-    this->evaluate_and_apply_effects(0x22, defender_card->get_card_ref(), as, card_ref);
+    this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_22, defender_card->get_card_ref(), as, card_ref);
   }
 
   for (size_t z = 0; (z < 8) && (as.action_card_refs[z] != 0xFFFF); z++) {
-    this->evaluate_and_apply_effects(0x3D, as.action_card_refs[z], as, unknown_p2->get_card_ref());
-    this->evaluate_and_apply_effects(0x3E, as.action_card_refs[z], as, unknown_p2->get_card_ref());
+    this->evaluate_and_apply_effects(EffectWhen::ATTACK_STAT_OVERRIDES, as.action_card_refs[z], as, unknown_p2->get_card_ref());
+    this->evaluate_and_apply_effects(EffectWhen::ATTACK_DAMAGE_ADJUSTMENT, as.action_card_refs[z], as, unknown_p2->get_card_ref());
   }
 
   for (size_t z = 0; (z < 4 * 9) && (as.target_card_refs[z] != 0xFFFF); z++) {
     card = this->server()->card_for_set_card_ref(as.target_card_refs[z]);
     if (card) {
       ActionState defense_as = this->create_defense_state_for_card_pair_action_chains(unknown_p2, card);
-      this->evaluate_and_apply_effects(0x3D, card->get_card_ref(), defense_as, unknown_p2->get_card_ref());
-      this->evaluate_and_apply_effects(0x3F, card->get_card_ref(), defense_as, unknown_p2->get_card_ref());
+      this->evaluate_and_apply_effects(EffectWhen::ATTACK_STAT_OVERRIDES, card->get_card_ref(), defense_as, unknown_p2->get_card_ref());
+      this->evaluate_and_apply_effects(EffectWhen::DEFENSE_DAMAGE_ADJUSTMENT, card->get_card_ref(), defense_as, unknown_p2->get_card_ref());
     }
   }
 }
@@ -4873,11 +4878,11 @@ void CardSpecial::unknown_8024A9D8(const ActionState& pa, uint16_t action_card_r
   for (size_t z = 0; (z < 8) && (pa.action_card_refs[z] != 0xFFFF); z++) {
     if (this->server()->options.is_nte() || (action_card_ref == 0xFFFF) || (action_card_ref == pa.action_card_refs[z])) {
       if (pa.original_attacker_card_ref == 0xFFFF) {
-        this->evaluate_and_apply_effects(0x29, pa.action_card_refs[z], pa, pa.attacker_card_ref);
-        this->evaluate_and_apply_effects(0x2A, pa.action_card_refs[z], pa, pa.attacker_card_ref);
+        this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_29, pa.action_card_refs[z], pa, pa.attacker_card_ref);
+        this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_2A, pa.action_card_refs[z], pa, pa.attacker_card_ref);
       } else {
-        this->evaluate_and_apply_effects(0x29, pa.action_card_refs[z], pa, pa.target_card_refs[0]);
-        this->evaluate_and_apply_effects(0x2B, pa.action_card_refs[z], pa, pa.target_card_refs[0]);
+        this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_29, pa.action_card_refs[z], pa, pa.target_card_refs[0]);
+        this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_2B, pa.action_card_refs[z], pa, pa.target_card_refs[0]);
       }
     }
   }
@@ -4957,10 +4962,15 @@ void CardSpecial::check_for_attack_interference(shared_ptr<Card> unknown_p2) {
   this->server()->send(cmd);
 }
 
-template <uint8_t When1, uint8_t When2, uint8_t When3, uint8_t When4>
-void CardSpecial::unknown_t2(shared_ptr<Card> unknown_p2) {
+template <
+    EffectWhen WhenAllCards,
+    EffectWhen WhenAttackerAndActionCards,
+    EffectWhen WhenAttackerOrHunterSCCard,
+    EffectWhen WhenTargetsAndActionCards>
+void CardSpecial::apply_effects_before_or_after_attack(shared_ptr<Card> unknown_p2) {
   auto s = this->server();
-  auto log = s->log_stack(string_printf("unknown_t2<%02hhX, %02hhX, %02hhX, %02hhX>(@%04hX #%04hX): ", When1, When2, When3, When4, unknown_p2->get_card_ref(), unknown_p2->get_card_id()));
+  auto log = s->log_stack(string_printf("apply_effects_before_or_after_attack<%s, %s, %s, %s>(@%04hX #%04hX): ",
+      name_for_enum(WhenAllCards), name_for_enum(WhenAttackerAndActionCards), name_for_enum(WhenAttackerOrHunterSCCard), name_for_enum(WhenTargetsAndActionCards), unknown_p2->get_card_ref(), unknown_p2->get_card_id()));
 
   ActionState as = this->create_attack_state_from_card_action_chain(unknown_p2);
 
@@ -4970,56 +4980,64 @@ void CardSpecial::unknown_t2(shared_ptr<Card> unknown_p2) {
     sc_card_ref = sc_card->get_card_ref();
   }
 
-  auto defender_card = unknown_p2;
+  auto attacker_card = unknown_p2;
   if (unknown_p2->get_definition() && (unknown_p2->get_definition()->def.type == CardType::ITEM) && sc_card) {
-    defender_card = sc_card;
+    attacker_card = sc_card;
   }
 
   uint8_t apply_defense_conditions_flags = s->options.is_nte() ? 0x1F : 0x04;
-  this->apply_defense_conditions(as, When1, unknown_p2, apply_defense_conditions_flags);
-  this->apply_defense_conditions(as, When2, unknown_p2, apply_defense_conditions_flags);
-  if (defender_card) {
-    this->apply_defense_conditions(as, When3, defender_card, apply_defense_conditions_flags);
+  this->apply_defense_conditions(as, WhenAllCards, unknown_p2, apply_defense_conditions_flags);
+  this->apply_defense_conditions(as, WhenAttackerAndActionCards, unknown_p2, apply_defense_conditions_flags);
+  if (attacker_card) {
+    this->apply_defense_conditions(as, WhenAttackerOrHunterSCCard, attacker_card, apply_defense_conditions_flags);
   }
 
   for (size_t z = 0; (z < 4 * 9) && (as.target_card_refs[z] != 0xFFFF); z++) {
     auto set_card = s->card_for_set_card_ref(as.target_card_refs[z]);
     if (set_card) {
       ActionState target_as = this->create_defense_state_for_card_pair_action_chains(unknown_p2, set_card);
-      this->apply_defense_conditions(target_as, When1, set_card, apply_defense_conditions_flags);
-      this->apply_defense_conditions(target_as, When4, set_card, apply_defense_conditions_flags);
+      this->apply_defense_conditions(target_as, WhenAllCards, set_card, apply_defense_conditions_flags);
+      this->apply_defense_conditions(target_as, WhenTargetsAndActionCards, set_card, apply_defense_conditions_flags);
     }
   }
 
-  this->evaluate_and_apply_effects(When1, unknown_p2->get_card_ref(), as, sc_card_ref);
-  this->evaluate_and_apply_effects(When2, unknown_p2->get_card_ref(), as, sc_card_ref);
-  if (defender_card) {
-    this->evaluate_and_apply_effects(When3, defender_card->get_card_ref(), as, sc_card_ref);
+  this->evaluate_and_apply_effects(WhenAllCards, unknown_p2->get_card_ref(), as, sc_card_ref);
+  this->evaluate_and_apply_effects(WhenAttackerAndActionCards, unknown_p2->get_card_ref(), as, sc_card_ref);
+  if (attacker_card) {
+    this->evaluate_and_apply_effects(WhenAttackerOrHunterSCCard, attacker_card->get_card_ref(), as, sc_card_ref);
   }
   for (size_t z = 0; (z < 8) && (as.action_card_refs[z] != 0xFFFF); z++) {
-    this->evaluate_and_apply_effects(When1, as.action_card_refs[z], as, unknown_p2->get_card_ref());
-    this->evaluate_and_apply_effects(When2, as.action_card_refs[z], as, unknown_p2->get_card_ref());
+    this->evaluate_and_apply_effects(WhenAllCards, as.action_card_refs[z], as, unknown_p2->get_card_ref());
+    this->evaluate_and_apply_effects(WhenAttackerAndActionCards, as.action_card_refs[z], as, unknown_p2->get_card_ref());
   }
   for (size_t z = 0; (z < 4 * 9) && (as.target_card_refs[z] != 0xFFFF); z++) {
     auto set_card = s->card_for_set_card_ref(as.target_card_refs[z]);
     if (set_card) {
       ActionState target_as = this->create_defense_state_for_card_pair_action_chains(unknown_p2, set_card);
-      this->evaluate_and_apply_effects(When1, set_card->get_card_ref(), target_as, unknown_p2->get_card_ref());
-      this->evaluate_and_apply_effects(When4, set_card->get_card_ref(), target_as, unknown_p2->get_card_ref());
+      this->evaluate_and_apply_effects(WhenAllCards, set_card->get_card_ref(), target_as, unknown_p2->get_card_ref());
+      this->evaluate_and_apply_effects(WhenTargetsAndActionCards, set_card->get_card_ref(), target_as, unknown_p2->get_card_ref());
       for (size_t z = 0; (z < 8) && (target_as.action_card_refs[z] != 0xFFFF); z++) {
-        this->evaluate_and_apply_effects(When1, target_as.action_card_refs[z], target_as, set_card->get_card_ref());
-        this->evaluate_and_apply_effects(When4, target_as.action_card_refs[z], target_as, set_card->get_card_ref());
+        this->evaluate_and_apply_effects(WhenAllCards, target_as.action_card_refs[z], target_as, set_card->get_card_ref());
+        this->evaluate_and_apply_effects(WhenTargetsAndActionCards, target_as.action_card_refs[z], target_as, set_card->get_card_ref());
       }
     }
   }
 }
 
-void CardSpecial::unknown_8024997C(shared_ptr<Card> card) {
-  return this->unknown_t2<0x03, 0x0D, 0x21, 0x17>(card);
+void CardSpecial::apply_effects_after_attack(shared_ptr<Card> card) {
+  return this->apply_effects_before_or_after_attack<
+      EffectWhen::AFTER_ANY_CARD_ATTACK,
+      EffectWhen::AFTER_THIS_CARD_ATTACK,
+      EffectWhen::AFTER_CREATURE_OR_HUNTER_SC_ATTACK,
+      EffectWhen::AFTER_THIS_CARD_ATTACKED>(card);
 }
 
-void CardSpecial::unknown_8024A394(shared_ptr<Card> card) {
-  return this->unknown_t2<0x02, 0x0C, 0x20, 0x16>(card);
+void CardSpecial::apply_effects_before_attack(shared_ptr<Card> card) {
+  return this->apply_effects_before_or_after_attack<
+      EffectWhen::BEFORE_ANY_CARD_ATTACK,
+      EffectWhen::BEFORE_THIS_CARD_ATTACK,
+      EffectWhen::BEFORE_CREATURE_OR_HUNTER_SC_ATTACK,
+      EffectWhen::BEFORE_THIS_CARD_ATTACKED>(card);
 }
 
 bool CardSpecial::client_has_atk_dice_boost_condition(uint8_t client_id) {
@@ -5056,8 +5074,8 @@ void CardSpecial::unknown_8024A6DC(shared_ptr<Card> unknown_p2, shared_ptr<Card>
   ActionState as = this->create_defense_state_for_card_pair_action_chains(
       unknown_p2, unknown_p3);
   for (size_t z = 0; (z < 8) && (as.action_card_refs[z] != 0xFFFF); z++) {
-    this->evaluate_and_apply_effects(0x01, as.action_card_refs[z], as, unknown_p3->get_card_ref());
-    this->evaluate_and_apply_effects(0x15, as.action_card_refs[z], as, unknown_p3->get_card_ref());
+    this->evaluate_and_apply_effects(EffectWhen::CARD_SET, as.action_card_refs[z], as, unknown_p3->get_card_ref());
+    this->evaluate_and_apply_effects(EffectWhen::UNKNOWN_15, as.action_card_refs[z], as, unknown_p3->get_card_ref());
   }
 }
 

src/Episode3/CardSpecial.hh

@@ -85,7 +85,7 @@ public:
     /* 84 */ uint32_t target_attack_bonus; // "edm" in expr
     /* 88 */ uint32_t last_attack_preliminary_damage; // "ldm" in expr
     /* 8C */ uint32_t last_attack_damage; // "rdm" in expr
-    /* 90 */ uint32_t total_last_attack_damage; // "fdm" in expr
+    /* 90 */ uint32_t final_last_attack_damage; // "fdm" in expr
     /* 94 */ uint32_t last_attack_damage_count; // "ndm" in expr
     /* 98 */ uint32_t target_current_hp; // "ehp" in expr
     /* 9C */
@@ -106,7 +106,7 @@ public:
   void adjust_dice_boost_if_team_has_condition_52(
       uint8_t team_id, uint8_t* inout_dice_boost, std::shared_ptr<const Card> card);
   void apply_action_conditions(
-      uint8_t when,
+      EffectWhen when,
       std::shared_ptr<const Card> attacker_card,
       std::shared_ptr<Card> defender_card,
       uint32_t flags,
@@ -118,7 +118,7 @@ public:
       uint16_t condition_giver_card_ref,
       uint16_t attacker_card_ref);
   bool apply_defense_condition(
-      uint8_t when,
+      EffectWhen when,
       Condition* defender_cond,
       uint8_t cond_index,
       const ActionState& defense_state,
@@ -127,7 +127,7 @@ public:
       bool unknown_p8);
   bool apply_defense_conditions(
       const ActionState& as,
-      uint8_t when,
+      EffectWhen when,
       std::shared_ptr<Card> defender_card,
       uint32_t flags);
   bool apply_stat_deltas_to_all_cards_from_all_conditions_with_card_ref(
@@ -165,7 +165,7 @@ public:
       uint16_t sc_card_ref);
   StatSwapType compute_stat_swap_type(std::shared_ptr<const Card> card) const;
   void compute_team_dice_bonus(uint8_t team_id);
-  bool condition_has_when_20_or_21(const Condition& cond) const;
+  bool condition_applies_on_sc_or_item_attack(const Condition& cond) const;
   size_t count_action_cards_with_condition_for_all_current_attacks(
       ConditionType cond_type, uint16_t card_ref) const;
   size_t count_action_cards_with_condition_for_current_attack(
@@ -189,7 +189,7 @@ public:
       uint16_t set_card_ref,
       uint16_t sc_card_ref,
       uint8_t random_percent,
-      uint8_t when) const;
+      EffectWhen when) const;
   int32_t evaluate_effect_expr(
       const AttackEnvStats& ast,
       const char* expr,
@@ -276,13 +276,13 @@ public:
       size_t* out_damage_count) const;
   void update_condition_orders(std::shared_ptr<Card> card);
   int16_t max_all_attack_bonuses(size_t* out_count) const;
-  void unknown_80244AA8(std::shared_ptr<Card> card);
+  void apply_effects_after_card_move(std::shared_ptr<Card> card);
   void check_for_defense_interference(
       std::shared_ptr<const Card> attacker_card,
       std::shared_ptr<Card> target_card,
       int16_t* inout_unknown_p4);
   void evaluate_and_apply_effects(
-      uint8_t when,
+      EffectWhen when,
       uint16_t set_card_ref,
       const ActionState& as,
       uint16_t sc_card_ref,
@@ -313,10 +313,10 @@ public:
       std::shared_ptr<const Card> card1,
       const Location& card1_loc,
       std::shared_ptr<const Card> card2) const;
-  void unknown_8024AAB8(const ActionState& as);
+  void apply_effects_after_attack_target_resolution(const ActionState& as);
   void move_phase_before_for_card(std::shared_ptr<Card> unknown_p2);
   void dice_phase_before_for_card(std::shared_ptr<Card> card);
-  template <uint8_t When1, uint8_t When2>
+  template <EffectWhen When1, EffectWhen When2>
   void apply_effects_on_phase_change_t(std::shared_ptr<Card> unknown_p2, const ActionState* existing_as = nullptr);
   void draw_phase_before_for_card(std::shared_ptr<Card> unknown_p2);
   void action_phase_before_for_card(std::shared_ptr<Card> unknown_p2);
@@ -325,10 +325,14 @@ public:
   static std::shared_ptr<Card> sc_card_for_card(std::shared_ptr<Card> unknown_p2);
   void unknown_8024A9D8(const ActionState& pa, uint16_t action_card_ref);
   void check_for_attack_interference(std::shared_ptr<Card> unknown_p2);
-  template <uint8_t When1, uint8_t When2, uint8_t When3, uint8_t When4>
-  void unknown_t2(std::shared_ptr<Card> unknown_p2);
-  void unknown_8024997C(std::shared_ptr<Card> card);
-  void unknown_8024A394(std::shared_ptr<Card> card);
+  template <
+      EffectWhen WhenAllCards,
+      EffectWhen WhenAttackerAndActionCards,
+      EffectWhen WhenAttackerOrHunterSCCard,
+      EffectWhen WhenTargetsAndActionCards>
+  void apply_effects_before_or_after_attack(std::shared_ptr<Card> unknown_p2);
+  void apply_effects_before_attack(std::shared_ptr<Card> card);
+  void apply_effects_after_attack(std::shared_ptr<Card> card);
   bool client_has_atk_dice_boost_condition(uint8_t client_id);
   void unknown_8024A6DC(
       std::shared_ptr<Card> unknown_p2, std::shared_ptr<Card> unknown_p3);

src/Episode3/DataIndexes.cc

@@ -109,8 +109,8 @@ bool Location::operator!=(const Location& other) const {
 }
 
 std::string Location::str() const {
-  return string_printf("Location[x=%hhu, y=%hhu, dir=%s, u=%hhu]",
-      this->x, this->y, name_for_enum(this->direction), this->unused);
+  return string_printf("Location[x=%hhu, y=%hhu, dir=%hhu:%s, u=%hhu]",
+      this->x, this->y, static_cast<uint8_t>(this->direction), name_for_enum(this->direction), this->unused);
 }
 
 void Location::clear() {
@@ -517,7 +517,7 @@ bool CardDefinition::Effect::is_empty() const {
   return (this->effect_num == 0 &&
       this->type == ConditionType::NONE &&
       this->expr.empty() &&
-      this->when == 0 &&
+      this->when == EffectWhen::NONE &&
       this->arg1.empty() &&
       this->arg2.empty() &&
       this->arg3.empty() &&
@@ -603,7 +603,7 @@ string CardDefinition::Effect::str(const char* separator, const TextSet* text_ar
   if (!this->expr.empty()) {
     tokens.emplace_back("expr=" + this->expr.decode());
   }
-  tokens.emplace_back(string_printf("when=%02hhX", this->when));
+  tokens.emplace_back(string_printf("when=%02hhX:%s", static_cast<uint8_t>(this->when), name_for_enum(this->when)));
   tokens.emplace_back("arg1=" + this->str_for_arg(this->arg1.decode()));
   tokens.emplace_back("arg2=" + this->str_for_arg(this->arg2.decode()));
   tokens.emplace_back("arg3=" + this->str_for_arg(this->arg3.decode()));
@@ -736,23 +736,23 @@ string name_for_rank(CardRank rank) {
   }
 }
 
-string name_for_target_mode(TargetMode target_mode) {
+const char* name_for_target_mode(TargetMode target_mode) {
   static const vector<const char*> names({
       "NONE",
-      "SINGLE",
-      "MULTI",
+      "SINGLE_RANGE",
+      "MULTI_RANGE",
       "SELF",
       "TEAM",
+      "EVERYONE",
+      "MULTI_RANGE_ALLIES",
+      "ALL_ALLIES",
       "ALL",
-      "MULTI-ALLY",
-      "ALL-ALLY",
-      "ALL-ATTACK",
-      "OWN-FCS",
+      "OWN_FCS",
   });
   try {
     return names.at(static_cast<uint8_t>(target_mode));
   } catch (const out_of_range&) {
-    return string_printf("(%02hhX)", static_cast<uint8_t>(target_mode));
+    return "__UNKNOWN__";
   }
 }
 
@@ -886,7 +886,7 @@ string CardDefinition::str(bool single_line, const TextSet* text_archive) const
   string criterion_str = name_for_enum(this->usable_criterion);
   string card_class_str = name_for_enum(this->card_class());
   string rank_str = name_for_rank(this->rank);
-  string target_mode_str = name_for_target_mode(this->target_mode);
+  const char* target_mode_str = name_for_target_mode(this->target_mode);
   string assist_turns_str = string_for_assist_turns(this->assist_turns);
   string hp_str = this->hp.str();
   string ap_str = this->ap.str();
@@ -937,7 +937,7 @@ string CardDefinition::str(bool single_line, const TextSet* text_archive) const
         criterion_str.c_str(),
         rank_str.c_str(),
         cost_str.c_str(),
-        target_mode_str.c_str(),
+        target_mode_str,
         range_str.c_str(),
         assist_turns_str.c_str(),
         this->cannot_move ? "true" : "false",
@@ -1004,7 +1004,7 @@ Card: %04" PRIX32 " \"%s\"\n\
         criterion_str.c_str(),
         rank_str.c_str(),
         cost_str.c_str(),
-        target_mode_str.c_str(),
+        target_mode_str,
         range_str.c_str(),
         assist_turns_str.c_str(),
         this->cannot_move ? "cannot" : "can",
@@ -1068,7 +1068,7 @@ JSON CardDefinition::Effect::json() const {
       {"EffectNum", this->effect_num},
       {"ConditionType", name_for_enum(this->type)},
       {"Expression", this->expr.decode()},
-      {"When", this->when},
+      {"When", name_for_enum(this->when)},
       {"Arg1", this->arg1.decode()},
       {"Arg2", this->arg2.decode()},
       {"Arg3", this->arg3.decode()},
@@ -1158,6 +1158,62 @@ void PlayerConfig::encrypt(uint8_t basis) {
   this->basis = basis;
 }
 
+PlayerConfigNTE::PlayerConfigNTE(const PlayerConfig& config)
+    : rank_text(config.rank_text),
+      unknown_a1(config.unknown_a1),
+      tech_menu_shortcut_entries(config.tech_menu_shortcut_entries),
+      choice_search_config(config.choice_search_config),
+      scenario_progress(config.scenario_progress),
+      unused_offline_records(config.unused_offline_records),
+      unknown_a4(config.unknown_a4),
+      is_encrypted(config.is_encrypted),
+      basis(config.basis),
+      unused(config.unused),
+      card_counts(config.card_counts),
+      card_count_checksums(config.card_count_checksums),
+      rare_tokens(config.rare_tokens),
+      decks(config.decks),
+      unknown_a8(config.unknown_a8),
+      offline_clv_exp(config.offline_clv_exp),
+      online_clv_exp(config.online_clv_exp),
+      recent_human_opponents(config.recent_human_opponents),
+      unknown_a10(config.unknown_a10),
+      init_timestamp(config.init_timestamp),
+      last_online_battle_start_timestamp(config.last_online_battle_start_timestamp),
+      unknown_t3(config.unknown_t3),
+      unknown_a14(config.unknown_a14) {
+  // TODO: Do we need to recompute card_count_checksums? (Here or in operator
+  // PlayerConfig?)
+}
+
+PlayerConfigNTE::operator PlayerConfig() const {
+  PlayerConfig ret;
+  ret.rank_text = this->rank_text;
+  ret.unknown_a1 = this->unknown_a1;
+  ret.tech_menu_shortcut_entries = this->tech_menu_shortcut_entries;
+  ret.choice_search_config = this->choice_search_config;
+  ret.scenario_progress = this->scenario_progress;
+  ret.unused_offline_records = this->unused_offline_records;
+  ret.unknown_a4 = this->unknown_a4;
+  ret.is_encrypted = this->is_encrypted;
+  ret.basis = this->basis;
+  ret.unused = this->unused;
+  ret.card_counts = this->card_counts;
+  ret.card_count_checksums = this->card_count_checksums;
+  ret.rare_tokens = this->rare_tokens;
+  ret.decks = this->decks;
+  ret.unknown_a8 = this->unknown_a8;
+  ret.offline_clv_exp = this->offline_clv_exp;
+  ret.online_clv_exp = this->online_clv_exp;
+  ret.recent_human_opponents = this->recent_human_opponents;
+  ret.unknown_a10 = this->unknown_a10;
+  ret.init_timestamp = this->init_timestamp;
+  ret.last_online_battle_start_timestamp = this->last_online_battle_start_timestamp;
+  ret.unknown_t3 = this->unknown_t3;
+  ret.unknown_a14 = this->unknown_a14;
+  return ret;
+}
+
 Rules::Rules(const JSON& json) {
   this->clear();
   this->overall_time_limit = json.get_int("overall_time_limit", this->overall_time_limit);
@@ -3117,6 +3173,78 @@ const char* name_for_enum<Episode3::ConditionType>(Episode3::ConditionType cond_
   }
 }
 
+template <>
+const char* name_for_enum<Episode3::EffectWhen>(Episode3::EffectWhen when) {
+  switch (when) {
+    case Episode3::EffectWhen::NONE:
+      return "NONE";
+    case Episode3::EffectWhen::CARD_SET:
+      return "CARD_SET";
+    case Episode3::EffectWhen::AFTER_ANY_CARD_ATTACK:
+      return "AFTER_ANY_CARD_ATTACK";
+    case Episode3::EffectWhen::BEFORE_ANY_CARD_ATTACK:
+      return "BEFORE_ANY_CARD_ATTACK";
+    case Episode3::EffectWhen::BEFORE_DICE_PHASE_THIS_TEAM_TURN:
+      return "BEFORE_DICE_PHASE_THIS_TEAM_TURN";
+    case Episode3::EffectWhen::CARD_DESTROYED:
+      return "CARD_DESTROYED";
+    case Episode3::EffectWhen::AFTER_SET_PHASE:
+      return "AFTER_SET_PHASE";
+    case Episode3::EffectWhen::BEFORE_MOVE_PHASE:
+      return "BEFORE_MOVE_PHASE";
+    case Episode3::EffectWhen::UNKNOWN_0A:
+      return "UNKNOWN_0A";
+    case Episode3::EffectWhen::AFTER_ATTACK_TARGET_RESOLUTION:
+      return "AFTER_ATTACK_TARGET_RESOLUTION";
+    case Episode3::EffectWhen::AFTER_THIS_CARD_ATTACK:
+      return "AFTER_THIS_CARD_ATTACK";
+    case Episode3::EffectWhen::BEFORE_THIS_CARD_ATTACK:
+      return "BEFORE_THIS_CARD_ATTACK";
+    case Episode3::EffectWhen::BEFORE_ACT_PHASE:
+      return "BEFORE_ACT_PHASE";
+    case Episode3::EffectWhen::BEFORE_DRAW_PHASE:
+      return "BEFORE_DRAW_PHASE";
+    case Episode3::EffectWhen::AFTER_CARD_MOVE:
+      return "AFTER_CARD_MOVE";
+    case Episode3::EffectWhen::UNKNOWN_15:
+      return "UNKNOWN_15";
+    case Episode3::EffectWhen::AFTER_THIS_CARD_ATTACKED:
+      return "AFTER_THIS_CARD_ATTACKED";
+    case Episode3::EffectWhen::BEFORE_THIS_CARD_ATTACKED:
+      return "BEFORE_THIS_CARD_ATTACKED";
+    case Episode3::EffectWhen::AFTER_CREATURE_OR_HUNTER_SC_ATTACK:
+      return "AFTER_CREATURE_OR_HUNTER_SC_ATTACK";
+    case Episode3::EffectWhen::BEFORE_CREATURE_OR_HUNTER_SC_ATTACK:
+      return "BEFORE_CREATURE_OR_HUNTER_SC_ATTACK";
+    case Episode3::EffectWhen::UNKNOWN_22:
+      return "UNKNOWN_22";
+    case Episode3::EffectWhen::BEFORE_MOVE_PHASE_AND_AFTER_CARD_MOVE_FINAL:
+      return "BEFORE_MOVE_PHASE_AND_AFTER_CARD_MOVE_FINAL";
+    case Episode3::EffectWhen::UNKNOWN_29:
+      return "UNKNOWN_29";
+    case Episode3::EffectWhen::UNKNOWN_2A:
+      return "UNKNOWN_2A";
+    case Episode3::EffectWhen::UNKNOWN_2B:
+      return "UNKNOWN_2B";
+    case Episode3::EffectWhen::UNKNOWN_33:
+      return "UNKNOWN_33";
+    case Episode3::EffectWhen::UNKNOWN_34:
+      return "UNKNOWN_34";
+    case Episode3::EffectWhen::UNKNOWN_35:
+      return "UNKNOWN_35";
+    case Episode3::EffectWhen::ATTACK_STAT_OVERRIDES:
+      return "ATTACK_STAT_OVERRIDES";
+    case Episode3::EffectWhen::ATTACK_DAMAGE_ADJUSTMENT:
+      return "ATTACK_DAMAGE_ADJUSTMENT";
+    case Episode3::EffectWhen::DEFENSE_DAMAGE_ADJUSTMENT:
+      return "DEFENSE_DAMAGE_ADJUSTMENT";
+    case Episode3::EffectWhen::BEFORE_DICE_PHASE_ALL_TURNS_FINAL:
+      return "BEFORE_DICE_PHASE_ALL_TURNS_FINAL";
+    default:
+      return "__INVALID__";
+  }
+}
+
 template <>
 const char* name_for_enum<Episode3::Direction>(Episode3::Direction d) {
   switch (d) {

src/Episode3/DataIndexes.hh

@@ -173,6 +173,8 @@ enum class TargetMode : uint8_t {
   OWN_FCS = 0x09, // e.g. Traitor
 };
 
+const char* name_for_target_mode(TargetMode target_mode);
+
 enum class ConditionType : uint8_t {
   NONE = 0x00,
   AP_BOOST = 0x01, // Temporarily increase AP by N
@@ -304,6 +306,41 @@ enum class ConditionType : uint8_t {
   ANY_FF = 0xFF, // Used as a wildcard in some search functions
 };
 
+enum class EffectWhen : uint8_t {
+  NONE = 0x00,
+  CARD_SET = 0x01, // Permanent effects like RAMPAGE/PIERCE on SCs, BIG_SWING, AERIAL, etc.; many AC effects also
+  AFTER_ANY_CARD_ATTACK = 0x02, // GIVE_DAMAGE, HEAL, A_H_SWAP_PERM
+  BEFORE_ANY_CARD_ATTACK = 0x03, // AP_LOSS, COMBO_TP
+  BEFORE_DICE_PHASE_THIS_TEAM_TURN = 0x04, // Many different effects
+  CARD_DESTROYED = 0x05, // RETURN_TO_HAND, RETURN, FILIAL, GIVE_OR_TAKE_EXP
+  AFTER_SET_PHASE = 0x06, // Unused
+  BEFORE_MOVE_PHASE = 0x09, // Unused
+  UNKNOWN_0A = 0x0A, // ANTI_ABNORMALITY_2 on Tollaw (non-SC version of another when?)
+  AFTER_ATTACK_TARGET_RESOLUTION = 0x0B, // ABILITY_TRAP via First Attack action card only
+  AFTER_THIS_CARD_ATTACK = 0x0C, // Many effects
+  BEFORE_THIS_CARD_ATTACK = 0x0D, // Conditions, AP_BOOST/TP_BOOST, AP_SILENCE, MULTI_STRIKE
+  BEFORE_ACT_PHASE = 0x0E, // Before act phase (ANTI_ABNORMALITY_2, FIXED_RANGE)
+  BEFORE_DRAW_PHASE = 0x0F, // Unused
+  AFTER_CARD_MOVE = 0x13, // Unused
+  UNKNOWN_15 = 0x15, // Unused
+  AFTER_THIS_CARD_ATTACKED = 0x16, // Conditions, DEATH_COMPANION, GIVE_DAMAGE, AP_GROWTH (Nidra)
+  BEFORE_THIS_CARD_ATTACKED = 0x17, // Defense damage adjustments
+  AFTER_CREATURE_OR_HUNTER_SC_ATTACK = 0x20, // RETURN_TO_HAND, A_T_SWAP_PERM, GIVE_OR_TAKE_EXP
+  BEFORE_CREATURE_OR_HUNTER_SC_ATTACK = 0x21, // Unused
+  UNKNOWN_22 = 0x22, // MISC_AP_BONUSES (SCs only?)
+  BEFORE_MOVE_PHASE_AND_AFTER_CARD_MOVE_FINAL = 0x27, // SET_MV
+  UNKNOWN_29 = 0x29, // MIGHTY_KNUCKLE
+  UNKNOWN_2A = 0x2A, // Unused
+  UNKNOWN_2B = 0x2B, // Unused
+  UNKNOWN_33 = 0x33, // DEF_DISABLE_BY_COST
+  UNKNOWN_34 = 0x34, // Unused
+  UNKNOWN_35 = 0x35, // Unused
+  ATTACK_STAT_OVERRIDES = 0x3D, // BONUS_FROM_LEADER, COPY, ABILITY_TRAP
+  ATTACK_DAMAGE_ADJUSTMENT = 0x3E, // AP_BOOST, SLAYERS_ASSASSINS, WEAK_SPOT_INFLUENCE, GROUP
+  DEFENSE_DAMAGE_ADJUSTMENT = 0x3F, // MOSTLY_HALFGUARDS, ACTION_DISRUPTER
+  BEFORE_DICE_PHASE_ALL_TURNS_FINAL = 0x46, // Pollux Timed Pierce
+};
+
 enum class AssistEffect : uint16_t {
   NONE = 0x0000,
   DICE_HALF = 0x0001,
@@ -486,7 +523,7 @@ struct CardDefinition {
     /* 02 */ pstring<TextEncoding::ASCII, 0x0F> expr;
     // when specifies in which phase the effect should activate.
     // TODO: There are many values that can be used here; document them.
-    /* 11 */ uint8_t when;
+    /* 11 */ EffectWhen when;
     // arg1 generally specifies how long the effect activates for.
     /* 12 */ pstring<TextEncoding::ASCII, 4> arg1;
     // arg2 generally specifies a condition for when the effect activates.
@@ -870,12 +907,12 @@ struct PlayerConfig {
   // card counts array is encrypted in memory most of the time, and they went
   // out of their way to ensure the game uses an area of memory that almost no
   // other game uses, which is also used by the Action Replay.)
-  /* 05A4:0450 */ parray<be_uint64_t, 0x1C2> rare_tokens;
+  /* 05A4:0450 */ parray<be_uint64_t, 450> rare_tokens;
   /* 13B4:1260 */ parray<uint8_t, 0x80> unknown_a7;
   /* 1434:12E0 */ parray<DeckDefinition, 25> decks;
   /* 2118:1FC4 */ parray<uint8_t, 0x08> unknown_a8;
-  /* 2120:1FCC */ be_uint32_t offline_clv_exp; // CLvOff = this / 100
-  /* 2124:1FD0 */ be_uint32_t online_clv_exp; // CLvOn = this / 100
+  /* 2120:1FCC */ be_uint32_t offline_clv_exp; // CLvOff = (this / 100) + 1
+  /* 2124:1FD0 */ be_uint32_t online_clv_exp; // CLvOn = (this / 100) + 1
   struct PlayerReference {
     /* 00 */ be_uint32_t guild_card_number;
     /* 04 */ pstring<TextEncoding::MARKED, 0x18> name;
@@ -904,6 +941,40 @@ struct PlayerConfig {
   void encrypt(uint8_t basis);
 } __packed_ws__(PlayerConfig, 0x2350);
 
+struct PlayerConfigNTE {
+  /* 0000 */ pstring<TextEncoding::MARKED, 12> rank_text;
+  /* 000C */ parray<uint8_t, 0x1C> unknown_a1;
+  /* 0028 */ parray<be_uint16_t, 20> tech_menu_shortcut_entries;
+  /* 0050 */ parray<be_uint32_t, 10> choice_search_config;
+  /* 0078 */ parray<be_uint32_t, 0x10> scenario_progress; // Final has 0x30 entries here
+  /* 00B8 */ PlayerRecordsBattleBE unused_offline_records;
+  /* 00D0 */ parray<uint8_t, 4> unknown_a4;
+  /* 00D4 */ uint8_t is_encrypted;
+  /* 00D5 */ uint8_t basis;
+  /* 00D6 */ parray<uint8_t, 2> unused;
+  /* 00D8 */ parray<uint8_t, 1000> card_counts;
+  /* 04C0 */ parray<be_uint16_t, 50> card_count_checksums;
+  /* 0524 */ parray<be_uint64_t, 300> rare_tokens;
+  /* 0E84 */ parray<DeckDefinition, 25> decks;
+  /* 1B68 */ parray<uint8_t, 0x08> unknown_a8;
+  /* 1B70 */ be_uint32_t offline_clv_exp;
+  /* 1B74 */ be_uint32_t online_clv_exp;
+  /* 1B78 */ parray<PlayerConfig::PlayerReference, 10> recent_human_opponents;
+  /* 1C90 */ parray<uint8_t, 0x28> unknown_a10;
+  /* 1CB8 */ be_uint32_t init_timestamp;
+  /* 1CBC */ be_uint32_t last_online_battle_start_timestamp;
+  /* 1CC0 */ be_uint32_t unknown_t3;
+  /* 1CC4 */ parray<uint8_t, 0x94> unknown_a14;
+  /* 1D58 */
+
+  PlayerConfigNTE() = default;
+  explicit PlayerConfigNTE(const PlayerConfig& config);
+  operator PlayerConfig() const;
+
+  void decrypt();
+  void encrypt(uint8_t basis);
+} __packed_ws__(PlayerConfigNTE, 0x1D58);
+
 enum class HPType : uint8_t {
   DEFEAT_PLAYER = 0,
   DEFEAT_TEAM = 1,
@@ -1575,4 +1646,6 @@ const char* name_for_enum<Episode3::CardClass>(Episode3::CardClass cc);
 template <>
 const char* name_for_enum<Episode3::ConditionType>(Episode3::ConditionType cond_type);
 template <>
+const char* name_for_enum<Episode3::EffectWhen>(Episode3::EffectWhen when);
+template <>
 const char* name_for_enum<Episode3::Direction>(Episode3::Direction d);

src/Episode3/PlayerState.cc

@@ -1003,7 +1003,7 @@ bool PlayerState::move_card_to_location_by_card_index(size_t card_index, const L
   this->send_6xB4x04_if_needed();
   s->send_6xB4x05();
   s->send_6xB4x39();
-  s->card_special->unknown_80244AA8(card);
+  s->card_special->apply_effects_after_card_move(card);
   return true;
 }
 

src/Episode3/RulerServer.cc

@@ -2,6 +2,7 @@
 
 #include <optional>
 
+#include "DataIndexes.hh"
 #include "Server.hh"
 
 using namespace std;
@@ -1469,36 +1470,52 @@ bool RulerServer::compute_effective_range_and_target_mode_for_attack(
     uint16_t* out_effective_card_id,
     TargetMode* out_effective_target_mode,
     uint16_t* out_orig_card_ref) const {
+  auto s = this->server();
+  bool is_nte = s->options.is_nte();
+  auto log = s->log_stack("compute_effective_range_and_target_mode_for_attack: ");
+
   size_t z;
   for (z = 0; (z < 8) && (pa.action_card_refs[z] != 0xFFFF); z++) {
   }
   if (z >= 8) {
+    log.debug("too many action card refs");
     return false;
   }
+  log.debug("%zu action card refs", z);
   uint16_t card_ref = (z == 0) ? pa.attacker_card_ref : pa.action_card_refs[z - 1];
+  log.debug("base card ref = @%04hX", card_ref);
 
   uint16_t card_id = this->card_id_for_card_ref(card_ref);
   if (card_id == 0xFFFF) {
+    log.debug("card ref is broken");
     return false;
   }
 
   auto ce = this->definition_for_card_id(card_id);
   uint8_t client_id = client_id_for_card_ref(pa.attacker_card_ref);
   if ((client_id == 0xFF) || !ce) {
+    log.debug("card ref is broken or definition is missing");
     return false;
   }
 
   if (out_orig_card_ref) {
+    log.debug("orig_card_ref = @%04hX", card_ref);
     *out_orig_card_ref = card_ref;
   }
 
   auto target_mode = ce->def.target_mode;
   if (this->card_ref_or_sc_has_fixed_range(pa.attacker_card_ref)) {
+    const char* target_mode_name = name_for_target_mode(target_mode);
+    log.debug("attacker card ref @%04hX has fixed range; target mode is %s (%hhu)",
+        pa.attacker_card_ref.load(), target_mode_name, static_cast<uint8_t>(target_mode));
     card_id = this->card_id_for_card_ref(pa.attacker_card_ref);
-    if (!this->server()->options.is_nte()) {
+    if (!is_nte) {
       auto sc_ce = this->definition_for_card_id(card_id);
       if (sc_ce && (static_cast<uint8_t>(target_mode) < 6)) {
         target_mode = sc_ce->def.target_mode;
+        const char* target_mode_name = name_for_target_mode(target_mode);
+        log.debug("sc_ce overrides target mode with %s (%hhu)",
+            target_mode_name, static_cast<uint8_t>(target_mode));
       }
     }
   }
@@ -1508,8 +1525,10 @@ bool RulerServer::compute_effective_range_and_target_mode_for_attack(
     auto assist_effect = this->assist_server->get_active_assist_by_index(z);
     if (assist_effect == AssistEffect::SIMPLE) {
       card_id = this->card_id_for_card_ref(pa.attacker_card_ref);
+      log.debug("SIMPLE assist overrides card id with #%04hX", card_id);
     } else if (assist_effect == AssistEffect::HEAVY_FOG) {
       card_id = 0xFFFE;
+      log.debug("HEAVY_FOG assist overrides card id with #%04hX", card_id);
     }
   }
 
@@ -2040,21 +2059,27 @@ shared_ptr<const CardIndex::CardEntry> RulerServer::definition_for_card_id(uint3
 
 uint32_t RulerServer::get_card_id_with_effective_range(
     uint16_t card_ref, uint16_t card_id_override, TargetMode* out_target_mode) const {
+  auto log = this->server()->log_stack(string_printf("get_card_id_with_effective_range(@%04hX, #%04hX): ", card_ref, card_id_override));
+
   uint16_t card_id = (card_id_override == 0xFFFF)
       ? this->card_id_for_card_ref(card_ref)
       : card_id_override;
+  log.debug("card_id=#%04hX", card_id);
 
   if (card_id != 0xFFFF) {
     auto ce = this->definition_for_card_id(card_id);
     uint8_t client_id = client_id_for_card_ref(card_ref);
     if ((client_id != 0xFF) && ce) {
       TargetMode effective_target_mode = ce->def.target_mode;
+      log.debug("ce valid for #%04hX with effective target mode %s", card_id, name_for_target_mode(effective_target_mode));
 
       if (this->card_ref_or_sc_has_fixed_range(card_ref)) {
         // Undo the override that may have been passed in
-        auto ce = this->definition_for_card_id(this->card_id_for_card_ref(card_ref));
-        if (ce && (static_cast<uint8_t>(effective_target_mode) < 6)) {
-          effective_target_mode = ce->def.target_mode;
+        log.debug("@%04hX has FIXED_RANGE", card_ref);
+        auto orig_ce = this->definition_for_card_id(this->card_id_for_card_ref(card_ref));
+        if (orig_ce && (static_cast<uint8_t>(effective_target_mode) < 6)) {
+          log.debug("ce valid for #%04hX with effective target mode %s; overriding to %s", card_id, name_for_target_mode(effective_target_mode), name_for_target_mode(orig_ce->def.target_mode));
+          effective_target_mode = orig_ce->def.target_mode;
         }
       }
 
@@ -2063,14 +2088,17 @@ uint32_t RulerServer::get_card_id_with_effective_range(
         auto eff = this->assist_server->get_active_assist_by_index(z);
         if (eff == AssistEffect::SIMPLE) {
           card_id = this->card_id_for_card_ref(card_ref);
+          log.debug("SIMPLE assist effect is active; using #%04hX for range", card_id);
         } else if (eff == AssistEffect::HEAVY_FOG) {
           card_id = 0xFFFE;
+          log.debug("HEAVY_FOG assist effect is active; limiting range to one tile in front");
         }
       }
 
       if (out_target_mode) {
         *out_target_mode = effective_target_mode;
       }
+      log.debug("results: card_id=#%04hX, target_mode=%s", card_id, name_for_target_mode(effective_target_mode));
     }
   }
 

src/Episode3/Server.cc

@@ -30,7 +30,7 @@ void Server::PresenceEntry::clear() {
 
 Server::Server(shared_ptr<Lobby> lobby, Options&& options)
     : lobby(lobby),
-      battle_record(lobby->battle_record),
+      battle_record(lobby ? lobby->battle_record : nullptr),
       has_lobby(lobby != nullptr),
       options(std::move(options)),
       last_chosen_map(this->options.tournament ? this->options.tournament->get_map() : nullptr),
@@ -260,7 +260,7 @@ void Server::send(const void* data, size_t size, uint8_t command, bool enable_ma
 
   } else if ((this->options.behavior_flags & BehaviorFlag::LOG_COMMANDS_IF_LOBBY_MISSING) &&
       this->log().info("Generated command")) {
-    print_data(stderr, data, size);
+    print_data(stderr, data, size, 0, nullptr, PrintDataFlags::PRINT_ASCII | PrintDataFlags::DISABLE_COLOR | PrintDataFlags::OFFSET_16_BITS);
   }
 }
 
@@ -1075,7 +1075,13 @@ shared_ptr<const PlayerState> Server::get_player_state(uint8_t client_id) const
 }
 
 uint32_t Server::get_random_raw() {
-  le_uint32_t ret = random_from_optional_crypt(this->options.opt_rand_crypt);
+  le_uint32_t ret;
+  if (this->options.opt_rand_stream) {
+    this->options.opt_rand_stream->readx(&ret, sizeof(ret));
+  } else {
+    ret = random_from_optional_crypt(this->options.opt_rand_crypt);
+  }
+
   if (this->battle_record && this->battle_record->writable()) {
     this->battle_record->add_random_data(&ret, sizeof(ret));
   }
@@ -1456,12 +1462,12 @@ void Server::set_phase_after() {
     if (ps) {
       auto card = ps->get_sc_card();
       if (card) {
-        this->card_special->apply_action_conditions(0x06, nullptr, card, is_nte ? 0x1F : 0x04, nullptr);
+        this->card_special->apply_action_conditions(EffectWhen::AFTER_SET_PHASE, nullptr, card, is_nte ? 0x1F : 0x04, nullptr);
       }
       for (size_t set_index = 0; set_index < 8; set_index++) {
         auto card = ps->get_set_card(set_index);
         if (card) {
-          this->card_special->apply_action_conditions(0x06, nullptr, card, is_nte ? 0x1F : 0x04, nullptr);
+          this->card_special->apply_action_conditions(EffectWhen::AFTER_SET_PHASE, nullptr, card, is_nte ? 0x1F : 0x04, nullptr);
         }
       }
     }
@@ -2863,7 +2869,7 @@ void Server::unknown_8023EEF4() {
     ActionState as = cmd.state;
     this->send(cmd);
 
-    this->card_special->unknown_8024AAB8(as);
+    this->card_special->apply_effects_after_attack_target_resolution(as);
 
     if (!is_nte) {
       this->attack_cards[this->unknown_a14]->compute_action_chain_results(1, 0);

src/Episode3/Server.hh

@@ -72,6 +72,7 @@ public:
     std::shared_ptr<const CardIndex> card_index;
     std::shared_ptr<const MapIndex> map_index;
     uint32_t behavior_flags;
+    std::shared_ptr<StringReader> opt_rand_stream;
     std::shared_ptr<PSOLFGEncryption> opt_rand_crypt;
     std::shared_ptr<const Tournament> tournament;
     std::array<std::vector<uint16_t>, 5> trap_card_ids;

src/EventUtils.hh

@@ -9,8 +9,12 @@
 #include <optional>
 #include <stdexcept>
 
+// Calls a function on the given base's event thread. This function returns
+// when the call has been enqueued, not necessarily after it returns.
 void forward_to_event_thread(std::shared_ptr<struct event_base> base, std::function<void()>&& fn);
 
+// Calls a function on the given base's event thread and waits for it to
+// return. Returns the value returned on that thread.
 template <typename T>
 T call_on_event_thread(std::shared_ptr<struct event_base> base, std::function<T()>&& compute) {
   std::optional<T> ret;

src/FunctionCompiler.hh

@@ -1,99 +1,101 @@
-#pragma once
-
-#include <inttypes.h>
-
-#include <map>
-#include <memory>
-#include <string>
-#include <unordered_map>
-#include <unordered_set>
-#include <vector>
-
-#include "Menu.hh"
-
-bool function_compiler_available();
-void set_function_compiler_available(bool is_available);
-
-// TODO: Support x86 and SH4 function calls in the future. Currently we only
-// support PPC32 because I haven't written an appropriate x86 assembler yet.
-
-struct CompiledFunctionCode {
-  enum class Architecture {
-    UNKNOWN = 0,
-    POWERPC, // GC
-    X86, // PC, XB, BB
-    SH4, // Dreamcast
-  };
-  Architecture arch;
-  std::string code;
-  std::vector<uint16_t> relocation_deltas;
-  std::unordered_map<std::string, uint32_t> label_offsets;
-  uint32_t entrypoint_offset_offset;
-  std::string source_path; // Path to source file from newserv root
-  std::string short_name; // Based on filename
-  std::string long_name; // From .meta name directive
-  std::string description; // From .meta description directive
-  uint8_t index; // 0 = unused (not registered in index_to_function)
-  uint32_t menu_item_id;
-  bool hide_from_patches_menu;
-  uint32_t specific_version;
-
-  bool is_big_endian() const;
-
-  template <typename FooterT>
-  std::string generate_client_command_t(
-      const std::unordered_map<std::string, uint32_t>& label_writes,
-      const std::string& suffix,
-      uint32_t override_relocations_offset = 0) const;
-  std::string generate_client_command(
-      const std::unordered_map<std::string, uint32_t>& label_writes = {},
-      const std::string& suffix = "",
-      uint32_t override_relocations_offset = 0) const;
-};
-
-const char* name_for_architecture(CompiledFunctionCode::Architecture arch);
-
-std::shared_ptr<CompiledFunctionCode> compile_function_code(
-    CompiledFunctionCode::Architecture arch,
-    const std::string& directory,
-    const std::string& name,
-    const std::string& text);
-
-struct FunctionCodeIndex {
-  FunctionCodeIndex() = default;
-  explicit FunctionCodeIndex(const std::string& directory);
-
-  std::unordered_map<std::string, std::shared_ptr<CompiledFunctionCode>> name_to_function;
-  std::unordered_map<uint8_t, std::shared_ptr<CompiledFunctionCode>> index_to_function;
-  std::unordered_map<uint64_t, std::shared_ptr<CompiledFunctionCode>> menu_item_id_and_specific_version_to_patch_function;
-  // Key here is e.g. "PATCHNAME-SPECIFICVERSION", with the latter in hex
-  std::map<std::string, std::shared_ptr<CompiledFunctionCode>> name_and_specific_version_to_patch_function;
-
-  std::shared_ptr<const Menu> patch_menu(uint32_t specific_version) const;
-  std::shared_ptr<const Menu> patch_switches_menu(uint32_t specific_version, const std::unordered_set<std::string>& auto_patches_enabled) const;
-  bool patch_menu_empty(uint32_t specific_version) const;
-
-  std::shared_ptr<const CompiledFunctionCode> get_patch(const std::string& name, uint32_t specific_version) const;
-};
-
-struct DOLFileIndex {
-  struct File {
-    uint32_t menu_item_id;
-    std::string name;
-    std::string data;
-    bool is_compressed;
-  };
-
-  std::vector<std::shared_ptr<File>> item_id_to_file;
-  std::unordered_map<std::string, std::shared_ptr<File>> name_to_file;
-  std::shared_ptr<const Menu> menu;
-
-  DOLFileIndex() = default;
-  explicit DOLFileIndex(const std::string& directory);
-
-  inline bool empty() const {
-    return this->name_to_file.empty() && this->item_id_to_file.empty();
-  }
-};
-
-uint32_t specific_version_for_gc_header_checksum(uint32_t header_checksum);
+#pragma once
+
+#include <inttypes.h>
+
+#include <map>
+#include <memory>
+#include <string>
+#include <unordered_map>
+#include <unordered_set>
+#include <vector>
+
+#include "Menu.hh"
+
+bool function_compiler_available();
+void set_function_compiler_available(bool is_available);
+
+// TODO: Support x86 and SH4 function calls in the future. Currently we only
+// support PPC32 because I haven't written an appropriate x86 assembler yet.
+
+struct CompiledFunctionCode {
+  enum class Architecture {
+    UNKNOWN = 0,
+    POWERPC, // GC
+    X86, // PC, XB, BB
+    SH4, // Dreamcast
+  };
+  Architecture arch;
+  std::string code;
+  std::vector<uint16_t> relocation_deltas;
+  std::unordered_map<std::string, uint32_t> label_offsets;
+  uint32_t entrypoint_offset_offset;
+  std::string source_path; // Path to source file from newserv root
+  std::string short_name; // Based on filename
+  std::string long_name; // From .meta name directive
+  std::string description; // From .meta description directive
+  uint8_t index; // 0 = unused (not registered in index_to_function)
+  uint32_t menu_item_id;
+  bool hide_from_patches_menu;
+  uint32_t specific_version;
+
+  bool is_big_endian() const;
+
+  template <typename FooterT>
+  std::string generate_client_command_t(
+      const std::unordered_map<std::string, uint32_t>& label_writes,
+      const void* suffix_data = nullptr,
+      size_t suffix_size = 0,
+      uint32_t override_relocations_offset = 0) const;
+  std::string generate_client_command(
+      const std::unordered_map<std::string, uint32_t>& label_writes = {},
+      const void* suffix_data = nullptr,
+      size_t suffix_size = 0,
+      uint32_t override_relocations_offset = 0) const;
+};
+
+const char* name_for_architecture(CompiledFunctionCode::Architecture arch);
+
+std::shared_ptr<CompiledFunctionCode> compile_function_code(
+    CompiledFunctionCode::Architecture arch,
+    const std::string& directory,
+    const std::string& name,
+    const std::string& text);
+
+struct FunctionCodeIndex {
+  FunctionCodeIndex() = default;
+  explicit FunctionCodeIndex(const std::string& directory);
+
+  std::unordered_map<std::string, std::shared_ptr<CompiledFunctionCode>> name_to_function;
+  std::unordered_map<uint8_t, std::shared_ptr<CompiledFunctionCode>> index_to_function;
+  std::unordered_map<uint64_t, std::shared_ptr<CompiledFunctionCode>> menu_item_id_and_specific_version_to_patch_function;
+  // Key here is e.g. "PATCHNAME-SPECIFICVERSION", with the latter in hex
+  std::map<std::string, std::shared_ptr<CompiledFunctionCode>> name_and_specific_version_to_patch_function;
+
+  std::shared_ptr<const Menu> patch_menu(uint32_t specific_version) const;
+  std::shared_ptr<const Menu> patch_switches_menu(uint32_t specific_version, const std::unordered_set<std::string>& auto_patches_enabled) const;
+  bool patch_menu_empty(uint32_t specific_version) const;
+
+  std::shared_ptr<const CompiledFunctionCode> get_patch(const std::string& name, uint32_t specific_version) const;
+};
+
+struct DOLFileIndex {
+  struct File {
+    uint32_t menu_item_id;
+    std::string name;
+    std::string data;
+    bool is_compressed;
+  };
+
+  std::vector<std::shared_ptr<File>> item_id_to_file;
+  std::unordered_map<std::string, std::shared_ptr<File>> name_to_file;
+  std::shared_ptr<const Menu> menu;
+
+  DOLFileIndex() = default;
+  explicit DOLFileIndex(const std::string& directory);
+
+  inline bool empty() const {
+    return this->name_to_file.empty() && this->item_id_to_file.empty();
+  }
+};
+
+uint32_t specific_version_for_gc_header_checksum(uint32_t header_checksum);

src/HTTPServer.hh

@@ -1,76 +1,114 @@
-#pragma once
-
-#include <event2/buffer.h>
-#include <event2/event.h>
-#include <event2/http.h>
-#include <stdlib.h>
-
-#include <memory>
-#include <string>
-
-#include "ProxyServer.hh"
-#include "ServerState.hh"
-
-class HTTPServer {
-public:
-  HTTPServer(std::shared_ptr<ServerState> state);
-  HTTPServer(const HTTPServer&) = delete;
-  HTTPServer(HTTPServer&&) = delete;
-  HTTPServer& operator=(const HTTPServer&) = delete;
-  HTTPServer& operator=(HTTPServer&&) = delete;
-  virtual ~HTTPServer() = default;
-
-  void listen(const std::string& socket_path);
-  void listen(const std::string& addr, int port);
-  void listen(int port);
-  void add_socket(int fd);
-
-  void schedule_stop();
-  void wait_for_stop();
-
-protected:
-  class http_error : public std::runtime_error {
-  public:
-    http_error(int code, const std::string& what);
-    int code;
-  };
-
-  std::shared_ptr<ServerState> state;
-  std::shared_ptr<struct event_base> base;
-  std::shared_ptr<struct evhttp> http;
-  std::thread th;
-
-  void thread_fn();
-
-  static void dispatch_handle_request(struct evhttp_request* req, void* ctx);
-  void handle_request(struct evhttp_request* req);
-
-  static const std::unordered_map<int, const char*> explanation_for_response_code;
-  static void send_response(struct evhttp_request* req, int code, const char* content_type, struct evbuffer* b);
-  static void send_response(struct evhttp_request* req, int code, const char* content_type, const char* fmt, ...);
-
-  static std::unordered_multimap<std::string, std::string> parse_url_params(const std::string& query);
-  static std::unordered_map<std::string, std::string> parse_url_params_unique(const std::string& query);
-  static const std::string& get_url_param(
-      const std::unordered_multimap<std::string, std::string>& params,
-      const std::string& key,
-      const std::string* _default = nullptr);
-
-  static JSON generate_quest_json_st(std::shared_ptr<const Quest> q);
-  static JSON generate_client_config_json_st(const Client::Config& config);
-  static JSON generate_account_json_st(std::shared_ptr<const Account> a);
-  static JSON generate_game_client_json_st(std::shared_ptr<const Client> c, std::shared_ptr<const ItemNameIndex> item_name_index);
-  static JSON generate_proxy_client_json_st(std::shared_ptr<const ProxyServer::LinkedSession> ses);
-  static JSON generate_lobby_json_st(std::shared_ptr<const Lobby> l, std::shared_ptr<const ItemNameIndex> item_name_index);
-  JSON generate_game_server_clients_json() const;
-  JSON generate_proxy_server_clients_json() const;
-  JSON generate_server_info_json() const;
-  JSON generate_lobbies_json() const;
-  JSON generate_summary_json() const;
-  JSON generate_all_json() const;
-
-  JSON generate_ep3_cards_json(bool trial) const;
-  JSON generate_common_tables_json() const;
-  JSON generate_rare_tables_json() const;
-  JSON generate_rare_table_json(const std::string& table_name) const;
-};
+#pragma once
+
+#include <event2/buffer.h>
+#include <event2/event.h>
+#include <event2/http.h>
+#include <stdlib.h>
+
+#include <memory>
+#include <string>
+
+#include "ProxyServer.hh"
+#include "ServerState.hh"
+
+class HTTPServer {
+public:
+  HTTPServer(std::shared_ptr<ServerState> state);
+  HTTPServer(const HTTPServer&) = delete;
+  HTTPServer(HTTPServer&&) = delete;
+  HTTPServer& operator=(const HTTPServer&) = delete;
+  HTTPServer& operator=(HTTPServer&&) = delete;
+  virtual ~HTTPServer() = default;
+
+  void listen(const std::string& socket_path);
+  void listen(const std::string& addr, int port);
+  void listen(int port);
+  void add_socket(int fd);
+
+  void schedule_stop();
+  void wait_for_stop();
+
+  void send_rare_drop_notification(std::shared_ptr<const JSON> message);
+
+protected:
+  class http_error : public std::runtime_error {
+  public:
+    http_error(int code, const std::string& what);
+    int code;
+  };
+
+  struct WebsocketClient {
+    struct evhttp_connection* conn;
+    struct bufferevent* bev;
+
+    uint8_t pending_opcode;
+    std::string pending_data;
+
+    uint64_t last_communication_time;
+
+    void* context;
+
+    WebsocketClient(struct evhttp_connection* conn);
+    ~WebsocketClient();
+
+    void reset_pending_frame();
+  };
+
+  std::shared_ptr<ServerState> state;
+  std::shared_ptr<struct event_base> base;
+  std::shared_ptr<struct evhttp> http;
+  std::thread th;
+
+  std::unordered_set<std::shared_ptr<WebsocketClient>> rare_drop_subscribers;
+
+  std::unordered_map<struct bufferevent*, std::shared_ptr<WebsocketClient>> bev_to_websocket_client;
+
+  std::shared_ptr<WebsocketClient> enable_websockets(struct evhttp_request* req);
+
+  static void dispatch_on_websocket_read(struct bufferevent* bev, void* ctx);
+  static void dispatch_on_websocket_error(struct bufferevent* bev, short events, void* ctx);
+
+  void on_websocket_read(struct bufferevent* bev);
+  void on_websocket_error(struct bufferevent* bev, short events);
+
+  void disconnect_websocket_client(struct bufferevent* bev);
+  void send_websocket_message(struct bufferevent* bev, const std::string& message, uint8_t opcode = 0x01);
+  void send_websocket_message(std::shared_ptr<WebsocketClient> c, const std::string& message, uint8_t opcode = 0x01);
+
+  virtual void handle_websocket_message(std::shared_ptr<WebsocketClient> c, uint8_t opcode, const std::string& message);
+  virtual void handle_websocket_disconnect(std::shared_ptr<WebsocketClient> c);
+
+  void thread_fn();
+
+  static void dispatch_handle_request(struct evhttp_request* req, void* ctx);
+  void handle_request(struct evhttp_request* req);
+
+  static const std::unordered_map<int, const char*> explanation_for_response_code;
+  static void send_response(struct evhttp_request* req, int code, const char* content_type, struct evbuffer* b);
+  static void send_response(struct evhttp_request* req, int code, const char* content_type, const char* fmt, ...);
+
+  static std::unordered_multimap<std::string, std::string> parse_url_params(const std::string& query);
+  static std::unordered_map<std::string, std::string> parse_url_params_unique(const std::string& query);
+  static const std::string& get_url_param(
+      const std::unordered_multimap<std::string, std::string>& params,
+      const std::string& key,
+      const std::string* _default = nullptr);
+
+  static JSON generate_quest_json_st(std::shared_ptr<const Quest> q);
+  static JSON generate_client_config_json_st(const Client::Config& config);
+  static JSON generate_account_json_st(std::shared_ptr<const Account> a);
+  static JSON generate_game_client_json_st(std::shared_ptr<const Client> c, std::shared_ptr<const ItemNameIndex> item_name_index);
+  static JSON generate_proxy_client_json_st(std::shared_ptr<const ProxyServer::LinkedSession> ses);
+  static JSON generate_lobby_json_st(std::shared_ptr<const Lobby> l, std::shared_ptr<const ItemNameIndex> item_name_index);
+  JSON generate_game_server_clients_json() const;
+  JSON generate_proxy_server_clients_json() const;
+  JSON generate_server_info_json() const;
+  JSON generate_lobbies_json() const;
+  JSON generate_summary_json() const;
+  JSON generate_all_json() const;
+
+  JSON generate_ep3_cards_json(bool trial) const;
+  JSON generate_common_tables_json() const;
+  JSON generate_rare_tables_json() const;
+  JSON generate_rare_table_json(const std::string& table_name) const;
+};

src/IPV4RangeSet.cc

@@ -1,73 +1,73 @@
-#include "IPV4RangeSet.hh"
-
-#include <arpa/inet.h>
-
-using namespace std;
-
-IPV4RangeSet::IPV4RangeSet(const JSON& json) {
-  for (const auto& it : json.as_list()) {
-    // String should be of the form a.b.c.d or a.b.c.d/e
-    auto tokens = split(it->as_string(), '/');
-
-    size_t mask_bits;
-    if (tokens.size() == 1) {
-      mask_bits = 32;
-    } else if (tokens.size() == 2) {
-      mask_bits = stoul(tokens[1], nullptr, 10);
-      if (mask_bits > 32) {
-        throw runtime_error("invalid IPv4 address range");
-      }
-    } else {
-      throw runtime_error("invalid IPv4 address range");
-    }
-
-    auto addr_tokens = split(tokens[0], '.');
-    if (addr_tokens.size() != 4) {
-      throw runtime_error("invalid IPv4 address");
-    }
-    uint32_t addr = 0;
-    for (size_t z = 0; z < 4; z++) {
-      size_t end_pos = 0;
-      size_t new_byte = stoul(addr_tokens[z], &end_pos, 10);
-      if (end_pos != addr_tokens[z].size() || new_byte > 0xFF) {
-        throw runtime_error("invalid IPv4 address");
-      }
-      addr = (addr << 8) | new_byte;
-    }
-    addr &= (0xFFFFFFFF << (32 - mask_bits));
-
-    this->ranges.emplace(addr, mask_bits);
-  }
-}
-
-JSON IPV4RangeSet::json() const {
-  auto ret = JSON::list();
-  for (const auto& it : this->ranges) {
-    uint32_t addr = it.first;
-    uint8_t mask_bits = it.second;
-    ret.emplace_back(string_printf("%hhu.%hhu.%hhu.%hhu/%hhu",
-        static_cast<uint8_t>((addr >> 24) & 0xFF),
-        static_cast<uint8_t>((addr >> 16) & 0xFF),
-        static_cast<uint8_t>((addr >> 8) & 0xFF),
-        static_cast<uint8_t>(addr & 0xFF),
-        mask_bits));
-  }
-  return ret;
-}
-
-bool IPV4RangeSet::check(uint32_t addr) const {
-  auto it = this->ranges.upper_bound(addr);
-  if (it == this->ranges.begin()) {
-    return false; // addr is before any range
-  }
-  const auto& range = *(--it);
-  return (((range.first ^ addr) & (0xFFFFFFFF << (32 - range.second))) == 0);
-}
-
-bool IPV4RangeSet::check(const struct sockaddr_storage& ss) const {
-  if (ss.ss_family != AF_INET) {
-    return false;
-  }
-  const sockaddr_in* sin = reinterpret_cast<const sockaddr_in*>(&ss);
-  return this->check(ntohl(sin->sin_addr.s_addr));
-}
+#include "IPV4RangeSet.hh"
+
+#include <arpa/inet.h>
+
+using namespace std;
+
+IPV4RangeSet::IPV4RangeSet(const JSON& json) {
+  for (const auto& it : json.as_list()) {
+    // String should be of the form a.b.c.d or a.b.c.d/e
+    auto tokens = split(it->as_string(), '/');
+
+    size_t mask_bits;
+    if (tokens.size() == 1) {
+      mask_bits = 32;
+    } else if (tokens.size() == 2) {
+      mask_bits = stoul(tokens[1], nullptr, 10);
+      if (mask_bits > 32) {
+        throw runtime_error("invalid IPv4 address range");
+      }
+    } else {
+      throw runtime_error("invalid IPv4 address range");
+    }
+
+    auto addr_tokens = split(tokens[0], '.');
+    if (addr_tokens.size() != 4) {
+      throw runtime_error("invalid IPv4 address");
+    }
+    uint32_t addr = 0;
+    for (size_t z = 0; z < 4; z++) {
+      size_t end_pos = 0;
+      size_t new_byte = stoul(addr_tokens[z], &end_pos, 10);
+      if (end_pos != addr_tokens[z].size() || new_byte > 0xFF) {
+        throw runtime_error("invalid IPv4 address");
+      }
+      addr = (addr << 8) | new_byte;
+    }
+    addr &= (0xFFFFFFFF << (32 - mask_bits));
+
+    this->ranges.emplace(addr, mask_bits);
+  }
+}
+
+JSON IPV4RangeSet::json() const {
+  auto ret = JSON::list();
+  for (const auto& it : this->ranges) {
+    uint32_t addr = it.first;
+    uint8_t mask_bits = it.second;
+    ret.emplace_back(string_printf("%hhu.%hhu.%hhu.%hhu/%hhu",
+        static_cast<uint8_t>((addr >> 24) & 0xFF),
+        static_cast<uint8_t>((addr >> 16) & 0xFF),
+        static_cast<uint8_t>((addr >> 8) & 0xFF),
+        static_cast<uint8_t>(addr & 0xFF),
+        mask_bits));
+  }
+  return ret;
+}
+
+bool IPV4RangeSet::check(uint32_t addr) const {
+  auto it = this->ranges.upper_bound(addr);
+  if (it == this->ranges.begin()) {
+    return false; // addr is before any range
+  }
+  const auto& range = *(--it);
+  return (((range.first ^ addr) & (0xFFFFFFFF << (32 - range.second))) == 0);
+}
+
+bool IPV4RangeSet::check(const struct sockaddr_storage& ss) const {
+  if (ss.ss_family != AF_INET) {
+    return false;
+  }
+  const sockaddr_in* sin = reinterpret_cast<const sockaddr_in*>(&ss);
+  return this->check(ntohl(sin->sin_addr.s_addr));
+}

src/IPV4RangeSet.hh

@@ -1,18 +1,18 @@
-#pragma once
-
-#include <phosg/JSON.hh>
-#include <set>
-
-class IPV4RangeSet {
-public:
-  IPV4RangeSet() = default;
-  explicit IPV4RangeSet(const JSON& json);
-
-  JSON json() const;
-
-  bool check(uint32_t addr) const;
-  bool check(const struct sockaddr_storage& ss) const;
-
-protected:
-  std::map<uint32_t, uint8_t> ranges; // {addr: mask_bits}
-};
+#pragma once
+
+#include <phosg/JSON.hh>
+#include <set>
+
+class IPV4RangeSet {
+public:
+  IPV4RangeSet() = default;
+  explicit IPV4RangeSet(const JSON& json);
+
+  JSON json() const;
+
+  bool check(uint32_t addr) const;
+  bool check(const struct sockaddr_storage& ss) const;
+
+protected:
+  std::map<uint32_t, uint8_t> ranges; // {addr: mask_bits}
+};

src/IntegralExpression.cc

@@ -1,455 +1,455 @@
-#include "IntegralExpression.hh"
-
-#include <algorithm>
-#include <mutex>
-#include <phosg/Encoding.hh>
-#include <phosg/Filesystem.hh>
-#include <phosg/Hash.hh>
-#include <phosg/Random.hh>
-#include <phosg/Strings.hh>
-#include <phosg/Tools.hh>
-#include <string>
-#include <unordered_map>
-
-#include "CommandFormats.hh"
-#include "Compression.hh"
-#include "Loggers.hh"
-#include "PSOEncryption.hh"
-#include "QuestScript.hh"
-#include "SaveFileFormats.hh"
-#include "Text.hh"
-
-using namespace std;
-
-IntegralExpression::IntegralExpression(const string& text)
-    : root(this->parse_expr(text)) {}
-
-IntegralExpression::BinaryOperatorNode::BinaryOperatorNode(
-    Type type, unique_ptr<const Node>&& left, unique_ptr<const Node>&& right)
-    : type(type),
-      left(std::move(left)),
-      right(std::move(right)) {}
-
-bool IntegralExpression::BinaryOperatorNode::operator==(const Node& other) const {
-  try {
-    const BinaryOperatorNode& other_bin = dynamic_cast<const BinaryOperatorNode&>(other);
-    return other_bin.type == this->type && *other_bin.left == *this->left && *other_bin.right == *this->right;
-  } catch (const bad_cast&) {
-    return false;
-  }
-}
-
-int64_t IntegralExpression::BinaryOperatorNode::evaluate(const Env& env) const {
-  switch (this->type) {
-    case Type::LOGICAL_OR:
-      return this->left->evaluate(env) || this->right->evaluate(env);
-    case Type::LOGICAL_AND:
-      return this->left->evaluate(env) && this->right->evaluate(env);
-    case Type::BITWISE_OR:
-      return this->left->evaluate(env) | this->right->evaluate(env);
-    case Type::BITWISE_AND:
-      return this->left->evaluate(env) & this->right->evaluate(env);
-    case Type::BITWISE_XOR:
-      return this->left->evaluate(env) ^ this->right->evaluate(env);
-    case Type::LEFT_SHIFT:
-      return this->left->evaluate(env) << this->right->evaluate(env);
-    case Type::RIGHT_SHIFT:
-      return this->left->evaluate(env) >> this->right->evaluate(env);
-    case Type::LESS_THAN:
-      return this->left->evaluate(env) < this->right->evaluate(env);
-    case Type::GREATER_THAN:
-      return this->left->evaluate(env) > this->right->evaluate(env);
-    case Type::LESS_OR_EQUAL:
-      return this->left->evaluate(env) <= this->right->evaluate(env);
-    case Type::GREATER_OR_EQUAL:
-      return this->left->evaluate(env) >= this->right->evaluate(env);
-    case Type::EQUAL:
-      return this->left->evaluate(env) == this->right->evaluate(env);
-    case Type::NOT_EQUAL:
-      return this->left->evaluate(env) != this->right->evaluate(env);
-    case Type::ADD:
-      return this->left->evaluate(env) + this->right->evaluate(env);
-    case Type::SUBTRACT:
-      return this->left->evaluate(env) - this->right->evaluate(env);
-    case Type::MULTIPLY:
-      return this->left->evaluate(env) * this->right->evaluate(env);
-    case Type::DIVIDE:
-      return this->left->evaluate(env) / this->right->evaluate(env);
-    case Type::MODULUS:
-      return this->left->evaluate(env) % this->right->evaluate(env);
-    default:
-      throw logic_error("invalid binary operator type");
-  }
-}
-
-string IntegralExpression::BinaryOperatorNode::str() const {
-  switch (this->type) {
-    case Type::LOGICAL_OR:
-      return "(" + this->left->str() + ") || (" + this->right->str() + ")";
-    case Type::LOGICAL_AND:
-      return "(" + this->left->str() + ") && (" + this->right->str() + ")";
-    case Type::BITWISE_OR:
-      return "(" + this->left->str() + ") | (" + this->right->str() + ")";
-    case Type::BITWISE_AND:
-      return "(" + this->left->str() + ") & (" + this->right->str() + ")";
-    case Type::BITWISE_XOR:
-      return "(" + this->left->str() + ") ^ (" + this->right->str() + ")";
-    case Type::LEFT_SHIFT:
-      return "(" + this->left->str() + ") << (" + this->right->str() + ")";
-    case Type::RIGHT_SHIFT:
-      return "(" + this->left->str() + ") >> (" + this->right->str() + ")";
-    case Type::LESS_THAN:
-      return "(" + this->left->str() + ") < (" + this->right->str() + ")";
-    case Type::GREATER_THAN:
-      return "(" + this->left->str() + ") > (" + this->right->str() + ")";
-    case Type::LESS_OR_EQUAL:
-      return "(" + this->left->str() + ") <= (" + this->right->str() + ")";
-    case Type::GREATER_OR_EQUAL:
-      return "(" + this->left->str() + ") >= (" + this->right->str() + ")";
-    case Type::EQUAL:
-      return "(" + this->left->str() + ") == (" + this->right->str() + ")";
-    case Type::NOT_EQUAL:
-      return "(" + this->left->str() + ") != (" + this->right->str() + ")";
-    case Type::ADD:
-      return "(" + this->left->str() + ") + (" + this->right->str() + ")";
-    case Type::SUBTRACT:
-      return "(" + this->left->str() + ") - (" + this->right->str() + ")";
-    case Type::MULTIPLY:
-      return "(" + this->left->str() + ") * (" + this->right->str() + ")";
-    case Type::DIVIDE:
-      return "(" + this->left->str() + ") / (" + this->right->str() + ")";
-    case Type::MODULUS:
-      return "(" + this->left->str() + ") % (" + this->right->str() + ")";
-    default:
-      throw logic_error("invalid binary operator type");
-  }
-}
-
-IntegralExpression::UnaryOperatorNode::UnaryOperatorNode(Type type, unique_ptr<const Node>&& sub)
-    : type(type),
-      sub(std::move(sub)) {}
-
-bool IntegralExpression::UnaryOperatorNode::operator==(const Node& other) const {
-  try {
-    const UnaryOperatorNode& other_un = dynamic_cast<const UnaryOperatorNode&>(other);
-    return other_un.type == this->type && *other_un.sub == *this->sub;
-  } catch (const bad_cast&) {
-    return false;
-  }
-}
-
-int64_t IntegralExpression::UnaryOperatorNode::evaluate(const Env& env) const {
-  switch (this->type) {
-    case Type::LOGICAL_NOT:
-      return !this->sub->evaluate(env);
-    case Type::BITWISE_NOT:
-      return ~this->sub->evaluate(env);
-    case Type::NEGATIVE:
-      return -this->sub->evaluate(env);
-    default:
-      throw logic_error("invalid unary operator type");
-  }
-}
-
-string IntegralExpression::UnaryOperatorNode::str() const {
-  switch (this->type) {
-    case Type::LOGICAL_NOT:
-      return "!(" + this->sub->str() + ")";
-    case Type::BITWISE_NOT:
-      return "~(" + this->sub->str() + ")";
-    case Type::NEGATIVE:
-      return "-(" + this->sub->str() + ")";
-    default:
-      throw logic_error("invalid unary operator type");
-  }
-}
-
-IntegralExpression::FlagLookupNode::FlagLookupNode(uint16_t flag_index)
-    : flag_index(flag_index) {}
-
-bool IntegralExpression::FlagLookupNode::operator==(const Node& other) const {
-  try {
-    const FlagLookupNode& other_flag = dynamic_cast<const FlagLookupNode&>(other);
-    return other_flag.flag_index == this->flag_index;
-  } catch (const bad_cast&) {
-    return false;
-  }
-}
-
-int64_t IntegralExpression::FlagLookupNode::evaluate(const Env& env) const {
-  if (!env.flags) {
-    throw runtime_error("quest flags not available");
-  }
-  return env.flags->get(this->flag_index) ? 1 : 0;
-}
-
-string IntegralExpression::FlagLookupNode::str() const {
-  return string_printf("F_%04hX", this->flag_index);
-}
-
-IntegralExpression::ChallengeCompletionLookupNode::ChallengeCompletionLookupNode(
-    Episode episode, uint8_t stage_index)
-    : episode(episode),
-      stage_index(stage_index) {}
-
-bool IntegralExpression::ChallengeCompletionLookupNode::operator==(const Node& other) const {
-  try {
-    const ChallengeCompletionLookupNode& other_cc = dynamic_cast<const ChallengeCompletionLookupNode&>(other);
-    return other_cc.episode == this->episode && other_cc.stage_index == this->stage_index;
-  } catch (const bad_cast&) {
-    return false;
-  }
-}
-
-int64_t IntegralExpression::ChallengeCompletionLookupNode::evaluate(const Env& env) const {
-  if (!env.challenge_records) {
-    throw runtime_error("challenge records not available");
-  }
-  if (this->episode == Episode::EP1) {
-    return env.challenge_records->times_ep1_online.at(this->stage_index).has_value();
-  } else if (this->episode == Episode::EP2) {
-    return env.challenge_records->times_ep2_online.at(this->stage_index).has_value();
-  }
-  return false;
-}
-
-string IntegralExpression::ChallengeCompletionLookupNode::str() const {
-  return string_printf("CC_%s_%hhu", abbreviation_for_episode(this->episode), static_cast<uint8_t>(this->stage_index + 1));
-}
-
-IntegralExpression::TeamRewardLookupNode::TeamRewardLookupNode(const string& reward_name)
-    : reward_name(reward_name) {}
-
-bool IntegralExpression::TeamRewardLookupNode::operator==(const Node& other) const {
-  try {
-    const TeamRewardLookupNode& other_team_reward = dynamic_cast<const TeamRewardLookupNode&>(other);
-    return other_team_reward.reward_name == this->reward_name;
-  } catch (const bad_cast&) {
-    return false;
-  }
-}
-
-int64_t IntegralExpression::TeamRewardLookupNode::evaluate(const Env& env) const {
-  return (env.team && env.team->has_reward(this->reward_name)) ? 1 : 0;
-}
-
-string IntegralExpression::TeamRewardLookupNode::str() const {
-  return "T_" + this->reward_name;
-}
-
-IntegralExpression::NumPlayersLookupNode::NumPlayersLookupNode() {}
-
-bool IntegralExpression::NumPlayersLookupNode::operator==(const Node& other) const {
-  return dynamic_cast<const NumPlayersLookupNode*>(&other) != nullptr;
-}
-
-int64_t IntegralExpression::NumPlayersLookupNode::evaluate(const Env& env) const {
-  return env.num_players;
-}
-
-string IntegralExpression::NumPlayersLookupNode::str() const {
-  return "V_NumPlayers";
-}
-
-IntegralExpression::EventLookupNode::EventLookupNode() {}
-
-bool IntegralExpression::EventLookupNode::operator==(const Node& other) const {
-  return dynamic_cast<const EventLookupNode*>(&other) != nullptr;
-}
-
-int64_t IntegralExpression::EventLookupNode::evaluate(const Env& env) const {
-  return env.event;
-}
-
-string IntegralExpression::EventLookupNode::str() const {
-  return "V_Event";
-}
-
-IntegralExpression::V1PresenceLookupNode::V1PresenceLookupNode() {}
-
-bool IntegralExpression::V1PresenceLookupNode::operator==(const Node& other) const {
-  return dynamic_cast<const V1PresenceLookupNode*>(&other) != nullptr;
-}
-
-int64_t IntegralExpression::V1PresenceLookupNode::evaluate(const Env& env) const {
-  return env.v1_present ? 1 : 0;
-}
-
-string IntegralExpression::V1PresenceLookupNode::str() const {
-  return "V_V1Present";
-}
-
-IntegralExpression::ConstantNode::ConstantNode(int64_t value)
-    : value(value) {}
-
-bool IntegralExpression::ConstantNode::operator==(const Node& other) const {
-  try {
-    const ConstantNode& other_const = dynamic_cast<const ConstantNode&>(other);
-    return other_const.value == this->value;
-  } catch (const bad_cast&) {
-    return false;
-  }
-}
-
-int64_t IntegralExpression::ConstantNode::evaluate(const Env&) const {
-  return this->value;
-}
-
-string IntegralExpression::ConstantNode::str() const {
-  return string_printf("%" PRId64, this->value);
-}
-
-unique_ptr<const IntegralExpression::Node> IntegralExpression::parse_expr(string_view text) {
-  // Strip off spaces and fully-enclosing parentheses
-  for (;;) {
-    size_t starting_size = text.size();
-    while (text.at(0) == ' ') {
-      text = text.substr(1);
-    }
-    while (text.at(text.size() - 1) == ' ') {
-      text = text.substr(0, text.size() - 1);
-    }
-    if (text.at(0) == '(' && text.at(text.size() - 1) == ')') {
-      // It doesn't suffice to just check the first ant last characters, since
-      // text could be like "(a) && (b)". Instead, we ignore the first and last
-      // characters, and don't strip anything if the internal parentheses are
-      // unbalanced.
-      size_t paren_level = 1;
-      for (size_t z = 1; z < text.size() - 1; z++) {
-        if (text[z] == '(') {
-          paren_level++;
-        } else if (text[z] == ')') {
-          paren_level--;
-          if (paren_level == 0) {
-            break;
-          }
-        }
-      }
-      if (paren_level > 0) {
-        text = text.substr(1, text.size() - 2);
-      }
-    }
-    if (text.size() == starting_size) {
-      break;
-    }
-  }
-  if (text.empty()) {
-    throw runtime_error("invalid expression");
-  }
-
-  // Check for unary operators
-  if (text[0] == '!') {
-    return make_unique<UnaryOperatorNode>(UnaryOperatorNode::Type::LOGICAL_NOT,
-        IntegralExpression::parse_expr(text.substr(1)));
-  } else if (text[0] == '~') {
-    return make_unique<UnaryOperatorNode>(UnaryOperatorNode::Type::BITWISE_NOT,
-        IntegralExpression::parse_expr(text.substr(1)));
-  } else if (text[0] == '-') {
-    return make_unique<UnaryOperatorNode>(UnaryOperatorNode::Type::NEGATIVE,
-        IntegralExpression::parse_expr(text.substr(1)));
-  }
-
-  // Check for binary operators at the root level
-  using BinType = BinaryOperatorNode::Type;
-  static const vector<vector<pair<std::string, BinaryOperatorNode::Type>>> binary_operator_levels = {
-      {{make_pair("*", BinType::MULTIPLY)}, {make_pair("/", BinType::DIVIDE)}, {make_pair("%", BinType::MODULUS)}},
-      {{make_pair("+", BinType::ADD)}, {make_pair("-", BinType::SUBTRACT)}},
-      {{make_pair("<<", BinType::LEFT_SHIFT)}, {make_pair(">>", BinType::RIGHT_SHIFT)}},
-      {{make_pair("<=", BinType::LESS_OR_EQUAL)}, {make_pair(">=", BinType::GREATER_OR_EQUAL)}, {make_pair("<", BinType::LESS_THAN)}, {make_pair(">", BinType::GREATER_THAN)}},
-      {{make_pair("==", BinType::EQUAL)}, {make_pair("!=", BinType::NOT_EQUAL)}},
-      {{make_pair("&", BinType::BITWISE_AND)}},
-      {{make_pair("^", BinType::BITWISE_XOR)}},
-      {{make_pair("|", BinType::BITWISE_OR)}},
-      {{make_pair("&&", BinType::LOGICAL_AND)}},
-      {{make_pair("||", BinType::LOGICAL_OR)}},
-  };
-  for (const auto& operators : binary_operator_levels) {
-    size_t paren_level = 0;
-    for (size_t z = 0; z < text.size() - 1; z++) {
-      if (text[z] == '(') {
-        paren_level++;
-        continue;
-      } else if (text[z] == ')') {
-        paren_level--;
-        continue;
-      }
-      if (!paren_level) {
-        for (const auto& oper : operators) {
-          // Awful hack (because I'm too lazy to add a tokenization step): if
-          // the operator is followed or preceded by another copy of itself,
-          // don't match it (this prevents us from matching & when the token is
-          // actually &&)
-          if ((text.size() > z + oper.first.size()) &&
-              ((z < oper.first.size()) || (text.compare(z - oper.first.size(), oper.first.size(), oper.first) != 0)) &&
-              (text.compare(z, oper.first.size(), oper.first) == 0) &&
-              (text.compare(z + oper.first.size(), oper.first.size(), oper.first) != 0)) {
-            auto left = IntegralExpression::parse_expr(text.substr(0, z));
-            auto right = IntegralExpression::parse_expr(text.substr(z + oper.first.size()));
-            return make_unique<BinaryOperatorNode>(oper.second, std::move(left), std::move(right));
-          }
-        }
-      }
-    }
-  }
-
-  // Check for env lookups
-  if (text.starts_with("F_")) {
-    char* endptr = nullptr;
-    uint64_t flag = strtoul(text.data() + 2, &endptr, 16);
-    if (endptr != text.data() + text.size()) {
-      throw runtime_error("invalid flag lookup token");
-    }
-    if (flag >= 0x400) {
-      throw runtime_error("invalid flag index");
-    }
-    return make_unique<FlagLookupNode>(flag);
-  }
-  if (text.starts_with("CC_")) {
-    Episode episode;
-    if (text.starts_with("CC_Ep1_")) {
-      episode = Episode::EP1;
-    } else if (text.starts_with("CC_Ep2_")) {
-      episode = Episode::EP2;
-    } else {
-      throw runtime_error("invalid challenge episode");
-    }
-    char* endptr = nullptr;
-    uint64_t stage_index = strtoul(text.data() + 7, &endptr, 0) - 1;
-    if (endptr != text.data() + text.size()) {
-      throw runtime_error("invalid challenge completion lookup token");
-    }
-    if ((episode == Episode::EP1 && stage_index > 8) || (episode == Episode::EP2 && stage_index > 4)) {
-      throw runtime_error("invalid challenge stage index");
-    }
-    return make_unique<ChallengeCompletionLookupNode>(episode, stage_index);
-  }
-  if (text.starts_with("T_")) {
-    return make_unique<TeamRewardLookupNode>(string(text.substr(2)));
-  }
-  if (text == "V_NumPlayers") {
-    return make_unique<NumPlayersLookupNode>();
-  }
-  if (text == "V_Event") {
-    return make_unique<EventLookupNode>();
-  }
-  if (text == "V_V1Present") {
-    return make_unique<V1PresenceLookupNode>();
-  }
-
-  // Check for constants
-  if (text == "true") {
-    return make_unique<ConstantNode>(1);
-  }
-  if (text == "false") {
-    return make_unique<ConstantNode>(0);
-  }
-  try {
-    size_t endpos;
-    int64_t v = stoll(string(text), &endpos, 0);
-    if (endpos == text.size()) {
-      return make_unique<ConstantNode>(v);
-    }
-  } catch (const exception&) {
-  }
-  throw runtime_error("unparseable expression");
-}
+#include "IntegralExpression.hh"
+
+#include <algorithm>
+#include <mutex>
+#include <phosg/Encoding.hh>
+#include <phosg/Filesystem.hh>
+#include <phosg/Hash.hh>
+#include <phosg/Random.hh>
+#include <phosg/Strings.hh>
+#include <phosg/Tools.hh>
+#include <string>
+#include <unordered_map>
+
+#include "CommandFormats.hh"
+#include "Compression.hh"
+#include "Loggers.hh"
+#include "PSOEncryption.hh"
+#include "QuestScript.hh"
+#include "SaveFileFormats.hh"
+#include "Text.hh"
+
+using namespace std;
+
+IntegralExpression::IntegralExpression(const string& text)
+    : root(this->parse_expr(text)) {}
+
+IntegralExpression::BinaryOperatorNode::BinaryOperatorNode(
+    Type type, unique_ptr<const Node>&& left, unique_ptr<const Node>&& right)
+    : type(type),
+      left(std::move(left)),
+      right(std::move(right)) {}
+
+bool IntegralExpression::BinaryOperatorNode::operator==(const Node& other) const {
+  try {
+    const BinaryOperatorNode& other_bin = dynamic_cast<const BinaryOperatorNode&>(other);
+    return other_bin.type == this->type && *other_bin.left == *this->left && *other_bin.right == *this->right;
+  } catch (const bad_cast&) {
+    return false;
+  }
+}
+
+int64_t IntegralExpression::BinaryOperatorNode::evaluate(const Env& env) const {
+  switch (this->type) {
+    case Type::LOGICAL_OR:
+      return this->left->evaluate(env) || this->right->evaluate(env);
+    case Type::LOGICAL_AND:
+      return this->left->evaluate(env) && this->right->evaluate(env);
+    case Type::BITWISE_OR:
+      return this->left->evaluate(env) | this->right->evaluate(env);
+    case Type::BITWISE_AND:
+      return this->left->evaluate(env) & this->right->evaluate(env);
+    case Type::BITWISE_XOR:
+      return this->left->evaluate(env) ^ this->right->evaluate(env);
+    case Type::LEFT_SHIFT:
+      return this->left->evaluate(env) << this->right->evaluate(env);
+    case Type::RIGHT_SHIFT:
+      return this->left->evaluate(env) >> this->right->evaluate(env);
+    case Type::LESS_THAN:
+      return this->left->evaluate(env) < this->right->evaluate(env);
+    case Type::GREATER_THAN:
+      return this->left->evaluate(env) > this->right->evaluate(env);
+    case Type::LESS_OR_EQUAL:
+      return this->left->evaluate(env) <= this->right->evaluate(env);
+    case Type::GREATER_OR_EQUAL:
+      return this->left->evaluate(env) >= this->right->evaluate(env);
+    case Type::EQUAL:
+      return this->left->evaluate(env) == this->right->evaluate(env);
+    case Type::NOT_EQUAL:
+      return this->left->evaluate(env) != this->right->evaluate(env);
+    case Type::ADD:
+      return this->left->evaluate(env) + this->right->evaluate(env);
+    case Type::SUBTRACT:
+      return this->left->evaluate(env) - this->right->evaluate(env);
+    case Type::MULTIPLY:
+      return this->left->evaluate(env) * this->right->evaluate(env);
+    case Type::DIVIDE:
+      return this->left->evaluate(env) / this->right->evaluate(env);
+    case Type::MODULUS:
+      return this->left->evaluate(env) % this->right->evaluate(env);
+    default:
+      throw logic_error("invalid binary operator type");
+  }
+}
+
+string IntegralExpression::BinaryOperatorNode::str() const {
+  switch (this->type) {
+    case Type::LOGICAL_OR:
+      return "(" + this->left->str() + ") || (" + this->right->str() + ")";
+    case Type::LOGICAL_AND:
+      return "(" + this->left->str() + ") && (" + this->right->str() + ")";
+    case Type::BITWISE_OR:
+      return "(" + this->left->str() + ") | (" + this->right->str() + ")";
+    case Type::BITWISE_AND:
+      return "(" + this->left->str() + ") & (" + this->right->str() + ")";
+    case Type::BITWISE_XOR:
+      return "(" + this->left->str() + ") ^ (" + this->right->str() + ")";
+    case Type::LEFT_SHIFT:
+      return "(" + this->left->str() + ") << (" + this->right->str() + ")";
+    case Type::RIGHT_SHIFT:
+      return "(" + this->left->str() + ") >> (" + this->right->str() + ")";
+    case Type::LESS_THAN:
+      return "(" + this->left->str() + ") < (" + this->right->str() + ")";
+    case Type::GREATER_THAN:
+      return "(" + this->left->str() + ") > (" + this->right->str() + ")";
+    case Type::LESS_OR_EQUAL:
+      return "(" + this->left->str() + ") <= (" + this->right->str() + ")";
+    case Type::GREATER_OR_EQUAL:
+      return "(" + this->left->str() + ") >= (" + this->right->str() + ")";
+    case Type::EQUAL:
+      return "(" + this->left->str() + ") == (" + this->right->str() + ")";
+    case Type::NOT_EQUAL:
+      return "(" + this->left->str() + ") != (" + this->right->str() + ")";
+    case Type::ADD:
+      return "(" + this->left->str() + ") + (" + this->right->str() + ")";
+    case Type::SUBTRACT:
+      return "(" + this->left->str() + ") - (" + this->right->str() + ")";
+    case Type::MULTIPLY:
+      return "(" + this->left->str() + ") * (" + this->right->str() + ")";
+    case Type::DIVIDE:
+      return "(" + this->left->str() + ") / (" + this->right->str() + ")";
+    case Type::MODULUS:
+      return "(" + this->left->str() + ") % (" + this->right->str() + ")";
+    default:
+      throw logic_error("invalid binary operator type");
+  }
+}
+
+IntegralExpression::UnaryOperatorNode::UnaryOperatorNode(Type type, unique_ptr<const Node>&& sub)
+    : type(type),
+      sub(std::move(sub)) {}
+
+bool IntegralExpression::UnaryOperatorNode::operator==(const Node& other) const {
+  try {
+    const UnaryOperatorNode& other_un = dynamic_cast<const UnaryOperatorNode&>(other);
+    return other_un.type == this->type && *other_un.sub == *this->sub;
+  } catch (const bad_cast&) {
+    return false;
+  }
+}
+
+int64_t IntegralExpression::UnaryOperatorNode::evaluate(const Env& env) const {
+  switch (this->type) {
+    case Type::LOGICAL_NOT:
+      return !this->sub->evaluate(env);
+    case Type::BITWISE_NOT:
+      return ~this->sub->evaluate(env);
+    case Type::NEGATIVE:
+      return -this->sub->evaluate(env);
+    default:
+      throw logic_error("invalid unary operator type");
+  }
+}
+
+string IntegralExpression::UnaryOperatorNode::str() const {
+  switch (this->type) {
+    case Type::LOGICAL_NOT:
+      return "!(" + this->sub->str() + ")";
+    case Type::BITWISE_NOT:
+      return "~(" + this->sub->str() + ")";
+    case Type::NEGATIVE:
+      return "-(" + this->sub->str() + ")";
+    default:
+      throw logic_error("invalid unary operator type");
+  }
+}
+
+IntegralExpression::FlagLookupNode::FlagLookupNode(uint16_t flag_index)
+    : flag_index(flag_index) {}
+
+bool IntegralExpression::FlagLookupNode::operator==(const Node& other) const {
+  try {
+    const FlagLookupNode& other_flag = dynamic_cast<const FlagLookupNode&>(other);
+    return other_flag.flag_index == this->flag_index;
+  } catch (const bad_cast&) {
+    return false;
+  }
+}
+
+int64_t IntegralExpression::FlagLookupNode::evaluate(const Env& env) const {
+  if (!env.flags) {
+    throw runtime_error("quest flags not available");
+  }
+  return env.flags->get(this->flag_index) ? 1 : 0;
+}
+
+string IntegralExpression::FlagLookupNode::str() const {
+  return string_printf("F_%04hX", this->flag_index);
+}
+
+IntegralExpression::ChallengeCompletionLookupNode::ChallengeCompletionLookupNode(
+    Episode episode, uint8_t stage_index)
+    : episode(episode),
+      stage_index(stage_index) {}
+
+bool IntegralExpression::ChallengeCompletionLookupNode::operator==(const Node& other) const {
+  try {
+    const ChallengeCompletionLookupNode& other_cc = dynamic_cast<const ChallengeCompletionLookupNode&>(other);
+    return other_cc.episode == this->episode && other_cc.stage_index == this->stage_index;
+  } catch (const bad_cast&) {
+    return false;
+  }
+}
+
+int64_t IntegralExpression::ChallengeCompletionLookupNode::evaluate(const Env& env) const {
+  if (!env.challenge_records) {
+    throw runtime_error("challenge records not available");
+  }
+  if (this->episode == Episode::EP1) {
+    return env.challenge_records->times_ep1_online.at(this->stage_index).has_value();
+  } else if (this->episode == Episode::EP2) {
+    return env.challenge_records->times_ep2_online.at(this->stage_index).has_value();
+  }
+  return false;
+}
+
+string IntegralExpression::ChallengeCompletionLookupNode::str() const {
+  return string_printf("CC_%s_%hhu", abbreviation_for_episode(this->episode), static_cast<uint8_t>(this->stage_index + 1));
+}
+
+IntegralExpression::TeamRewardLookupNode::TeamRewardLookupNode(const string& reward_name)
+    : reward_name(reward_name) {}
+
+bool IntegralExpression::TeamRewardLookupNode::operator==(const Node& other) const {
+  try {
+    const TeamRewardLookupNode& other_team_reward = dynamic_cast<const TeamRewardLookupNode&>(other);
+    return other_team_reward.reward_name == this->reward_name;
+  } catch (const bad_cast&) {
+    return false;
+  }
+}
+
+int64_t IntegralExpression::TeamRewardLookupNode::evaluate(const Env& env) const {
+  return (env.team && env.team->has_reward(this->reward_name)) ? 1 : 0;
+}
+
+string IntegralExpression::TeamRewardLookupNode::str() const {
+  return "T_" + this->reward_name;
+}
+
+IntegralExpression::NumPlayersLookupNode::NumPlayersLookupNode() {}
+
+bool IntegralExpression::NumPlayersLookupNode::operator==(const Node& other) const {
+  return dynamic_cast<const NumPlayersLookupNode*>(&other) != nullptr;
+}
+
+int64_t IntegralExpression::NumPlayersLookupNode::evaluate(const Env& env) const {
+  return env.num_players;
+}
+
+string IntegralExpression::NumPlayersLookupNode::str() const {
+  return "V_NumPlayers";
+}
+
+IntegralExpression::EventLookupNode::EventLookupNode() {}
+
+bool IntegralExpression::EventLookupNode::operator==(const Node& other) const {
+  return dynamic_cast<const EventLookupNode*>(&other) != nullptr;
+}
+
+int64_t IntegralExpression::EventLookupNode::evaluate(const Env& env) const {
+  return env.event;
+}
+
+string IntegralExpression::EventLookupNode::str() const {
+  return "V_Event";
+}
+
+IntegralExpression::V1PresenceLookupNode::V1PresenceLookupNode() {}
+
+bool IntegralExpression::V1PresenceLookupNode::operator==(const Node& other) const {
+  return dynamic_cast<const V1PresenceLookupNode*>(&other) != nullptr;
+}
+
+int64_t IntegralExpression::V1PresenceLookupNode::evaluate(const Env& env) const {
+  return env.v1_present ? 1 : 0;
+}
+
+string IntegralExpression::V1PresenceLookupNode::str() const {
+  return "V_V1Present";
+}
+
+IntegralExpression::ConstantNode::ConstantNode(int64_t value)
+    : value(value) {}
+
+bool IntegralExpression::ConstantNode::operator==(const Node& other) const {
+  try {
+    const ConstantNode& other_const = dynamic_cast<const ConstantNode&>(other);
+    return other_const.value == this->value;
+  } catch (const bad_cast&) {
+    return false;
+  }
+}
+
+int64_t IntegralExpression::ConstantNode::evaluate(const Env&) const {
+  return this->value;
+}
+
+string IntegralExpression::ConstantNode::str() const {
+  return string_printf("%" PRId64, this->value);
+}
+
+unique_ptr<const IntegralExpression::Node> IntegralExpression::parse_expr(string_view text) {
+  // Strip off spaces and fully-enclosing parentheses
+  for (;;) {
+    size_t starting_size = text.size();
+    while (text.at(0) == ' ') {
+      text = text.substr(1);
+    }
+    while (text.at(text.size() - 1) == ' ') {
+      text = text.substr(0, text.size() - 1);
+    }
+    if (text.at(0) == '(' && text.at(text.size() - 1) == ')') {
+      // It doesn't suffice to just check the first ant last characters, since
+      // text could be like "(a) && (b)". Instead, we ignore the first and last
+      // characters, and don't strip anything if the internal parentheses are
+      // unbalanced.
+      size_t paren_level = 1;
+      for (size_t z = 1; z < text.size() - 1; z++) {
+        if (text[z] == '(') {
+          paren_level++;
+        } else if (text[z] == ')') {
+          paren_level--;
+          if (paren_level == 0) {
+            break;
+          }
+        }
+      }
+      if (paren_level > 0) {
+        text = text.substr(1, text.size() - 2);
+      }
+    }
+    if (text.size() == starting_size) {
+      break;
+    }
+  }
+  if (text.empty()) {
+    throw runtime_error("invalid expression");
+  }
+
+  // Check for binary operators at the root level
+  using BinType = BinaryOperatorNode::Type;
+  static const vector<vector<pair<std::string, BinaryOperatorNode::Type>>> binary_operator_levels = {
+      {{make_pair("||", BinType::LOGICAL_OR)}},
+      {{make_pair("&&", BinType::LOGICAL_AND)}},
+      {{make_pair("|", BinType::BITWISE_OR)}},
+      {{make_pair("^", BinType::BITWISE_XOR)}},
+      {{make_pair("&", BinType::BITWISE_AND)}},
+      {{make_pair("==", BinType::EQUAL)}, {make_pair("!=", BinType::NOT_EQUAL)}},
+      {{make_pair("<=", BinType::LESS_OR_EQUAL)}, {make_pair(">=", BinType::GREATER_OR_EQUAL)}, {make_pair("<", BinType::LESS_THAN)}, {make_pair(">", BinType::GREATER_THAN)}},
+      {{make_pair("<<", BinType::LEFT_SHIFT)}, {make_pair(">>", BinType::RIGHT_SHIFT)}},
+      {{make_pair("+", BinType::ADD)}, {make_pair("-", BinType::SUBTRACT)}},
+      {{make_pair("*", BinType::MULTIPLY)}, {make_pair("/", BinType::DIVIDE)}, {make_pair("%", BinType::MODULUS)}},
+  };
+  for (const auto& operators : binary_operator_levels) {
+    size_t paren_level = 0;
+    for (size_t z = 0; z < text.size() - 1; z++) {
+      if (text[z] == '(') {
+        paren_level++;
+        continue;
+      } else if (text[z] == ')') {
+        paren_level--;
+        continue;
+      }
+      if (!paren_level) {
+        for (const auto& oper : operators) {
+          // Awful hack (because I'm too lazy to add a tokenization step): if
+          // the operator is followed or preceded by another copy of itself,
+          // don't match it (this prevents us from matching & when the token is
+          // actually &&)
+          if ((text.size() > z + oper.first.size()) &&
+              ((z < oper.first.size()) || (text.compare(z - oper.first.size(), oper.first.size(), oper.first) != 0)) &&
+              (text.compare(z, oper.first.size(), oper.first) == 0) &&
+              (text.compare(z + oper.first.size(), oper.first.size(), oper.first) != 0)) {
+            auto left = IntegralExpression::parse_expr(text.substr(0, z));
+            auto right = IntegralExpression::parse_expr(text.substr(z + oper.first.size()));
+            return make_unique<BinaryOperatorNode>(oper.second, std::move(left), std::move(right));
+          }
+        }
+      }
+    }
+  }
+
+  // Check for unary operators
+  if (text[0] == '!') {
+    return make_unique<UnaryOperatorNode>(UnaryOperatorNode::Type::LOGICAL_NOT,
+        IntegralExpression::parse_expr(text.substr(1)));
+  } else if (text[0] == '~') {
+    return make_unique<UnaryOperatorNode>(UnaryOperatorNode::Type::BITWISE_NOT,
+        IntegralExpression::parse_expr(text.substr(1)));
+  } else if (text[0] == '-') {
+    return make_unique<UnaryOperatorNode>(UnaryOperatorNode::Type::NEGATIVE,
+        IntegralExpression::parse_expr(text.substr(1)));
+  }
+
+  // Check for env lookups
+  if (text.starts_with("F_")) {
+    char* endptr = nullptr;
+    uint64_t flag = strtoul(text.data() + 2, &endptr, 16);
+    if (endptr != text.data() + text.size()) {
+      throw runtime_error("invalid flag lookup token");
+    }
+    if (flag >= 0x400) {
+      throw runtime_error("invalid flag index");
+    }
+    return make_unique<FlagLookupNode>(flag);
+  }
+  if (text.starts_with("CC_")) {
+    Episode episode;
+    if (text.starts_with("CC_Ep1_")) {
+      episode = Episode::EP1;
+    } else if (text.starts_with("CC_Ep2_")) {
+      episode = Episode::EP2;
+    } else {
+      throw runtime_error("invalid challenge episode");
+    }
+    char* endptr = nullptr;
+    uint64_t stage_index = strtoul(text.data() + 7, &endptr, 0) - 1;
+    if (endptr != text.data() + text.size()) {
+      throw runtime_error("invalid challenge completion lookup token");
+    }
+    if ((episode == Episode::EP1 && stage_index > 8) || (episode == Episode::EP2 && stage_index > 4)) {
+      throw runtime_error("invalid challenge stage index");
+    }
+    return make_unique<ChallengeCompletionLookupNode>(episode, stage_index);
+  }
+  if (text.starts_with("T_")) {
+    return make_unique<TeamRewardLookupNode>(string(text.substr(2)));
+  }
+  if (text == "V_NumPlayers") {
+    return make_unique<NumPlayersLookupNode>();
+  }
+  if (text == "V_Event") {
+    return make_unique<EventLookupNode>();
+  }
+  if (text == "V_V1Present") {
+    return make_unique<V1PresenceLookupNode>();
+  }
+
+  // Check for constants
+  if (text == "true") {
+    return make_unique<ConstantNode>(1);
+  }
+  if (text == "false") {
+    return make_unique<ConstantNode>(0);
+  }
+  try {
+    size_t endpos;
+    int64_t v = stoll(string(text), &endpos, 0);
+    if (endpos == text.size()) {
+      return make_unique<ConstantNode>(v);
+    }
+  } catch (const exception&) {
+  }
+  throw runtime_error("unparseable expression");
+}

src/IntegralExpression.hh

@@ -1,188 +1,188 @@
-#pragma once
-
-#include <stdint.h>
-
-#include <map>
-#include <memory>
-#include <string>
-#include <unordered_map>
-#include <vector>
-
-#include "PlayerSubordinates.hh"
-#include "QuestScript.hh"
-#include "StaticGameData.hh"
-#include "TeamIndex.hh"
-
-class IntegralExpression {
-public:
-  struct Env {
-    const QuestFlagsForDifficulty* flags;
-    const PlayerRecordsChallengeBB* challenge_records;
-    std::shared_ptr<const TeamIndex::Team> team;
-    size_t num_players;
-    uint8_t event;
-    bool v1_present;
-  };
-
-  IntegralExpression(const std::string& text);
-  ~IntegralExpression() = default;
-  inline bool operator==(const IntegralExpression& other) const {
-    return this->root->operator==(*other.root);
-  }
-  inline bool operator!=(const IntegralExpression& other) const {
-    return !this->operator==(other);
-  }
-  inline int64_t evaluate(const Env& env) const {
-    return this->root->evaluate(env);
-  }
-  inline std::string str() const {
-    return this->root->str();
-  }
-
-protected:
-  class Node {
-  public:
-    virtual ~Node() = default;
-    virtual bool operator==(const Node& other) const = 0;
-    inline bool operator!=(const Node& other) const {
-      return !this->operator==(other);
-    }
-    virtual int64_t evaluate(const Env& env) const = 0;
-    virtual std::string str() const = 0;
-
-  protected:
-    Node() = default;
-  };
-
-  class BinaryOperatorNode : public Node {
-  public:
-    enum class Type {
-      LOGICAL_OR = 0,
-      LOGICAL_AND,
-      BITWISE_OR,
-      BITWISE_AND,
-      BITWISE_XOR,
-      LEFT_SHIFT,
-      RIGHT_SHIFT,
-      LESS_THAN,
-      GREATER_THAN,
-      LESS_OR_EQUAL,
-      GREATER_OR_EQUAL,
-      EQUAL,
-      NOT_EQUAL,
-      ADD,
-      SUBTRACT,
-      MULTIPLY,
-      DIVIDE,
-      MODULUS,
-    };
-    BinaryOperatorNode(Type type, std::unique_ptr<const Node>&& left, std::unique_ptr<const Node>&& right);
-    virtual ~BinaryOperatorNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-
-  protected:
-    Type type;
-    std::unique_ptr<const Node> left;
-    std::unique_ptr<const Node> right;
-  };
-
-  class UnaryOperatorNode : public Node {
-  public:
-    enum class Type {
-      LOGICAL_NOT = 0,
-      BITWISE_NOT,
-      NEGATIVE,
-    };
-    UnaryOperatorNode(Type type, std::unique_ptr<const Node>&& sub);
-    virtual ~UnaryOperatorNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-
-  protected:
-    Type type;
-    std::unique_ptr<const Node> sub;
-  };
-
-  class FlagLookupNode : public Node {
-  public:
-    FlagLookupNode(uint16_t flag_index);
-    virtual ~FlagLookupNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-
-  protected:
-    uint16_t flag_index;
-  };
-
-  class ChallengeCompletionLookupNode : public Node {
-  public:
-    ChallengeCompletionLookupNode(Episode episode, uint8_t stage_index);
-    virtual ~ChallengeCompletionLookupNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-
-  protected:
-    Episode episode;
-    uint8_t stage_index;
-  };
-
-  class TeamRewardLookupNode : public Node {
-  public:
-    TeamRewardLookupNode(const std::string& reward_name);
-    virtual ~TeamRewardLookupNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-
-  protected:
-    std::string reward_name;
-  };
-
-  class NumPlayersLookupNode : public Node {
-  public:
-    NumPlayersLookupNode();
-    virtual ~NumPlayersLookupNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-  };
-
-  class EventLookupNode : public Node {
-  public:
-    EventLookupNode();
-    virtual ~EventLookupNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-  };
-
-  class V1PresenceLookupNode : public Node {
-  public:
-    V1PresenceLookupNode();
-    virtual ~V1PresenceLookupNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-  };
-
-  class ConstantNode : public Node {
-  public:
-    ConstantNode(int64_t value);
-    virtual ~ConstantNode() = default;
-    virtual bool operator==(const Node& other) const;
-    virtual int64_t evaluate(const Env& env) const;
-    virtual std::string str() const;
-
-  protected:
-    int64_t value;
-  };
-
-  std::unique_ptr<const Node> parse_expr(std::string_view text);
-
-  std::unique_ptr<const Node> root;
-};
+#pragma once
+
+#include <stdint.h>
+
+#include <map>
+#include <memory>
+#include <string>
+#include <unordered_map>
+#include <vector>
+
+#include "PlayerSubordinates.hh"
+#include "QuestScript.hh"
+#include "StaticGameData.hh"
+#include "TeamIndex.hh"
+
+class IntegralExpression {
+public:
+  struct Env {
+    const QuestFlagsForDifficulty* flags;
+    const PlayerRecordsChallengeBB* challenge_records;
+    std::shared_ptr<const TeamIndex::Team> team;
+    size_t num_players;
+    uint8_t event;
+    bool v1_present;
+  };
+
+  IntegralExpression(const std::string& text);
+  ~IntegralExpression() = default;
+  inline bool operator==(const IntegralExpression& other) const {
+    return this->root->operator==(*other.root);
+  }
+  inline bool operator!=(const IntegralExpression& other) const {
+    return !this->operator==(other);
+  }
+  inline int64_t evaluate(const Env& env) const {
+    return this->root->evaluate(env);
+  }
+  inline std::string str() const {
+    return this->root->str();
+  }
+
+protected:
+  class Node {
+  public:
+    virtual ~Node() = default;
+    virtual bool operator==(const Node& other) const = 0;
+    inline bool operator!=(const Node& other) const {
+      return !this->operator==(other);
+    }
+    virtual int64_t evaluate(const Env& env) const = 0;
+    virtual std::string str() const = 0;
+
+  protected:
+    Node() = default;
+  };
+
+  class BinaryOperatorNode : public Node {
+  public:
+    enum class Type {
+      LOGICAL_OR = 0,
+      LOGICAL_AND,
+      BITWISE_OR,
+      BITWISE_AND,
+      BITWISE_XOR,
+      LEFT_SHIFT,
+      RIGHT_SHIFT,
+      LESS_THAN,
+      GREATER_THAN,
+      LESS_OR_EQUAL,
+      GREATER_OR_EQUAL,
+      EQUAL,
+      NOT_EQUAL,
+      ADD,
+      SUBTRACT,
+      MULTIPLY,
+      DIVIDE,
+      MODULUS,
+    };
+    BinaryOperatorNode(Type type, std::unique_ptr<const Node>&& left, std::unique_ptr<const Node>&& right);
+    virtual ~BinaryOperatorNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+
+  protected:
+    Type type;
+    std::unique_ptr<const Node> left;
+    std::unique_ptr<const Node> right;
+  };
+
+  class UnaryOperatorNode : public Node {
+  public:
+    enum class Type {
+      LOGICAL_NOT = 0,
+      BITWISE_NOT,
+      NEGATIVE,
+    };
+    UnaryOperatorNode(Type type, std::unique_ptr<const Node>&& sub);
+    virtual ~UnaryOperatorNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+
+  protected:
+    Type type;
+    std::unique_ptr<const Node> sub;
+  };
+
+  class FlagLookupNode : public Node {
+  public:
+    FlagLookupNode(uint16_t flag_index);
+    virtual ~FlagLookupNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+
+  protected:
+    uint16_t flag_index;
+  };
+
+  class ChallengeCompletionLookupNode : public Node {
+  public:
+    ChallengeCompletionLookupNode(Episode episode, uint8_t stage_index);
+    virtual ~ChallengeCompletionLookupNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+
+  protected:
+    Episode episode;
+    uint8_t stage_index;
+  };
+
+  class TeamRewardLookupNode : public Node {
+  public:
+    TeamRewardLookupNode(const std::string& reward_name);
+    virtual ~TeamRewardLookupNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+
+  protected:
+    std::string reward_name;
+  };
+
+  class NumPlayersLookupNode : public Node {
+  public:
+    NumPlayersLookupNode();
+    virtual ~NumPlayersLookupNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+  };
+
+  class EventLookupNode : public Node {
+  public:
+    EventLookupNode();
+    virtual ~EventLookupNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+  };
+
+  class V1PresenceLookupNode : public Node {
+  public:
+    V1PresenceLookupNode();
+    virtual ~V1PresenceLookupNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+  };
+
+  class ConstantNode : public Node {
+  public:
+    ConstantNode(int64_t value);
+    virtual ~ConstantNode() = default;
+    virtual bool operator==(const Node& other) const;
+    virtual int64_t evaluate(const Env& env) const;
+    virtual std::string str() const;
+
+  protected:
+    int64_t value;
+  };
+
+  std::unique_ptr<const Node> parse_expr(std::string_view text);
+
+  std::unique_ptr<const Node> root;
+};

src/ItemCreator.cc

@@ -7,6 +7,17 @@
 
 using namespace std;
 
+// The favored weapon type table is hardcoded in the game client. The table is:
+//   Viridia     shots
+//   Greennill   rifles
+//   Skyly       swords
+//   Bluefull    partisans
+//   Purplenum   mechguns
+//   Pinkal      canes
+//   Redria      (none)
+//   Oran        daggers
+//   Yellowboze  (none)
+//   Whitill     slicers
 static const array<uint8_t, 10> favored_weapon_by_section_id = {
     0x09, 0x07, 0x02, 0x04, 0x08, 0x0A, 0xFF, 0x03, 0xFF, 0x05};
 
@@ -472,7 +483,7 @@ void ItemCreator::deduplicate_weapon_bonuses(ItemData& item) const {
 void ItemCreator::set_item_kill_count_if_unsealable(ItemData& item) const {
   if (this->item_parameter_table->is_unsealable_item(item)) {
     this->log.info("Item is unsealable; setting kill count to zero");
-    item.set_sealed_item_kill_count(0);
+    item.set_kill_count(0);
   }
 }
 
@@ -1439,78 +1450,78 @@ vector<ItemData> ItemCreator::generate_weapon_shop_contents(size_t player_level)
 
     } else {
       static const vector<pair<uint8_t, uint8_t>> defs({
-          {0x01, 0x00},
-          {0x01, 0x01},
-          {0x01, 0x02},
-          {0x01, 0x03},
-          {0x01, 0x04},
-          {0x03, 0x00},
-          {0x03, 0x01},
-          {0x03, 0x02},
-          {0x03, 0x03},
-          {0x03, 0x04},
-          {0x02, 0x00},
-          {0x02, 0x01},
-          {0x02, 0x02},
-          {0x02, 0x03},
-          {0x02, 0x04},
-          {0x05, 0x00},
-          {0x05, 0x01},
-          {0x05, 0x02},
-          {0x05, 0x03},
-          {0x05, 0x04},
-          {0x04, 0x00},
-          {0x04, 0x01},
-          {0x04, 0x02},
-          {0x04, 0x03},
-          {0x04, 0x04},
-          {0x06, 0x00},
-          {0x06, 0x01},
-          {0x06, 0x02},
-          {0x06, 0x03},
-          {0x06, 0x04},
-          {0x07, 0x00},
-          {0x07, 0x01},
-          {0x07, 0x02},
-          {0x07, 0x03},
-          {0x07, 0x04},
-          {0x08, 0x00},
-          {0x08, 0x01},
-          {0x08, 0x02},
-          {0x08, 0x03},
-          {0x08, 0x04},
-          {0x09, 0x00},
-          {0x09, 0x01},
-          {0x09, 0x02},
-          {0x09, 0x03},
-          {0x09, 0x04},
-          {0x0A, 0x00},
-          {0x0A, 0x01},
-          {0x0A, 0x02},
-          {0x0A, 0x03},
-          {0x0B, 0x00},
-          {0x0B, 0x01},
-          {0x0B, 0x02},
-          {0x0B, 0x03},
-          {0x0C, 0x00},
-          {0x0C, 0x01},
-          {0x0C, 0x02},
-          {0x0C, 0x03},
-          {0xFF, 0xFF},
-          {0xFF, 0xFF},
-          {0x01, 0x05},
-          {0x02, 0x05},
-          {0x06, 0x05},
-          {0x08, 0x05},
-          {0x0A, 0x04},
-          {0x0C, 0x04},
-          {0x0B, 0x04},
-          {0x01, 0x06},
-          {0x03, 0x05},
-          {0x07, 0x05},
-          {0x0A, 0x05},
-          {0x0C, 0x05},
-          {0x0B, 0x05},
+          /* 00 */ {0x01, 0x00},
+          /* 01 */ {0x01, 0x01},
+          /* 02 */ {0x01, 0x02},
+          /* 03 */ {0x01, 0x03},
+          /* 04 */ {0x01, 0x04},
+          /* 05 */ {0x03, 0x00},
+          /* 06 */ {0x03, 0x01},
+          /* 07 */ {0x03, 0x02},
+          /* 08 */ {0x03, 0x03},
+          /* 09 */ {0x03, 0x04},
+          /* 0A */ {0x02, 0x00},
+          /* 0B */ {0x02, 0x01},
+          /* 0C */ {0x02, 0x02},
+          /* 0D */ {0x02, 0x03},
+          /* 0E */ {0x02, 0x04},
+          /* 0F */ {0x05, 0x00},
+          /* 10 */ {0x05, 0x01},
+          /* 11 */ {0x05, 0x02},
+          /* 12 */ {0x05, 0x03},
+          /* 13 */ {0x05, 0x04},
+          /* 14 */ {0x04, 0x00},
+          /* 15 */ {0x04, 0x01},
+          /* 16 */ {0x04, 0x02},
+          /* 17 */ {0x04, 0x03},
+          /* 18 */ {0x04, 0x04},
+          /* 19 */ {0x06, 0x00},
+          /* 1A */ {0x06, 0x01},
+          /* 1B */ {0x06, 0x02},
+          /* 1C */ {0x06, 0x03},
+          /* 1D */ {0x06, 0x04},
+          /* 1E */ {0x07, 0x00},
+          /* 1F */ {0x07, 0x01},
+          /* 20 */ {0x07, 0x02},
+          /* 21 */ {0x07, 0x03},
+          /* 22 */ {0x07, 0x04},
+          /* 23 */ {0x08, 0x00},
+          /* 24 */ {0x08, 0x01},
+          /* 25 */ {0x08, 0x02},
+          /* 26 */ {0x08, 0x03},
+          /* 27 */ {0x08, 0x04},
+          /* 28 */ {0x09, 0x00},
+          /* 29 */ {0x09, 0x01},
+          /* 2A */ {0x09, 0x02},
+          /* 2B */ {0x09, 0x03},
+          /* 2C */ {0x09, 0x04},
+          /* 2D */ {0x0A, 0x00},
+          /* 2E */ {0x0A, 0x01},
+          /* 2F */ {0x0A, 0x02},
+          /* 30 */ {0x0A, 0x03},
+          /* 31 */ {0x0B, 0x00},
+          /* 32 */ {0x0B, 0x01},
+          /* 33 */ {0x0B, 0x02},
+          /* 34 */ {0x0B, 0x03},
+          /* 35 */ {0x0C, 0x00},
+          /* 36 */ {0x0C, 0x01},
+          /* 37 */ {0x0C, 0x02},
+          /* 38 */ {0x0C, 0x03},
+          /* 39 */ {0xFF, 0xFF}, // Special-cased above
+          /* 3A */ {0xFF, 0xFF}, // Special-cased above
+          /* 3B */ {0x01, 0x05},
+          /* 3C */ {0x02, 0x05},
+          /* 3D */ {0x06, 0x05},
+          /* 3E */ {0x08, 0x05},
+          /* 3F */ {0x0A, 0x04},
+          /* 40 */ {0x0C, 0x04},
+          /* 41 */ {0x0B, 0x04},
+          /* 42 */ {0x01, 0x06},
+          /* 43 */ {0x03, 0x05},
+          /* 44 */ {0x07, 0x05},
+          /* 45 */ {0x0A, 0x05},
+          /* 46 */ {0x0C, 0x05},
+          /* 47 */ {0x0B, 0x05},
       });
       const auto& def = defs.at(which);
       item.data1[0] = 0;
@@ -1556,10 +1567,8 @@ void ItemCreator::generate_weapon_shop_item_grind(ItemData& item, size_t player_
       ? this->weapon_random_set->get_favored_grind_range(table_index)
       : this->weapon_random_set->get_standard_grind_range(table_index);
 
-  const auto& weapon_def = this->item_parameter_table->get_weapon(
-      item.data1[1], item.data1[2]);
-  item.data1[3] = clamp<uint8_t>(
-      this->rand_int(range->max + 1), range->min, weapon_def.max_grind);
+  const auto& weapon_def = this->item_parameter_table->get_weapon(item.data1[1], item.data1[2]);
+  item.data1[3] = clamp<uint8_t>(this->rand_int(range->max + 1), range->min, weapon_def.max_grind);
 }
 
 void ItemCreator::generate_weapon_shop_item_special(ItemData& item, size_t player_level) {

src/ItemCreator.hh

@@ -83,6 +83,24 @@ private:
 
   // Note: The original implementation uses 17 different random states for some
   // reason. We forego that and use only one for simplicity.
+  // Originally, the 17 random states were used for:
+  //   [0x00] - drop-anything rate check
+  //   [0x01] - common item class check
+  //   [0x02] - get_rand_from_weighted_tables16 determinants
+  //   [0x03] - get_rand_from_weighted_tables8 determinants
+  //   [0x04] - tech disk levels
+  //   [0x05] - meseta amounts
+  //   [0x06] - rare drop rate check
+  //   [0x07] - rare weapon special table index
+  //   [0x08] - apparently unused
+  //   [0x09] - whether to generate a common weapon special
+  //   [0x0A] - number of stars for common weapon special
+  //   [0x0B] - unit modifiers
+  //   [0x0C] - common armor DFP bonuses
+  //   [0x0D] - common armor EVP bonuses
+  //   [0x0E] - apparently unused
+  //   [0x0F] - which common weapon special to generate
+  //   [0x10] - apparently unused
   std::shared_ptr<PSOLFGEncryption> opt_rand_crypt;
 
   bool are_rare_drops_allowed() const;

src/ItemData.cc

@@ -431,7 +431,10 @@ void ItemData::decode_for_version(Version from_version) {
 }
 
 void ItemData::encode_for_version(Version to_version, shared_ptr<const ItemParameterTable> item_parameter_table) {
-  bool should_encode_v2_data = (is_v1(to_version) || is_v2(to_version)) && (to_version != Version::GC_NTE) && !this->has_encoded_v2_data();
+  bool should_encode_v2_data = item_parameter_table &&
+      (is_v1(to_version) || is_v2(to_version)) &&
+      (to_version != Version::GC_NTE) &&
+      !this->has_encoded_v2_data();
 
   switch (this->data1[0]) {
     case 0x00:
@@ -534,16 +537,22 @@ bool ItemData::has_encoded_v2_data() const {
       : (this->get_encoded_v2_data() != 0);
 }
 
-uint16_t ItemData::get_sealed_item_kill_count() const {
-  return ((this->data1[10] << 8) | this->data1[11]) & 0x7FFF;
+bool ItemData::has_kill_count() const {
+  return !this->is_s_rank_weapon() && (this->data1[10] & 0x80);
 }
 
-void ItemData::set_sealed_item_kill_count(uint16_t v) {
-  if (v > 0x7FFF) {
-    this->data1w[5] = 0xFFFF;
-  } else {
-    this->data1[10] = (v >> 8) | 0x80;
-    this->data1[11] = v;
+uint16_t ItemData::get_kill_count() const {
+  return this->has_kill_count() ? (((this->data1[10] << 8) | this->data1[11]) & 0x7FFF) : 0;
+}
+
+void ItemData::set_kill_count(uint16_t v) {
+  if (!this->is_s_rank_weapon()) {
+    if (v > 0x7FFF) {
+      this->data1w[5] = 0xFFFF;
+    } else {
+      this->data1[10] = (v >> 8) | 0x80;
+      this->data1[11] = v;
+    }
   }
 }
 

src/ItemData.hh

@@ -84,6 +84,7 @@ struct ItemData {
   //   Mag:    02ZZLLWW HHHHIIII JJJJKKKK YYQQPPVV
   //   Tool:   03ZZZZFF 00CC0000 00000000 00000000
   //   Meseta: 04000000 00000000 00000000 MMMMMMMM
+  // 01034D00 00000000 204E0000
   // A = attribute type (for S-ranks, custom name)
   // B = attribute amount (for S-ranks, custom name)
   // C = stack size (for tools)
@@ -173,8 +174,9 @@ struct ItemData {
   uint8_t get_encoded_v2_data() const;
   bool has_encoded_v2_data() const;
 
-  uint16_t get_sealed_item_kill_count() const;
-  void set_sealed_item_kill_count(uint16_t v);
+  bool has_kill_count() const;
+  uint16_t get_kill_count() const;
+  void set_kill_count(uint16_t v);
   uint8_t get_tool_item_amount(const StackLimits& limits) const;
   void set_tool_item_amount(const StackLimits& limits, uint8_t amount);
   int16_t get_armor_or_shield_defense_bonus() const;

src/ItemNameIndex.cc

@@ -208,7 +208,10 @@ std::string ItemNameIndex::describe_item(const ItemData& item, bool include_colo
         if (which == 0) {
           continue;
         }
-        if (which > 5) {
+        if (which & 0x80) {
+          uint16_t kill_count = ((which << 8) & 0x7F00) | (value & 0xFF);
+          ret_tokens.emplace_back(string_printf("K:%hu", kill_count));
+        } else if (which > 5) {
           ret_tokens.emplace_back(string_printf("!PC:%02hhX%02hhX", which, value));
         } else {
           bonuses[which - 1] = value;
@@ -217,13 +220,14 @@ std::string ItemNameIndex::describe_item(const ItemData& item, bool include_colo
       if (!bonuses.is_filled_with(0)) {
         bool should_include_hit = (bonuses[4] != 0);
         bool should_highlight_hit = include_color_escapes && (bonuses[4] > 0);
+        const char* color_prefix = include_color_escapes ? "$C7" : "";
         if (should_include_hit) {
-          ret_tokens.emplace_back(string_printf("%hhd/%hhd/%hhd/%hhd/%s%hhd",
-              bonuses[0], bonuses[1], bonuses[2], bonuses[3],
-              (should_highlight_hit ? "$CG" : ""), bonuses[4]));
+          ret_tokens.emplace_back(string_printf("%s%hhd/%hhd/%hhd/%hhd/%s%hhd",
+              color_prefix, bonuses[0], bonuses[1], bonuses[2], bonuses[3],
+              (should_highlight_hit ? "$C6" : ""), bonuses[4]));
         } else {
-          ret_tokens.emplace_back(string_printf("%hhd/%hhd/%hhd/%hhd",
-              bonuses[0], bonuses[1], bonuses[2], bonuses[3]));
+          ret_tokens.emplace_back(string_printf("%s%hhd/%hhd/%hhd/%hhd",
+              color_prefix, bonuses[0], bonuses[1], bonuses[2], bonuses[3]));
         }
       }
     }
@@ -848,7 +852,7 @@ void ItemNameIndex::print_table(FILE* stream) const {
           t.amount.load(),
           t.tech.load(),
           t.cost.load(),
-          t.item_flag.load(),
+          t.item_flags.load(),
           stars,
           divisor_str.c_str(),
           name.c_str());

src/ItemParameterTable.cc

@@ -397,7 +397,7 @@ ItemParameterTable::ToolV4 ItemParameterTable::ToolV1V2::to_v4() const {
   ret.amount = this->amount;
   ret.tech = this->tech;
   ret.cost = this->cost;
-  ret.item_flag = this->item_flag;
+  ret.item_flags = this->item_flags;
   return ret;
 }
 
@@ -410,7 +410,7 @@ ItemParameterTable::ToolV4 ItemParameterTable::ToolV3T<IsBigEndian>::to_v4() con
   ret.amount = this->amount.load();
   ret.tech = this->tech.load();
   ret.cost = this->cost.load();
-  ret.item_flag = this->item_flag.load();
+  ret.item_flags = this->item_flags.load();
   return ret;
 }
 
@@ -1008,7 +1008,7 @@ uint8_t ItemParameterTable::get_item_base_stars(const ItemData& item) const {
     const auto& def = (item.data1[1] == 2)
         ? this->get_tool(2, item.data1[4])
         : this->get_tool(item.data1[1], item.data1[2]);
-    return (def.item_flag & 0x80) ? 12 : 0;
+    return (def.item_flags & 0x80) ? 12 : 0;
   } else {
     return 0;
   }

src/ItemParameterTable.hh

@@ -341,7 +341,16 @@ public:
     /* 04 */ U16T amount = 0;
     /* 06 */ U16T tech = 0;
     /* 08 */ S32T cost = 0;
-    /* 0C */ U32T item_flag = 0;
+    // Bits in item_flags:
+    //   00000001 - ever usable by player ("Use" appears in inventory menu)
+    //   00000002 - unknown
+    //   00000004 - unknown
+    //   00000008 - usable by android characters
+    //   00000010 - usable in Pioneer 2 / Lab
+    //   00000020 - usable in boss arenas
+    //   00000040 - usable in Challenge mode
+    //   00000080 - is rare (renders as red box; V3+)
+    /* 0C */ U32T item_flags = 0;
     /* 10 */
   } __packed__;
 

src/Items.hh

@@ -1,25 +1,25 @@
-#pragma once
-
-#include <stdint.h>
-
-#include <memory>
-#include <random>
-
-#include "Client.hh"
-#include "ItemData.hh"
-#include "ItemParameterTable.hh"
-#include "PSOEncryption.hh"
-#include "ServerState.hh"
-#include "StaticGameData.hh"
-
-void player_use_item(std::shared_ptr<Client> c, size_t item_index, std::shared_ptr<PSOLFGEncryption> opt_rand_crypt);
-void player_feed_mag(std::shared_ptr<Client> c, size_t mag_item_index, size_t fed_item_index);
-
-void apply_mag_feed_result(
-    ItemData& mag_item,
-    const ItemData& fed_item,
-    std::shared_ptr<const ItemParameterTable> item_parameter_table,
-    std::shared_ptr<const MagEvolutionTable> mag_evolution_table,
-    uint8_t char_class,
-    uint8_t section_id,
-    bool version_has_rare_mags);
+#pragma once
+
+#include <stdint.h>
+
+#include <memory>
+#include <random>
+
+#include "Client.hh"
+#include "ItemData.hh"
+#include "ItemParameterTable.hh"
+#include "PSOEncryption.hh"
+#include "ServerState.hh"
+#include "StaticGameData.hh"
+
+void player_use_item(std::shared_ptr<Client> c, size_t item_index, std::shared_ptr<PSOLFGEncryption> opt_rand_crypt);
+void player_feed_mag(std::shared_ptr<Client> c, size_t mag_item_index, size_t fed_item_index);
+
+void apply_mag_feed_result(
+    ItemData& mag_item,
+    const ItemData& fed_item,
+    std::shared_ptr<const ItemParameterTable> item_parameter_table,
+    std::shared_ptr<const MagEvolutionTable> mag_evolution_table,
+    uint8_t char_class,
+    uint8_t section_id,
+    bool version_has_rare_mags);

src/LevelTable.cc

@@ -1,190 +1,190 @@
-#include "LevelTable.hh"
-
-#include <string.h>
-
-#include <phosg/Filesystem.hh>
-
-#include "Compression.hh"
-#include "PSOEncryption.hh"
-
-using namespace std;
-
-void LevelTable::reset_to_base(PlayerStats& stats, uint8_t char_class) const {
-  stats.level = 0;
-  stats.experience = 0;
-  stats.char_stats = this->base_stats_for_class(char_class);
-}
-
-void LevelTable::advance_to_level(PlayerStats& stats, uint32_t level, uint8_t char_class) const {
-  for (; stats.level < level; stats.level++) {
-    const auto& level_stats = this->stats_delta_for_level(char_class, stats.level + 1);
-    // The original code clamps the resulting stat values to [0, max_stat]; we
-    // don't have max_stat handy so we just allow them to be unbounded
-    stats.char_stats.atp += level_stats.atp;
-    stats.char_stats.mst += level_stats.mst;
-    stats.char_stats.evp += level_stats.evp;
-    stats.char_stats.hp += level_stats.hp;
-    stats.char_stats.dfp += level_stats.dfp;
-    stats.char_stats.ata += level_stats.ata;
-    // Note: It is not a bug that lck is ignored here; the original code
-    // ignores it too.
-    stats.experience = level_stats.experience;
-  }
-}
-
-LevelTableV2::LevelTableV2(const string& data, bool compressed) {
-  struct Offsets {
-    // TODO: The overall format of this file on V2 has much more data than we
-    // actually use. What's known of the structure so far:
-    le_uint32_t level_deltas; // -> u32[9] -> LevelStatsDelta[200]
-    le_uint32_t unknown_a1; // -> float[6]
-    le_uint32_t max_stats; // -> PlayerStats[9]
-    le_uint32_t level_100_stats; // -> Level100Entry[9]
-    le_uint32_t base_stats; // -> u32[9] -> CharacterStats
-    le_uint32_t unknown_a2; // -> (0x120 zero bytes)
-    le_uint32_t attack_data; // -> AttackData[9]
-    le_uint32_t unknown_a4; // -> (0x14-byte struct)[9]
-    le_uint32_t unknown_a5; // -> float[9]
-    le_uint32_t unknown_a6; // -> (0x30 bytes)
-    le_uint32_t unknown_a7; // -> (0x2D bytes)
-    le_uint32_t unknown_a8; // -> u32[3] -> float[0x2D]
-    le_uint32_t unknown_a9; // -> (0x90 bytes)
-    le_uint32_t unknown_a10; // -> u32[3] -> (0x10-byte struct)[0x0C]
-    le_uint32_t unknown_a11; // -> u32[3] -> (0x30-bytes)
-    le_uint32_t unknown_a12; // -> u32[3] -> (0x14-byte struct)[0x0F]
-  } __packed_ws__(Offsets, 0x40);
-
-  StringReader r;
-  string decompressed_data;
-  if (compressed) {
-    decompressed_data = prs_decompress(data);
-    r = StringReader(decompressed_data);
-  } else {
-    r = StringReader(data);
-  }
-
-  const auto& offsets = r.pget<Offsets>(r.pget_u32l(r.size() - 0x10));
-  const auto& level_deltas_offsets = r.pget<parray<le_uint32_t, 9>>(offsets.level_deltas);
-  const auto& base_stats_offsets = r.pget<parray<le_uint32_t, 9>>(offsets.base_stats);
-  for (size_t char_class = 0; char_class < 9; char_class++) {
-    const auto& src_level_deltas = r.pget<parray<LevelStatsDelta, 200>>(level_deltas_offsets[char_class]);
-    for (size_t level = 0; level < 200; level++) {
-      this->level_deltas[char_class][level] = src_level_deltas[level];
-    }
-    this->max_stats[char_class] = r.pget<PlayerStats>(offsets.max_stats + char_class * sizeof(PlayerStats));
-    this->level_100_stats[char_class] = r.pget<Level100Entry>(offsets.level_100_stats + char_class * sizeof(Level100Entry));
-    this->base_stats[char_class] = r.pget<CharacterStats>(base_stats_offsets[char_class]);
-  }
-}
-
-const CharacterStats& LevelTableV2::base_stats_for_class(uint8_t char_class) const {
-  return this->base_stats.at(char_class);
-}
-
-const LevelTableV2::Level100Entry& LevelTableV2::level_100_stats_for_class(uint8_t char_class) const {
-  return this->level_100_stats.at(char_class);
-}
-
-const PlayerStats& LevelTableV2::max_stats_for_class(uint8_t char_class) const {
-  return this->max_stats.at(char_class);
-}
-
-const LevelStatsDelta& LevelTableV2::stats_delta_for_level(uint8_t char_class, uint8_t level) const {
-  return this->level_deltas.at(char_class).at(level);
-}
-
-LevelTableV3BE::LevelTableV3BE(const string& data, bool encrypted) {
-  StringReader r;
-  string decompressed_data;
-  if (encrypted) {
-    auto decrypted = decrypt_pr2_data<true>(data);
-    decompressed_data = prs_decompress(decrypted.compressed_data);
-    if (decompressed_data.size() != decrypted.decompressed_size) {
-      throw runtime_error("decompressed data size does not match expected size");
-    }
-    r = StringReader(decompressed_data);
-  } else {
-    r = StringReader(data);
-  }
-
-  // The GC format is very simple (but everything is big-endian):
-  //   root:
-  //     u32 offset:
-  //       u32[12] offsets:
-  //         LevelStatsDeltaBE[200] level_deltas
-  const auto& offsets = r.pget<parray<be_uint32_t, 12>>(r.pget_u32b(r.pget_u32b(r.size() - 0x10)));
-  for (size_t char_class = 0; char_class < 12; char_class++) {
-    const auto& src_deltas = r.pget<parray<LevelStatsDeltaBE, 200>>(offsets[char_class]);
-    for (size_t level = 0; level < 200; level++) {
-      const auto& src_delta = src_deltas[level];
-      auto& dest_delta = this->level_deltas[char_class][level];
-      dest_delta.atp = src_delta.atp;
-      dest_delta.mst = src_delta.mst;
-      dest_delta.evp = src_delta.evp;
-      dest_delta.hp = src_delta.hp;
-      dest_delta.dfp = src_delta.dfp;
-      dest_delta.ata = src_delta.ata;
-      dest_delta.lck = src_delta.lck;
-      dest_delta.tp = src_delta.tp;
-      dest_delta.experience = src_delta.experience.load();
-    }
-  }
-}
-
-const CharacterStats& LevelTableV3BE::base_stats_for_class(uint8_t char_class) const {
-  static const array<CharacterStats, 12> data = {
-      //                ATP     MST     EVP      HP     DFP     ATA     LCK
-      CharacterStats{0x0023, 0x001D, 0x002D, 0x0014, 0x0011, 0x001E, 0x000A},
-      CharacterStats{0x001E, 0x0028, 0x003C, 0x0013, 0x0016, 0x0019, 0x000A},
-      CharacterStats{0x0023, 0x0000, 0x0023, 0x0016, 0x0012, 0x0023, 0x000A},
-      CharacterStats{0x0012, 0x0014, 0x0024, 0x0010, 0x000D, 0x0028, 0x000A},
-      CharacterStats{0x0019, 0x0000, 0x001F, 0x0012, 0x0012, 0x002D, 0x000A},
-      CharacterStats{0x0014, 0x0000, 0x001F, 0x0011, 0x0017, 0x002D, 0x000A},
-      CharacterStats{0x000D, 0x0035, 0x0023, 0x0014, 0x000A, 0x000F, 0x000A},
-      CharacterStats{0x000D, 0x003C, 0x0032, 0x0013, 0x0007, 0x000C, 0x000A},
-      CharacterStats{0x000A, 0x003A, 0x0035, 0x0013, 0x000D, 0x000A, 0x000A},
-      CharacterStats{0x0023, 0x0000, 0x0023, 0x0016, 0x0012, 0x0023, 0x000A},
-      CharacterStats{0x000D, 0x0035, 0x0023, 0x0014, 0x000A, 0x000F, 0x000A},
-      CharacterStats{0x0012, 0x0014, 0x0024, 0x0010, 0x000D, 0x0028, 0x000A},
-  };
-  return data.at(char_class);
-}
-
-const LevelStatsDelta& LevelTableV3BE::stats_delta_for_level(uint8_t char_class, uint8_t level) const {
-  return this->level_deltas.at(char_class).at(level);
-}
-
-LevelTableV4::LevelTableV4(const string& data, bool compressed) {
-  struct Offsets {
-    le_uint32_t base_stats; // -> u32[12] -> CharacterStats
-    le_uint32_t level_deltas; // -> u32[12] -> LevelStatsDelta[200]
-  } __packed_ws__(Offsets, 8);
-
-  StringReader r;
-  string decompressed_data;
-  if (compressed) {
-    decompressed_data = prs_decompress(data);
-    r = StringReader(decompressed_data);
-  } else {
-    r = StringReader(data);
-  }
-
-  const auto& offsets = r.pget<Offsets>(r.pget_u32l(r.size() - 0x10));
-  const auto& level_deltas_offsets = r.pget<parray<le_uint32_t, 12>>(offsets.level_deltas);
-  const auto& base_stats_offsets = r.pget<parray<le_uint32_t, 12>>(offsets.base_stats);
-  for (size_t char_class = 0; char_class < 12; char_class++) {
-    const auto& src_level_deltas = r.pget<parray<LevelStatsDelta, 200>>(level_deltas_offsets[char_class]);
-    for (size_t level = 0; level < 200; level++) {
-      this->level_deltas[char_class][level] = src_level_deltas[level];
-    }
-    this->base_stats[char_class] = r.pget<CharacterStats>(base_stats_offsets[char_class]);
-  }
-}
-
-const CharacterStats& LevelTableV4::base_stats_for_class(uint8_t char_class) const {
-  return this->base_stats.at(char_class);
-}
-
-const LevelStatsDelta& LevelTableV4::stats_delta_for_level(uint8_t char_class, uint8_t level) const {
-  return this->level_deltas.at(char_class).at(level);
-}
+#include "LevelTable.hh"
+
+#include <string.h>
+
+#include <phosg/Filesystem.hh>
+
+#include "Compression.hh"
+#include "PSOEncryption.hh"
+
+using namespace std;
+
+void LevelTable::reset_to_base(PlayerStats& stats, uint8_t char_class) const {
+  stats.level = 0;
+  stats.experience = 0;
+  stats.char_stats = this->base_stats_for_class(char_class);
+}
+
+void LevelTable::advance_to_level(PlayerStats& stats, uint32_t level, uint8_t char_class) const {
+  for (; stats.level < level; stats.level++) {
+    const auto& level_stats = this->stats_delta_for_level(char_class, stats.level + 1);
+    // The original code clamps the resulting stat values to [0, max_stat]; we
+    // don't have max_stat handy so we just allow them to be unbounded
+    stats.char_stats.atp += level_stats.atp;
+    stats.char_stats.mst += level_stats.mst;
+    stats.char_stats.evp += level_stats.evp;
+    stats.char_stats.hp += level_stats.hp;
+    stats.char_stats.dfp += level_stats.dfp;
+    stats.char_stats.ata += level_stats.ata;
+    // Note: It is not a bug that lck is ignored here; the original code
+    // ignores it too.
+    stats.experience = level_stats.experience;
+  }
+}
+
+LevelTableV2::LevelTableV2(const string& data, bool compressed) {
+  struct Offsets {
+    // TODO: The overall format of this file on V2 has much more data than we
+    // actually use. What's known of the structure so far:
+    le_uint32_t level_deltas; // -> u32[9] -> LevelStatsDelta[200]
+    le_uint32_t unknown_a1; // -> float[6]
+    le_uint32_t max_stats; // -> PlayerStats[9]
+    le_uint32_t level_100_stats; // -> Level100Entry[9]
+    le_uint32_t base_stats; // -> u32[9] -> CharacterStats
+    le_uint32_t unknown_a2; // -> (0x120 zero bytes)
+    le_uint32_t attack_data; // -> AttackData[9]
+    le_uint32_t unknown_a4; // -> (0x14-byte struct)[9]
+    le_uint32_t unknown_a5; // -> float[9]
+    le_uint32_t unknown_a6; // -> (0x30 bytes)
+    le_uint32_t unknown_a7; // -> (0x2D bytes)
+    le_uint32_t unknown_a8; // -> u32[3] -> float[0x2D]
+    le_uint32_t unknown_a9; // -> (0x90 bytes)
+    le_uint32_t unknown_a10; // -> u32[3] -> (0x10-byte struct)[0x0C]
+    le_uint32_t unknown_a11; // -> u32[3] -> (0x30-bytes)
+    le_uint32_t unknown_a12; // -> u32[3] -> (0x14-byte struct)[0x0F]
+  } __packed_ws__(Offsets, 0x40);
+
+  StringReader r;
+  string decompressed_data;
+  if (compressed) {
+    decompressed_data = prs_decompress(data);
+    r = StringReader(decompressed_data);
+  } else {
+    r = StringReader(data);
+  }
+
+  const auto& offsets = r.pget<Offsets>(r.pget_u32l(r.size() - 0x10));
+  const auto& level_deltas_offsets = r.pget<parray<le_uint32_t, 9>>(offsets.level_deltas);
+  const auto& base_stats_offsets = r.pget<parray<le_uint32_t, 9>>(offsets.base_stats);
+  for (size_t char_class = 0; char_class < 9; char_class++) {
+    const auto& src_level_deltas = r.pget<parray<LevelStatsDelta, 200>>(level_deltas_offsets[char_class]);
+    for (size_t level = 0; level < 200; level++) {
+      this->level_deltas[char_class][level] = src_level_deltas[level];
+    }
+    this->max_stats[char_class] = r.pget<PlayerStats>(offsets.max_stats + char_class * sizeof(PlayerStats));
+    this->level_100_stats[char_class] = r.pget<Level100Entry>(offsets.level_100_stats + char_class * sizeof(Level100Entry));
+    this->base_stats[char_class] = r.pget<CharacterStats>(base_stats_offsets[char_class]);
+  }
+}
+
+const CharacterStats& LevelTableV2::base_stats_for_class(uint8_t char_class) const {
+  return this->base_stats.at(char_class);
+}
+
+const LevelTableV2::Level100Entry& LevelTableV2::level_100_stats_for_class(uint8_t char_class) const {
+  return this->level_100_stats.at(char_class);
+}
+
+const PlayerStats& LevelTableV2::max_stats_for_class(uint8_t char_class) const {
+  return this->max_stats.at(char_class);
+}
+
+const LevelStatsDelta& LevelTableV2::stats_delta_for_level(uint8_t char_class, uint8_t level) const {
+  return this->level_deltas.at(char_class).at(level);
+}
+
+LevelTableV3BE::LevelTableV3BE(const string& data, bool encrypted) {
+  StringReader r;
+  string decompressed_data;
+  if (encrypted) {
+    auto decrypted = decrypt_pr2_data<true>(data);
+    decompressed_data = prs_decompress(decrypted.compressed_data);
+    if (decompressed_data.size() != decrypted.decompressed_size) {
+      throw runtime_error("decompressed data size does not match expected size");
+    }
+    r = StringReader(decompressed_data);
+  } else {
+    r = StringReader(data);
+  }
+
+  // The GC format is very simple (but everything is big-endian):
+  //   root:
+  //     u32 offset:
+  //       u32[12] offsets:
+  //         LevelStatsDeltaBE[200] level_deltas
+  const auto& offsets = r.pget<parray<be_uint32_t, 12>>(r.pget_u32b(r.pget_u32b(r.size() - 0x10)));
+  for (size_t char_class = 0; char_class < 12; char_class++) {
+    const auto& src_deltas = r.pget<parray<LevelStatsDeltaBE, 200>>(offsets[char_class]);
+    for (size_t level = 0; level < 200; level++) {
+      const auto& src_delta = src_deltas[level];
+      auto& dest_delta = this->level_deltas[char_class][level];
+      dest_delta.atp = src_delta.atp;
+      dest_delta.mst = src_delta.mst;
+      dest_delta.evp = src_delta.evp;
+      dest_delta.hp = src_delta.hp;
+      dest_delta.dfp = src_delta.dfp;
+      dest_delta.ata = src_delta.ata;
+      dest_delta.lck = src_delta.lck;
+      dest_delta.tp = src_delta.tp;
+      dest_delta.experience = src_delta.experience.load();
+    }
+  }
+}
+
+const CharacterStats& LevelTableV3BE::base_stats_for_class(uint8_t char_class) const {
+  static const array<CharacterStats, 12> data = {
+      //                ATP     MST     EVP      HP     DFP     ATA     LCK
+      CharacterStats{0x0023, 0x001D, 0x002D, 0x0014, 0x0011, 0x001E, 0x000A},
+      CharacterStats{0x001E, 0x0028, 0x003C, 0x0013, 0x0016, 0x0019, 0x000A},
+      CharacterStats{0x0023, 0x0000, 0x0023, 0x0016, 0x0012, 0x0023, 0x000A},
+      CharacterStats{0x0012, 0x0014, 0x0024, 0x0010, 0x000D, 0x0028, 0x000A},
+      CharacterStats{0x0019, 0x0000, 0x001F, 0x0012, 0x0012, 0x002D, 0x000A},
+      CharacterStats{0x0014, 0x0000, 0x001F, 0x0011, 0x0017, 0x002D, 0x000A},
+      CharacterStats{0x000D, 0x0035, 0x0023, 0x0014, 0x000A, 0x000F, 0x000A},
+      CharacterStats{0x000D, 0x003C, 0x0032, 0x0013, 0x0007, 0x000C, 0x000A},
+      CharacterStats{0x000A, 0x003A, 0x0035, 0x0013, 0x000D, 0x000A, 0x000A},
+      CharacterStats{0x0023, 0x0000, 0x0023, 0x0016, 0x0012, 0x0023, 0x000A},
+      CharacterStats{0x000D, 0x0035, 0x0023, 0x0014, 0x000A, 0x000F, 0x000A},
+      CharacterStats{0x0012, 0x0014, 0x0024, 0x0010, 0x000D, 0x0028, 0x000A},
+  };
+  return data.at(char_class);
+}
+
+const LevelStatsDelta& LevelTableV3BE::stats_delta_for_level(uint8_t char_class, uint8_t level) const {
+  return this->level_deltas.at(char_class).at(level);
+}
+
+LevelTableV4::LevelTableV4(const string& data, bool compressed) {
+  struct Offsets {
+    le_uint32_t base_stats; // -> u32[12] -> CharacterStats
+    le_uint32_t level_deltas; // -> u32[12] -> LevelStatsDelta[200]
+  } __packed_ws__(Offsets, 8);
+
+  StringReader r;
+  string decompressed_data;
+  if (compressed) {
+    decompressed_data = prs_decompress(data);
+    r = StringReader(decompressed_data);
+  } else {
+    r = StringReader(data);
+  }
+
+  const auto& offsets = r.pget<Offsets>(r.pget_u32l(r.size() - 0x10));
+  const auto& level_deltas_offsets = r.pget<parray<le_uint32_t, 12>>(offsets.level_deltas);
+  const auto& base_stats_offsets = r.pget<parray<le_uint32_t, 12>>(offsets.base_stats);
+  for (size_t char_class = 0; char_class < 12; char_class++) {
+    const auto& src_level_deltas = r.pget<parray<LevelStatsDelta, 200>>(level_deltas_offsets[char_class]);
+    for (size_t level = 0; level < 200; level++) {
+      this->level_deltas[char_class][level] = src_level_deltas[level];
+    }
+    this->base_stats[char_class] = r.pget<CharacterStats>(base_stats_offsets[char_class]);
+  }
+}
+
+const CharacterStats& LevelTableV4::base_stats_for_class(uint8_t char_class) const {
+  return this->base_stats.at(char_class);
+}
+
+const LevelStatsDelta& LevelTableV4::stats_delta_for_level(uint8_t char_class, uint8_t level) const {
+  return this->level_deltas.at(char_class).at(level);
+}

src/LevelTable.hh

@@ -1,173 +1,173 @@
-#pragma once
-
-#include <stdint.h>
-
-#include <array>
-#include <memory>
-#include <phosg/Encoding.hh>
-#include <string>
-
-#include "Text.hh"
-
-class LevelTable;
-
-template <bool IsBigEndian>
-struct CharacterStatsT {
-  using U16T = typename std::conditional<IsBigEndian, be_uint16_t, le_uint16_t>::type;
-
-  /* 00 */ U16T atp = 0;
-  /* 02 */ U16T mst = 0;
-  /* 04 */ U16T evp = 0;
-  /* 06 */ U16T hp = 0;
-  /* 08 */ U16T dfp = 0;
-  /* 0A */ U16T ata = 0;
-  /* 0C */ U16T lck = 0;
-  /* 0E */
-
-  operator CharacterStatsT<!IsBigEndian>() const {
-    CharacterStatsT<!IsBigEndian> ret;
-    ret.atp = this->atp.load();
-    ret.mst = this->mst.load();
-    ret.evp = this->evp.load();
-    ret.hp = this->hp.load();
-    ret.dfp = this->dfp.load();
-    ret.ata = this->ata.load();
-    ret.lck = this->lck.load();
-    return ret;
-  }
-} __packed__;
-using CharacterStats = CharacterStatsT<false>;
-using CharacterStatsBE = CharacterStatsT<true>;
-check_struct_size(CharacterStats, 0x0E);
-check_struct_size(CharacterStatsBE, 0x0E);
-
-template <bool IsBigEndian>
-struct PlayerStatsT {
-  using U16T = typename std::conditional<IsBigEndian, be_uint16_t, le_uint16_t>::type;
-  using U32T = typename std::conditional<IsBigEndian, be_uint32_t, le_uint32_t>::type;
-  using F32T = typename std::conditional<IsBigEndian, be_float, le_float>::type;
-
-  /* 00 */ CharacterStatsT<IsBigEndian> char_stats;
-  /* 0E */ U16T esp = 0;
-  /* 10 */ F32T height = 0.0;
-  /* 14 */ F32T unknown_a3 = 0.0;
-  /* 18 */ U32T level = 0;
-  /* 1C */ U32T experience = 0;
-  /* 20 */ U32T meseta = 0;
-  /* 24 */
-
-  operator PlayerStatsT<!IsBigEndian>() const {
-    PlayerStatsT<!IsBigEndian> ret;
-    ret.char_stats = this->char_stats;
-    ret.esp = this->esp.load();
-    ret.height = this->height.load();
-    ret.unknown_a3 = this->unknown_a3.load();
-    ret.level = this->level.load();
-    ret.experience = this->experience.load();
-    ret.meseta = this->meseta.load();
-    return ret;
-  }
-} __packed__;
-using PlayerStats = PlayerStatsT<false>;
-using PlayerStatsBE = PlayerStatsT<true>;
-check_struct_size(PlayerStats, 0x24);
-check_struct_size(PlayerStatsBE, 0x24);
-
-template <bool IsBigEndian>
-struct LevelStatsDeltaT {
-  using U32T = typename std::conditional<IsBigEndian, be_uint32_t, le_uint32_t>::type;
-
-  /* 00 */ uint8_t atp;
-  /* 01 */ uint8_t mst;
-  /* 02 */ uint8_t evp;
-  /* 03 */ uint8_t hp;
-  /* 04 */ uint8_t dfp;
-  /* 05 */ uint8_t ata;
-  /* 06 */ uint8_t lck;
-  /* 07 */ uint8_t tp;
-  /* 08 */ U32T experience;
-  /* 0C */
-
-  void apply(CharacterStats& ps) const {
-    ps.ata += this->ata;
-    ps.atp += this->atp;
-    ps.dfp += this->dfp;
-    ps.evp += this->evp;
-    ps.hp += this->hp;
-    ps.mst += this->mst;
-    ps.lck += this->lck;
-  }
-} __packed__;
-using LevelStatsDelta = LevelStatsDeltaT<false>;
-using LevelStatsDeltaBE = LevelStatsDeltaT<true>;
-check_struct_size(LevelStatsDelta, 0x0C);
-check_struct_size(LevelStatsDeltaBE, 0x0C);
-
-class LevelTable {
-  // This is the base class for all the LevelTable implementations. The public
-  // interface here only defines functions that the server needs to handle
-  // requests, but some subclasses implement more functionality. See the
-  // comments and Offsets structures inside the subclasses' constructor
-  // implementations for more details on the file formats.
-public:
-  virtual ~LevelTable() = default;
-  virtual const CharacterStats& base_stats_for_class(uint8_t char_class) const = 0;
-  virtual const LevelStatsDelta& stats_delta_for_level(uint8_t char_class, uint8_t level) const = 0;
-
-  void reset_to_base(PlayerStats& stats, uint8_t char_class) const;
-  void advance_to_level(PlayerStats& stats, uint32_t level, uint8_t char_class) const;
-
-protected:
-  LevelTable() = default;
-};
-
-class LevelTableV2 : public LevelTable { // from PlayerTable.prs (PC)
-public:
-  struct Level100Entry {
-    /* 00 */ CharacterStats char_stats;
-    /* 0E */ le_uint16_t unknown_a1 = 0;
-    /* 10 */ le_float height = 0.0;
-    /* 14 */ le_float unknown_a3 = 0.0;
-    /* 18 */ le_uint32_t level = 0;
-    /* 1C */
-  } __packed_ws__(Level100Entry, 0x1C);
-
-  LevelTableV2(const std::string& data, bool compressed);
-  virtual ~LevelTableV2() = default;
-
-  virtual const CharacterStats& base_stats_for_class(uint8_t char_class) const;
-  const Level100Entry& level_100_stats_for_class(uint8_t char_class) const;
-  const PlayerStats& max_stats_for_class(uint8_t char_class) const;
-  virtual const LevelStatsDelta& stats_delta_for_level(uint8_t char_class, uint8_t level) const;
-
-private:
-  std::array<CharacterStats, 9> base_stats;
-  std::array<Level100Entry, 9> level_100_stats;
-  std::array<PlayerStats, 9> max_stats;
-  std::array<std::array<LevelStatsDelta, 200>, 9> level_deltas;
-};
-
-class LevelTableV3BE : public LevelTable { // from PlyLevelTbl.cpt (GC)
-public:
-  LevelTableV3BE(const std::string& data, bool encrypted);
-  virtual ~LevelTableV3BE() = default;
-
-  virtual const CharacterStats& base_stats_for_class(uint8_t char_class) const;
-  virtual const LevelStatsDelta& stats_delta_for_level(uint8_t char_class, uint8_t level) const;
-
-private:
-  std::array<std::array<LevelStatsDelta, 200>, 12> level_deltas;
-};
-
-class LevelTableV4 : public LevelTable { // from PlyLevelTbl.prs (BB)
-public:
-  LevelTableV4(const std::string& data, bool compressed);
-  virtual ~LevelTableV4() = default;
-
-  virtual const CharacterStats& base_stats_for_class(uint8_t char_class) const;
-  virtual const LevelStatsDelta& stats_delta_for_level(uint8_t char_class, uint8_t level) const;
-
-private:
-  std::array<CharacterStats, 12> base_stats;
-  std::array<std::array<LevelStatsDelta, 200>, 12> level_deltas;
-};
+#pragma once
+
+#include <stdint.h>
+
+#include <array>
+#include <memory>
+#include <phosg/Encoding.hh>
+#include <string>
+
+#include "Text.hh"
+
+class LevelTable;
+
+template <bool IsBigEndian>
+struct CharacterStatsT {
+  using U16T = typename std::conditional<IsBigEndian, be_uint16_t, le_uint16_t>::type;
+
+  /* 00 */ U16T atp = 0;
+  /* 02 */ U16T mst = 0;
+  /* 04 */ U16T evp = 0;
+  /* 06 */ U16T hp = 0;
+  /* 08 */ U16T dfp = 0;
+  /* 0A */ U16T ata = 0;
+  /* 0C */ U16T lck = 0;
+  /* 0E */
+
+  operator CharacterStatsT<!IsBigEndian>() const {
+    CharacterStatsT<!IsBigEndian> ret;
+    ret.atp = this->atp.load();
+    ret.mst = this->mst.load();
+    ret.evp = this->evp.load();
+    ret.hp = this->hp.load();
+    ret.dfp = this->dfp.load();
+    ret.ata = this->ata.load();
+    ret.lck = this->lck.load();
+    return ret;
+  }
+} __packed__;
+using CharacterStats = CharacterStatsT<false>;
+using CharacterStatsBE = CharacterStatsT<true>;
+check_struct_size(CharacterStats, 0x0E);
+check_struct_size(CharacterStatsBE, 0x0E);
+
+template <bool IsBigEndian>
+struct PlayerStatsT {
+  using U16T = typename std::conditional<IsBigEndian, be_uint16_t, le_uint16_t>::type;
+  using U32T = typename std::conditional<IsBigEndian, be_uint32_t, le_uint32_t>::type;
+  using F32T = typename std::conditional<IsBigEndian, be_float, le_float>::type;
+
+  /* 00 */ CharacterStatsT<IsBigEndian> char_stats;
+  /* 0E */ U16T esp = 0;
+  /* 10 */ F32T height = 0.0;
+  /* 14 */ F32T unknown_a3 = 0.0;
+  /* 18 */ U32T level = 0;
+  /* 1C */ U32T experience = 0;
+  /* 20 */ U32T meseta = 0;
+  /* 24 */
+
+  operator PlayerStatsT<!IsBigEndian>() const {
+    PlayerStatsT<!IsBigEndian> ret;
+    ret.char_stats = this->char_stats;
+    ret.esp = this->esp.load();
+    ret.height = this->height.load();
+    ret.unknown_a3 = this->unknown_a3.load();
+    ret.level = this->level.load();
+    ret.experience = this->experience.load();
+    ret.meseta = this->meseta.load();
+    return ret;
+  }
+} __packed__;
+using PlayerStats = PlayerStatsT<false>;
+using PlayerStatsBE = PlayerStatsT<true>;
+check_struct_size(PlayerStats, 0x24);
+check_struct_size(PlayerStatsBE, 0x24);
+
+template <bool IsBigEndian>
+struct LevelStatsDeltaT {
+  using U32T = typename std::conditional<IsBigEndian, be_uint32_t, le_uint32_t>::type;
+
+  /* 00 */ uint8_t atp;
+  /* 01 */ uint8_t mst;
+  /* 02 */ uint8_t evp;
+  /* 03 */ uint8_t hp;
+  /* 04 */ uint8_t dfp;
+  /* 05 */ uint8_t ata;
+  /* 06 */ uint8_t lck;
+  /* 07 */ uint8_t tp;
+  /* 08 */ U32T experience;
+  /* 0C */
+
+  void apply(CharacterStats& ps) const {
+    ps.ata += this->ata;
+    ps.atp += this->atp;
+    ps.dfp += this->dfp;
+    ps.evp += this->evp;
+    ps.hp += this->hp;
+    ps.mst += this->mst;
+    ps.lck += this->lck;
+  }
+} __packed__;
+using LevelStatsDelta = LevelStatsDeltaT<false>;
+using LevelStatsDeltaBE = LevelStatsDeltaT<true>;
+check_struct_size(LevelStatsDelta, 0x0C);
+check_struct_size(LevelStatsDeltaBE, 0x0C);
+
+class LevelTable {
+  // This is the base class for all the LevelTable implementations. The public
+  // interface here only defines functions that the server needs to handle
+  // requests, but some subclasses implement more functionality. See the
+  // comments and Offsets structures inside the subclasses' constructor
+  // implementations for more details on the file formats.
+public:
+  virtual ~LevelTable() = default;
+  virtual const CharacterStats& base_stats_for_class(uint8_t char_class) const = 0;
+  virtual const LevelStatsDelta& stats_delta_for_level(uint8_t char_class, uint8_t level) const = 0;
+
+  void reset_to_base(PlayerStats& stats, uint8_t char_class) const;
+  void advance_to_level(PlayerStats& stats, uint32_t level, uint8_t char_class) const;
+
+protected:
+  LevelTable() = default;
+};
+
+class LevelTableV2 : public LevelTable { // from PlayerTable.prs (PC)
+public:
+  struct Level100Entry {
+    /* 00 */ CharacterStats char_stats;
+    /* 0E */ le_uint16_t unknown_a1 = 0;
+    /* 10 */ le_float height = 0.0;
+    /* 14 */ le_float unknown_a3 = 0.0;
+    /* 18 */ le_uint32_t level = 0;
+    /* 1C */
+  } __packed_ws__(Level100Entry, 0x1C);
+
+  LevelTableV2(const std::string& data, bool compressed);
+  virtual ~LevelTableV2() = default;
+
+  virtual const CharacterStats& base_stats_for_class(uint8_t char_class) const;
+  const Level100Entry& level_100_stats_for_class(uint8_t char_class) const;
+  const PlayerStats& max_stats_for_class(uint8_t char_class) const;
+  virtual const LevelStatsDelta& stats_delta_for_level(uint8_t char_class, uint8_t level) const;
+
+private:
+  std::array<CharacterStats, 9> base_stats;
+  std::array<Level100Entry, 9> level_100_stats;
+  std::array<PlayerStats, 9> max_stats;
+  std::array<std::array<LevelStatsDelta, 200>, 9> level_deltas;
+};
+
+class LevelTableV3BE : public LevelTable { // from PlyLevelTbl.cpt (GC)
+public:
+  LevelTableV3BE(const std::string& data, bool encrypted);
+  virtual ~LevelTableV3BE() = default;
+
+  virtual const CharacterStats& base_stats_for_class(uint8_t char_class) const;
+  virtual const LevelStatsDelta& stats_delta_for_level(uint8_t char_class, uint8_t level) const;
+
+private:
+  std::array<std::array<LevelStatsDelta, 200>, 12> level_deltas;
+};
+
+class LevelTableV4 : public LevelTable { // from PlyLevelTbl.prs (BB)
+public:
+  LevelTableV4(const std::string& data, bool compressed);
+  virtual ~LevelTableV4() = default;
+
+  virtual const CharacterStats& base_stats_for_class(uint8_t char_class) const;
+  virtual const LevelStatsDelta& stats_delta_for_level(uint8_t char_class, uint8_t level) const;
+
+private:
+  std::array<CharacterStats, 12> base_stats;
+  std::array<std::array<LevelStatsDelta, 200>, 12> level_deltas;
+};

src/Lobby.hh

@@ -1,318 +1,321 @@
-#pragma once
-
-#include <event2/event.h>
-#include <inttypes.h>
-
-#include <array>
-#include <memory>
-#include <phosg/Encoding.hh>
-#include <random>
-#include <string>
-#include <unordered_map>
-#include <vector>
-
-#include "Client.hh"
-#include "CommandFormats.hh"
-#include "Episode3/BattleRecord.hh"
-#include "Episode3/Server.hh"
-#include "ItemCreator.hh"
-#include "Map.hh"
-#include "Quest.hh"
-#include "StaticGameData.hh"
-#include "Text.hh"
-
-struct ServerState;
-
-struct Lobby : public std::enable_shared_from_this<Lobby> {
-  struct FloorItem {
-    ItemData data;
-    float x;
-    float z;
-    uint64_t drop_number;
-    // The low 12 bits of flags are visibility flags, specifying which clients
-    // can see the item. (In practice, only the lowest 4 of these bits are used,
-    // but the game has fields for 12 players so we do too.)
-    // The 13th bit (0x1000) specifies whether a rare item notification should
-    // be sent to all players when the item is picked up. This has no effect for
-    // non-rare items.
-    uint16_t flags;
-
-    bool visible_to_client(uint8_t client_id) const;
-  };
-  struct FloorItemManager {
-    PrefixedLogger log;
-    uint64_t next_drop_number;
-    // It's important that this is a map and not an unordered_map. See the
-    // comment in send_game_item_state for more details.
-    std::map<uint32_t, std::shared_ptr<FloorItem>> items; // Keyed on item_id
-    std::array<std::map<uint64_t, std::shared_ptr<FloorItem>>, 12> queue_for_client;
-
-    FloorItemManager(uint32_t lobby_id, uint8_t floor);
-    ~FloorItemManager() = default;
-
-    bool exists(uint32_t item_id) const;
-    std::shared_ptr<FloorItem> find(uint32_t item_id) const;
-    void add(const ItemData& item, float x, float z, uint16_t flags);
-    void add(std::shared_ptr<FloorItem> fi);
-    std::shared_ptr<FloorItem> remove(uint32_t item_id, uint8_t client_id);
-    std::unordered_set<std::shared_ptr<FloorItem>> evict();
-    void clear_inaccessible(uint16_t remaining_clients_mask);
-    void clear_private();
-    void clear();
-    uint32_t reassign_all_item_ids(uint32_t next_item_id);
-  };
-  enum class Flag {
-    // clang-format off
-    GAME                            = 0x00000001,
-    PERSISTENT                      = 0x00000002,
-    // Flags used only for games
-    CHEATS_ENABLED                  = 0x00000100,
-    QUEST_IN_PROGRESS               = 0x00000200,
-    BATTLE_IN_PROGRESS              = 0x00000400,
-    JOINABLE_QUEST_IN_PROGRESS      = 0x00000800,
-    IS_SPECTATOR_TEAM               = 0x00002000, // episode must be EP3 also
-    SPECTATORS_FORBIDDEN            = 0x00004000,
-    START_BATTLE_PLAYER_IMMEDIATELY = 0x00008000,
-    CANNOT_CHANGE_CHEAT_MODE        = 0x00010000,
-    USE_CREATOR_SECTION_ID          = 0x00020000,
-    // Flags used only for lobbies
-    PUBLIC                          = 0x01000000,
-    DEFAULT                         = 0x02000000,
-    IS_OVERFLOW                     = 0x08000000,
-    // clang-format on
-  };
-  enum class DropMode {
-    DISABLED = 0,
-    CLIENT = 1, // Not allowed for BB games
-    SERVER_SHARED = 2,
-    SERVER_PRIVATE = 3,
-    SERVER_DUPLICATE = 4,
-  };
-
-  std::weak_ptr<ServerState>
-      server_state;
-  PrefixedLogger log;
-
-  uint32_t lobby_id;
-
-  uint32_t min_level;
-  uint32_t max_level;
-
-  // Game state
-  std::array<uint32_t, 12> next_item_id_for_client;
-  uint32_t next_game_item_id;
-  std::vector<FloorItemManager> floor_item_managers;
-  std::shared_ptr<const Map::RareEnemyRates> rare_enemy_rates;
-  std::shared_ptr<Map> map;
-  parray<le_uint32_t, 0x20> variations;
-  std::unique_ptr<QuestFlags> quest_flags_known; // If null, ALL quest flags are known
-  std::unique_ptr<QuestFlags> quest_flag_values;
-  std::unique_ptr<SwitchFlags> switch_flags;
-
-  // Game config
-  Version base_version;
-  // Bits in allowed_versions specify who is allowed to join this game. The
-  // bits are indexed as (1 << version), where version is a value from the
-  // Version enum.
-  uint16_t allowed_versions;
-  uint8_t creator_section_id;
-  uint8_t override_section_id;
-  Episode episode;
-  GameMode mode;
-  uint8_t difficulty; // 0-3
-  uint16_t base_exp_multiplier;
-  float challenge_exp_multiplier;
-  std::string password;
-  std::string name;
-  // This seed is also sent to the client for rare enemy generation
-  uint32_t random_seed;
-  std::shared_ptr<PSOLFGEncryption> opt_rand_crypt;
-  uint8_t allowed_drop_modes;
-  DropMode drop_mode;
-  std::shared_ptr<ItemCreator> item_creator;
-
-  struct ChallengeParameters {
-    uint8_t stage_number = 0;
-    uint32_t rank_color = 0xFFFFFFFF;
-    std::string rank_text;
-    struct RankThreshold {
-      uint32_t bitmask = 0;
-      uint32_t seconds = 0;
-    };
-    std::array<RankThreshold, 3> rank_thresholds;
-  };
-  std::shared_ptr<ChallengeParameters> challenge_params;
-
-  // Ep3 stuff
-  // There are three kinds of Episode 3 games. All of these types have episode
-  // set to EP3; types 2 and 3 additionally have the IS_SPECTATOR_TEAM flag.
-  // 1. Primary games. These are the lobbies where battles may take place.
-  // 2. Watcher games. These lobbies receive all the battle and chat commands
-  //    from a primary game. (This the implementation of spectator teams.)
-  // 3. Replay games. These lobbies replay a sequence of battle commands and
-  //    chat commands from a previous primary game.
-  // Types 2 and 3 may be distinguished by the presence of the battle_record
-  // field - in replay games, it will be present; in watcher games it will be
-  // absent.
-  std::shared_ptr<Episode3::Server> ep3_server; // Only used in primary games
-  std::weak_ptr<Lobby> watched_lobby; // Only used in watcher games
-  std::unordered_set<std::shared_ptr<Lobby>> watcher_lobbies; // Only used in primary games
-  std::shared_ptr<Episode3::BattleRecord> battle_record; // Not used in watcher games
-  std::shared_ptr<Episode3::BattleRecordPlayer> battle_player; // Only used in replay games
-  std::shared_ptr<Episode3::Tournament::Match> tournament_match;
-  std::shared_ptr<const G_SetEXResultValues_Ep3_6xB4x4B> ep3_ex_result_values;
-
-  // Lobby stuff
-  uint8_t event;
-  uint8_t block;
-  uint8_t leader_id;
-  uint8_t max_clients;
-  uint32_t enabled_flags;
-  std::shared_ptr<const Quest> quest;
-  std::array<std::shared_ptr<Client>, 12> clients;
-  // Keys in this map are client_id
-  std::unordered_map<size_t, std::weak_ptr<Client>> clients_to_add;
-
-  // This is only used when the PERSISTENT flag is set and idle_timeout_usecs
-  // is not zero
-  uint64_t idle_timeout_usecs;
-  std::unique_ptr<struct event, void (*)(struct event*)> idle_timeout_event;
-
-  Lobby(std::shared_ptr<ServerState> s, uint32_t id, bool is_game);
-  Lobby(const Lobby&) = delete;
-  Lobby(Lobby&&) = delete;
-  ~Lobby();
-  Lobby& operator=(const Lobby&) = delete;
-  Lobby& operator=(Lobby&&) = delete;
-
-  void reset_next_item_ids();
-
-  [[nodiscard]] inline bool check_flag(Flag flag) const {
-    return !!(this->enabled_flags & static_cast<uint32_t>(flag));
-  }
-  inline void set_flag(Flag flag) {
-    this->enabled_flags |= static_cast<uint32_t>(flag);
-  }
-  inline void clear_flag(Flag flag) {
-    this->enabled_flags &= (~static_cast<uint32_t>(flag));
-  }
-  inline void toggle_flag(Flag flag) {
-    this->enabled_flags ^= static_cast<uint32_t>(flag);
-  }
-
-  std::shared_ptr<ServerState> require_server_state() const;
-  std::shared_ptr<ChallengeParameters> require_challenge_params() const;
-  void set_drop_mode(DropMode new_mode);
-  void create_item_creator();
-  void change_section_id();
-  uint8_t effective_section_id() const;
-  static std::shared_ptr<Map> load_maps(
-      Version version,
-      Episode episode,
-      uint8_t difficulty,
-      uint8_t event,
-      uint32_t lobby_id,
-      std::shared_ptr<const Map::RareEnemyRates> rare_rates,
-      uint32_t random_seed,
-      std::shared_ptr<PSOLFGEncryption> opt_rand_crypt,
-      std::shared_ptr<const std::string> quest_dat_contents_decompressed);
-  static std::shared_ptr<Map> load_maps(
-      Version version,
-      Episode episode,
-      GameMode mode,
-      uint8_t difficulty,
-      uint8_t event,
-      uint32_t lobby_id,
-      std::shared_ptr<const SetDataTableBase> sdt,
-      std::function<std::shared_ptr<const std::string>(Version, const std::string&)> get_file_data,
-      std::shared_ptr<const Map::RareEnemyRates> rare_rates,
-      uint32_t random_seed,
-      std::shared_ptr<PSOLFGEncryption> opt_rand_crypt,
-      const parray<le_uint32_t, 0x20>& variations,
-      const PrefixedLogger* log = nullptr);
-  static std::shared_ptr<Map> load_maps(
-      const std::vector<std::string>& enemy_filenames,
-      const std::vector<std::string>& object_filenames,
-      const std::vector<std::string>& event_filenames,
-      Version version,
-      Episode episode,
-      GameMode mode,
-      uint8_t difficulty,
-      uint8_t event,
-      uint32_t lobby_id,
-      std::function<std::shared_ptr<const std::string>(Version, const std::string&)> get_file_data,
-      std::shared_ptr<const Map::RareEnemyRates> rare_rates,
-      uint32_t random_seed,
-      std::shared_ptr<PSOLFGEncryption> opt_rand_crypt,
-      const PrefixedLogger* log = nullptr);
-  void load_maps();
-  void create_ep3_server();
-
-  [[nodiscard]] inline bool is_game() const {
-    return this->check_flag(Flag::GAME);
-  }
-  [[nodiscard]] inline bool is_ep3() const {
-    return this->episode == Episode::EP3;
-  }
-
-  [[nodiscard]] inline bool version_is_allowed(Version v) const {
-    return this->allowed_versions & (1 << static_cast<size_t>(v));
-  }
-  inline void allow_version(Version v) {
-    this->allowed_versions |= (1 << static_cast<size_t>(v));
-  }
-
-  void reassign_leader_on_client_departure(size_t leaving_client_id);
-  size_t count_clients() const;
-  bool any_v1_clients_present() const;
-  bool any_client_loading() const;
-
-  void add_client(std::shared_ptr<Client> c, ssize_t required_client_id = -1);
-  void remove_client(std::shared_ptr<Client> c);
-
-  void move_client_to_lobby(
-      std::shared_ptr<Lobby> dest_lobby,
-      std::shared_ptr<Client> c,
-      ssize_t required_client_id = -1);
-
-  std::shared_ptr<Client> find_client(const std::string* identifier = nullptr, uint64_t account_id = 0);
-
-  enum class JoinError {
-    ALLOWED = 0,
-    FULL,
-    VERSION_CONFLICT,
-    QUEST_IN_PROGRESS,
-    BATTLE_IN_PROGRESS,
-    LOADING,
-    SOLO,
-    INCORRECT_PASSWORD,
-    LEVEL_TOO_LOW,
-    LEVEL_TOO_HIGH,
-    NO_ACCESS_TO_QUEST,
-  };
-  JoinError join_error_for_client(std::shared_ptr<Client> c, const std::string* password) const;
-
-  bool item_exists(uint8_t floor, uint32_t item_id) const;
-  std::shared_ptr<FloorItem> find_item(uint8_t floor, uint32_t item_id) const;
-  void add_item(uint8_t floor, const ItemData& item, float x, float z, uint16_t flags);
-  void add_item(uint8_t floor, std::shared_ptr<FloorItem>);
-  void evict_items_from_floor(uint8_t floor);
-  std::shared_ptr<FloorItem> remove_item(uint8_t floor, uint32_t item_id, uint8_t requesting_client_id);
-
-  uint32_t generate_item_id(uint8_t client_id);
-  void on_item_id_generated_externally(uint32_t item_id);
-  void assign_inventory_and_bank_item_ids(std::shared_ptr<Client> c, bool consume_ids);
-
-  QuestIndex::IncludeCondition quest_include_condition() const;
-
-  std::unordered_map<uint32_t, std::shared_ptr<Client>> clients_by_account_id() const;
-
-  static void dispatch_on_idle_timeout(evutil_socket_t, short, void* ctx);
-
-  static bool compare_shared(const std::shared_ptr<const Lobby>& a, const std::shared_ptr<const Lobby>& b);
-};
-
-template <>
-Lobby::DropMode enum_for_name<Lobby::DropMode>(const char* name);
-template <>
-const char* name_for_enum<Lobby::DropMode>(Lobby::DropMode value);
+#pragma once
+
+#include <event2/event.h>
+#include <inttypes.h>
+
+#include <array>
+#include <memory>
+#include <phosg/Encoding.hh>
+#include <random>
+#include <string>
+#include <unordered_map>
+#include <vector>
+
+#include "Client.hh"
+#include "CommandFormats.hh"
+#include "Episode3/BattleRecord.hh"
+#include "Episode3/Server.hh"
+#include "ItemCreator.hh"
+#include "Map.hh"
+#include "Quest.hh"
+#include "StaticGameData.hh"
+#include "Text.hh"
+
+struct ServerState;
+
+struct Lobby : public std::enable_shared_from_this<Lobby> {
+  struct FloorItem {
+    ItemData data;
+    float x;
+    float z;
+    uint64_t drop_number;
+    // The low 12 bits of flags are visibility flags, specifying which clients
+    // can see the item. (In practice, only the lowest 4 of these bits are used,
+    // but the game has fields for 12 players so we do too.)
+    // The 13th bit (0x1000) specifies whether a rare item notification should
+    // be sent to all players when the item is picked up. This has no effect for
+    // non-rare items.
+    uint16_t flags;
+
+    bool visible_to_client(uint8_t client_id) const;
+  };
+  struct FloorItemManager {
+    PrefixedLogger log;
+    uint64_t next_drop_number;
+    // It's important that this is a map and not an unordered_map. See the
+    // comment in send_game_item_state for more details.
+    std::map<uint32_t, std::shared_ptr<FloorItem>> items; // Keyed on item_id
+    std::array<std::map<uint64_t, std::shared_ptr<FloorItem>>, 12> queue_for_client;
+
+    FloorItemManager(uint32_t lobby_id, uint8_t floor);
+    ~FloorItemManager() = default;
+
+    bool exists(uint32_t item_id) const;
+    std::shared_ptr<FloorItem> find(uint32_t item_id) const;
+    void add(const ItemData& item, float x, float z, uint16_t flags);
+    void add(std::shared_ptr<FloorItem> fi);
+    std::shared_ptr<FloorItem> remove(uint32_t item_id, uint8_t client_id);
+    std::unordered_set<std::shared_ptr<FloorItem>> evict();
+    void clear_inaccessible(uint16_t remaining_clients_mask);
+    void clear_private();
+    void clear();
+    uint32_t reassign_all_item_ids(uint32_t next_item_id);
+  };
+  enum class Flag {
+    // clang-format off
+    GAME                            = 0x00000001,
+    PERSISTENT                      = 0x00000002,
+    // Flags used only for games
+    CHEATS_ENABLED                  = 0x00000100,
+    QUEST_SELECTION_IN_PROGRESS     = 0x00000200,
+    QUEST_IN_PROGRESS               = 0x00000400,
+    BATTLE_IN_PROGRESS              = 0x00000800,
+    JOINABLE_QUEST_IN_PROGRESS      = 0x00001000,
+    IS_CLIENT_CUSTOMIZATION         = 0x00002000,
+    IS_SPECTATOR_TEAM               = 0x00004000, // .episode must be EP3 also
+    SPECTATORS_FORBIDDEN            = 0x00008000,
+    START_BATTLE_PLAYER_IMMEDIATELY = 0x00010000,
+    CANNOT_CHANGE_CHEAT_MODE        = 0x00020000,
+    USE_CREATOR_SECTION_ID          = 0x00040000,
+    // Flags used only for lobbies
+    PUBLIC                          = 0x01000000,
+    DEFAULT                         = 0x02000000,
+    IS_OVERFLOW                     = 0x08000000,
+    // clang-format on
+  };
+  enum class DropMode {
+    DISABLED = 0,
+    CLIENT = 1, // Not allowed for BB games
+    SERVER_SHARED = 2,
+    SERVER_PRIVATE = 3,
+    SERVER_DUPLICATE = 4,
+  };
+
+  std::weak_ptr<ServerState> server_state;
+  PrefixedLogger log;
+
+  uint32_t lobby_id;
+
+  uint32_t min_level;
+  uint32_t max_level;
+
+  // Game state
+  std::array<uint32_t, 12> next_item_id_for_client;
+  uint32_t next_game_item_id;
+  std::vector<FloorItemManager> floor_item_managers;
+  std::shared_ptr<const Map::RareEnemyRates> rare_enemy_rates;
+  std::shared_ptr<Map> map;
+  parray<le_uint32_t, 0x20> variations;
+  std::unique_ptr<QuestFlags> quest_flags_known; // If null, ALL quest flags are known
+  std::unique_ptr<QuestFlags> quest_flag_values;
+  std::unique_ptr<SwitchFlags> switch_flags;
+
+  // Game config
+  Version base_version;
+  // Bits in allowed_versions specify who is allowed to join this game. The
+  // bits are indexed as (1 << version), where version is a value from the
+  // Version enum.
+  uint16_t allowed_versions;
+  uint8_t creator_section_id;
+  uint8_t override_section_id;
+  Episode episode;
+  GameMode mode;
+  uint8_t difficulty; // 0-3
+  uint16_t base_exp_multiplier;
+  float exp_share_multiplier;
+  float challenge_exp_multiplier;
+  std::string password;
+  std::string name;
+  // This seed is also sent to the client for rare enemy generation
+  uint32_t random_seed;
+  std::shared_ptr<PSOLFGEncryption> opt_rand_crypt;
+  uint8_t allowed_drop_modes;
+  DropMode drop_mode;
+  std::shared_ptr<ItemCreator> item_creator;
+
+  struct ChallengeParameters {
+    uint8_t stage_number = 0;
+    uint32_t rank_color = 0xFFFFFFFF;
+    std::string rank_text;
+    struct RankThreshold {
+      uint32_t bitmask = 0;
+      uint32_t seconds = 0;
+    };
+    std::array<RankThreshold, 3> rank_thresholds;
+  };
+  std::shared_ptr<ChallengeParameters> challenge_params;
+
+  // Ep3 stuff
+  // There are three kinds of Episode 3 games. All of these types have episode
+  // set to EP3; types 2 and 3 additionally have the IS_SPECTATOR_TEAM flag.
+  // 1. Primary games. These are the lobbies where battles may take place.
+  // 2. Watcher games. These lobbies receive all the battle and chat commands
+  //    from a primary game. (This the implementation of spectator teams.)
+  // 3. Replay games. These lobbies replay a sequence of battle commands and
+  //    chat commands from a previous primary game.
+  // Types 2 and 3 may be distinguished by the presence of the battle_record
+  // field - in replay games, it will be present; in watcher games it will be
+  // absent.
+  std::shared_ptr<Episode3::Server> ep3_server; // Only used in primary games
+  std::weak_ptr<Lobby> watched_lobby; // Only used in watcher games
+  std::unordered_set<std::shared_ptr<Lobby>> watcher_lobbies; // Only used in primary games
+  std::shared_ptr<Episode3::BattleRecord> battle_record; // Not used in watcher games
+  std::shared_ptr<Episode3::BattleRecordPlayer> battle_player; // Only used in replay games
+  std::shared_ptr<Episode3::Tournament::Match> tournament_match;
+  std::shared_ptr<const G_SetEXResultValues_Ep3_6xB4x4B> ep3_ex_result_values;
+
+  // Lobby stuff
+  uint8_t event;
+  uint8_t block;
+  uint8_t leader_id;
+  uint8_t max_clients;
+  uint32_t enabled_flags;
+  std::shared_ptr<const Quest> quest;
+  std::array<std::shared_ptr<Client>, 12> clients;
+  // Keys in this map are client_id
+  std::unordered_map<size_t, std::weak_ptr<Client>> clients_to_add;
+
+  // This is only used when the PERSISTENT flag is set and idle_timeout_usecs
+  // is not zero
+  uint64_t idle_timeout_usecs;
+  std::unique_ptr<struct event, void (*)(struct event*)> idle_timeout_event;
+
+  Lobby(std::shared_ptr<ServerState> s, uint32_t id, bool is_game);
+  Lobby(const Lobby&) = delete;
+  Lobby(Lobby&&) = delete;
+  ~Lobby();
+  Lobby& operator=(const Lobby&) = delete;
+  Lobby& operator=(Lobby&&) = delete;
+
+  void reset_next_item_ids();
+
+  [[nodiscard]] inline bool check_flag(Flag flag) const {
+    return !!(this->enabled_flags & static_cast<uint32_t>(flag));
+  }
+  inline void set_flag(Flag flag) {
+    this->enabled_flags |= static_cast<uint32_t>(flag);
+  }
+  inline void clear_flag(Flag flag) {
+    this->enabled_flags &= (~static_cast<uint32_t>(flag));
+  }
+  inline void toggle_flag(Flag flag) {
+    this->enabled_flags ^= static_cast<uint32_t>(flag);
+  }
+
+  std::shared_ptr<ServerState> require_server_state() const;
+  std::shared_ptr<ChallengeParameters> require_challenge_params() const;
+  void set_drop_mode(DropMode new_mode);
+  void create_item_creator();
+  void change_section_id();
+  uint8_t effective_section_id() const;
+  static std::shared_ptr<Map> load_maps(
+      Version version,
+      Episode episode,
+      uint8_t difficulty,
+      uint8_t event,
+      uint32_t lobby_id,
+      std::shared_ptr<const Map::RareEnemyRates> rare_rates,
+      uint32_t random_seed,
+      std::shared_ptr<PSOLFGEncryption> opt_rand_crypt,
+      std::shared_ptr<const std::string> quest_dat_contents_decompressed);
+  static std::shared_ptr<Map> load_maps(
+      Version version,
+      Episode episode,
+      GameMode mode,
+      uint8_t difficulty,
+      uint8_t event,
+      uint32_t lobby_id,
+      std::shared_ptr<const SetDataTableBase> sdt,
+      std::function<std::shared_ptr<const std::string>(Version, const std::string&)> get_file_data,
+      std::shared_ptr<const Map::RareEnemyRates> rare_rates,
+      uint32_t random_seed,
+      std::shared_ptr<PSOLFGEncryption> opt_rand_crypt,
+      const parray<le_uint32_t, 0x20>& variations,
+      const PrefixedLogger* log = nullptr);
+  static std::shared_ptr<Map> load_maps(
+      const std::vector<std::string>& enemy_filenames,
+      const std::vector<std::string>& object_filenames,
+      const std::vector<std::string>& event_filenames,
+      Version version,
+      Episode episode,
+      GameMode mode,
+      uint8_t difficulty,
+      uint8_t event,
+      uint32_t lobby_id,
+      std::function<std::shared_ptr<const std::string>(Version, const std::string&)> get_file_data,
+      std::shared_ptr<const Map::RareEnemyRates> rare_rates,
+      uint32_t random_seed,
+      std::shared_ptr<PSOLFGEncryption> opt_rand_crypt,
+      const PrefixedLogger* log = nullptr);
+  void load_maps();
+  void create_ep3_server();
+
+  [[nodiscard]] inline bool is_game() const {
+    return this->check_flag(Flag::GAME);
+  }
+  [[nodiscard]] inline bool is_ep3() const {
+    return this->episode == Episode::EP3;
+  }
+
+  [[nodiscard]] inline bool version_is_allowed(Version v) const {
+    return this->allowed_versions & (1 << static_cast<size_t>(v));
+  }
+  inline void allow_version(Version v) {
+    this->allowed_versions |= (1 << static_cast<size_t>(v));
+  }
+
+  void reassign_leader_on_client_departure(size_t leaving_client_id);
+  size_t count_clients() const;
+  bool any_v1_clients_present() const;
+  bool any_client_loading() const;
+
+  void add_client(std::shared_ptr<Client> c, ssize_t required_client_id = -1);
+  void remove_client(std::shared_ptr<Client> c);
+
+  void move_client_to_lobby(
+      std::shared_ptr<Lobby> dest_lobby,
+      std::shared_ptr<Client> c,
+      ssize_t required_client_id = -1);
+
+  std::shared_ptr<Client> find_client(const std::string* identifier = nullptr, uint64_t account_id = 0);
+
+  enum class JoinError {
+    ALLOWED = 0,
+    FULL,
+    VERSION_CONFLICT,
+    QUEST_SELECTION_IN_PROGRESS,
+    QUEST_IN_PROGRESS,
+    BATTLE_IN_PROGRESS,
+    LOADING,
+    SOLO,
+    INCORRECT_PASSWORD,
+    LEVEL_TOO_LOW,
+    LEVEL_TOO_HIGH,
+    NO_ACCESS_TO_QUEST,
+  };
+  JoinError join_error_for_client(std::shared_ptr<Client> c, const std::string* password) const;
+
+  bool item_exists(uint8_t floor, uint32_t item_id) const;
+  std::shared_ptr<FloorItem> find_item(uint8_t floor, uint32_t item_id) const;
+  void add_item(uint8_t floor, const ItemData& item, float x, float z, uint16_t flags);
+  void add_item(uint8_t floor, std::shared_ptr<FloorItem>);
+  void evict_items_from_floor(uint8_t floor);
+  std::shared_ptr<FloorItem> remove_item(uint8_t floor, uint32_t item_id, uint8_t requesting_client_id);
+
+  uint32_t generate_item_id(uint8_t client_id);
+  void on_item_id_generated_externally(uint32_t item_id);
+  void assign_inventory_and_bank_item_ids(std::shared_ptr<Client> c, bool consume_ids);
+
+  QuestIndex::IncludeCondition quest_include_condition() const;
+
+  std::unordered_map<uint32_t, std::shared_ptr<Client>> clients_by_account_id() const;
+
+  static void dispatch_on_idle_timeout(evutil_socket_t, short, void* ctx);
+
+  static bool compare_shared(const std::shared_ptr<const Lobby>& a, const std::shared_ptr<const Lobby>& b);
+};
+
+template <>
+Lobby::DropMode enum_for_name<Lobby::DropMode>(const char* name);
+template <>
+const char* name_for_enum<Lobby::DropMode>(Lobby::DropMode value);

src/Loggers.cc

@@ -1,48 +1,48 @@
-#include "Loggers.hh"
-
-#include <phosg/Strings.hh>
-
-using namespace std;
-
-PrefixedLogger ax_messages_log("[$ax message] ", LogLevel::USE_DEFAULT);
-PrefixedLogger channel_exceptions_log("[Channel] ", LogLevel::USE_DEFAULT);
-PrefixedLogger client_log("", LogLevel::USE_DEFAULT);
-PrefixedLogger command_data_log("[Commands] ", LogLevel::USE_DEFAULT);
-PrefixedLogger config_log("[Config] ", LogLevel::USE_DEFAULT);
-PrefixedLogger dns_server_log("[DNSServer] ", LogLevel::USE_DEFAULT);
-PrefixedLogger function_compiler_log("[FunctionCompiler] ", LogLevel::USE_DEFAULT);
-PrefixedLogger ip_stack_simulator_log("[IPStackSimulator] ", LogLevel::USE_DEFAULT);
-PrefixedLogger lobby_log("", LogLevel::USE_DEFAULT);
-PrefixedLogger patch_index_log("[PatchFileIndex] ", LogLevel::USE_DEFAULT);
-PrefixedLogger player_data_log("", LogLevel::USE_DEFAULT);
-PrefixedLogger proxy_server_log("[ProxyServer] ", LogLevel::USE_DEFAULT);
-PrefixedLogger replay_log("[ReplaySession] ", LogLevel::USE_DEFAULT);
-PrefixedLogger server_log("[Server] ", LogLevel::USE_DEFAULT);
-PrefixedLogger static_game_data_log("[StaticGameData] ", LogLevel::USE_DEFAULT);
-
-static void set_log_level_from_json(
-    PrefixedLogger& log, const JSON& d, const char* json_key) {
-  try {
-    string name = toupper(d.at(json_key).as_string());
-    log.min_level = enum_for_name<LogLevel>(name.c_str());
-  } catch (const out_of_range&) {
-  }
-}
-
-void set_log_levels_from_json(const JSON& json) {
-  set_log_level_from_json(ax_messages_log, json, "AXMessages");
-  set_log_level_from_json(channel_exceptions_log, json, "ChannelExceptions");
-  set_log_level_from_json(client_log, json, "Clients");
-  set_log_level_from_json(command_data_log, json, "CommandData");
-  set_log_level_from_json(config_log, json, "Config");
-  set_log_level_from_json(dns_server_log, json, "DNSServer");
-  set_log_level_from_json(function_compiler_log, json, "FunctionCompiler");
-  set_log_level_from_json(ip_stack_simulator_log, json, "IPStackSimulator");
-  set_log_level_from_json(lobby_log, json, "Lobbies");
-  set_log_level_from_json(patch_index_log, json, "PatchFileIndex");
-  set_log_level_from_json(player_data_log, json, "PlayerData");
-  set_log_level_from_json(proxy_server_log, json, "ProxyServer");
-  set_log_level_from_json(replay_log, json, "Replay");
-  set_log_level_from_json(server_log, json, "GameServer");
-  set_log_level_from_json(static_game_data_log, json, "StaticGameData");
-}
+#include "Loggers.hh"
+
+#include <phosg/Strings.hh>
+
+using namespace std;
+
+PrefixedLogger ax_messages_log("[$ax message] ", LogLevel::USE_DEFAULT);
+PrefixedLogger channel_exceptions_log("[Channel] ", LogLevel::USE_DEFAULT);
+PrefixedLogger client_log("", LogLevel::USE_DEFAULT);
+PrefixedLogger command_data_log("[Commands] ", LogLevel::USE_DEFAULT);
+PrefixedLogger config_log("[Config] ", LogLevel::USE_DEFAULT);
+PrefixedLogger dns_server_log("[DNSServer] ", LogLevel::USE_DEFAULT);
+PrefixedLogger function_compiler_log("[FunctionCompiler] ", LogLevel::USE_DEFAULT);
+PrefixedLogger ip_stack_simulator_log("[IPStackSimulator] ", LogLevel::USE_DEFAULT);
+PrefixedLogger lobby_log("", LogLevel::USE_DEFAULT);
+PrefixedLogger patch_index_log("[PatchFileIndex] ", LogLevel::USE_DEFAULT);
+PrefixedLogger player_data_log("", LogLevel::USE_DEFAULT);
+PrefixedLogger proxy_server_log("[ProxyServer] ", LogLevel::USE_DEFAULT);
+PrefixedLogger replay_log("[ReplaySession] ", LogLevel::USE_DEFAULT);
+PrefixedLogger server_log("[Server] ", LogLevel::USE_DEFAULT);
+PrefixedLogger static_game_data_log("[StaticGameData] ", LogLevel::USE_DEFAULT);
+
+static void set_log_level_from_json(
+    PrefixedLogger& log, const JSON& d, const char* json_key) {
+  try {
+    string name = toupper(d.at(json_key).as_string());
+    log.min_level = enum_for_name<LogLevel>(name.c_str());
+  } catch (const out_of_range&) {
+  }
+}
+
+void set_log_levels_from_json(const JSON& json) {
+  set_log_level_from_json(ax_messages_log, json, "AXMessages");
+  set_log_level_from_json(channel_exceptions_log, json, "ChannelExceptions");
+  set_log_level_from_json(client_log, json, "Clients");
+  set_log_level_from_json(command_data_log, json, "CommandData");
+  set_log_level_from_json(config_log, json, "Config");
+  set_log_level_from_json(dns_server_log, json, "DNSServer");
+  set_log_level_from_json(function_compiler_log, json, "FunctionCompiler");
+  set_log_level_from_json(ip_stack_simulator_log, json, "IPStackSimulator");
+  set_log_level_from_json(lobby_log, json, "Lobbies");
+  set_log_level_from_json(patch_index_log, json, "PatchFileIndex");
+  set_log_level_from_json(player_data_log, json, "PlayerData");
+  set_log_level_from_json(proxy_server_log, json, "ProxyServer");
+  set_log_level_from_json(replay_log, json, "Replay");
+  set_log_level_from_json(server_log, json, "GameServer");
+  set_log_level_from_json(static_game_data_log, json, "StaticGameData");
+}

src/Loggers.hh

@@ -1,22 +1,22 @@
-#pragma once
-
-#include <phosg/JSON.hh>
-#include <phosg/Strings.hh>
-
-extern PrefixedLogger ax_messages_log;
-extern PrefixedLogger channel_exceptions_log;
-extern PrefixedLogger client_log;
-extern PrefixedLogger command_data_log;
-extern PrefixedLogger config_log;
-extern PrefixedLogger dns_server_log;
-extern PrefixedLogger function_compiler_log;
-extern PrefixedLogger ip_stack_simulator_log;
-extern PrefixedLogger lobby_log;
-extern PrefixedLogger patch_index_log;
-extern PrefixedLogger player_data_log;
-extern PrefixedLogger proxy_server_log;
-extern PrefixedLogger replay_log;
-extern PrefixedLogger server_log;
-extern PrefixedLogger static_game_data_log;
-
-void set_log_levels_from_json(const JSON& json);
+#pragma once
+
+#include <phosg/JSON.hh>
+#include <phosg/Strings.hh>
+
+extern PrefixedLogger ax_messages_log;
+extern PrefixedLogger channel_exceptions_log;
+extern PrefixedLogger client_log;
+extern PrefixedLogger command_data_log;
+extern PrefixedLogger config_log;
+extern PrefixedLogger dns_server_log;
+extern PrefixedLogger function_compiler_log;
+extern PrefixedLogger ip_stack_simulator_log;
+extern PrefixedLogger lobby_log;
+extern PrefixedLogger patch_index_log;
+extern PrefixedLogger player_data_log;
+extern PrefixedLogger proxy_server_log;
+extern PrefixedLogger replay_log;
+extern PrefixedLogger server_log;
+extern PrefixedLogger static_game_data_log;
+
+void set_log_levels_from_json(const JSON& json);

src/Map.hh

@@ -1,484 +1,494 @@
-#pragma once
-
-#include <inttypes.h>
-
-#include <memory>
-#include <phosg/Encoding.hh>
-#include <phosg/JSON.hh>
-#include <random>
-#include <string>
-#include <vector>
-
-#include "BattleParamsIndex.hh"
-#include "PSOEncryption.hh"
-#include "StaticGameData.hh"
-#include "Text.hh"
-
-struct Map {
-  static const char* name_for_object_type(uint16_t type);
-
-  struct SectionHeader {
-    enum class Type {
-      END = 0,
-      OBJECTS = 1,
-      ENEMIES = 2,
-      WAVE_EVENTS = 3,
-      RANDOM_ENEMY_LOCATIONS = 4,
-      RANDOM_ENEMY_DEFINITIONS = 5,
-    };
-    le_uint32_t le_type;
-    le_uint32_t section_size; // Includes this header
-    le_uint32_t floor;
-    le_uint32_t data_size;
-
-    inline Type type() const {
-      return static_cast<Type>(this->le_type.load());
-    }
-  } __packed_ws__(SectionHeader, 0x10);
-
-  struct ObjectEntry { // Section type 1 (OBJECTS)
-    /* 00 */ le_uint16_t base_type;
-    /* 02 */ le_uint16_t flags;
-    /* 04 */ le_uint16_t index;
-    /* 06 */ le_uint16_t unknown_a2;
-    /* 08 */ le_uint16_t entity_id; // == index + 0x4000
-    /* 0A */ le_uint16_t group;
-    /* 0C */ le_uint16_t section;
-    /* 0E */ le_uint16_t unknown_a3;
-    /* 10 */ le_float x;
-    /* 14 */ le_float y;
-    /* 18 */ le_float z;
-    /* 1C */ le_uint32_t x_angle;
-    /* 20 */ le_uint32_t y_angle;
-    /* 24 */ le_uint32_t z_angle;
-    /* 28 */ le_float param1; // If <= 0, this is a specialized box, and the specialization is in param4/5/6
-    /* 2C */ le_float param2;
-    /* 30 */ le_float param3;
-    /* 34 */ le_uint32_t param4;
-    /* 38 */ le_uint32_t param5;
-    /* 3C */ le_uint32_t param6;
-    /* 40 */ le_uint32_t unused; // Reserved for pointer in client's memory; unused by server
-    /* 44 */
-
-    std::string str() const;
-  } __packed_ws__(ObjectEntry, 0x44);
-
-  struct EnemyEntry { // Section type 2 (ENEMIES)
-    /* 00 */ le_uint16_t base_type;
-    /* 02 */ le_uint16_t flags;
-    /* 04 */ le_uint16_t index;
-    /* 06 */ le_uint16_t num_children;
-    /* 08 */ le_uint16_t floor;
-    /* 0A */ le_uint16_t entity_id; // == index + 0x1000
-    /* 0C */ le_uint16_t section;
-    /* 0E */ le_uint16_t wave_number;
-    /* 10 */ le_uint16_t wave_number2;
-    /* 12 */ le_uint16_t unknown_a1;
-    /* 14 */ le_float x;
-    /* 18 */ le_float y;
-    /* 1C */ le_float z;
-    /* 20 */ le_uint32_t x_angle;
-    /* 24 */ le_uint32_t y_angle;
-    /* 28 */ le_uint32_t z_angle;
-    /* 2C */ le_float fparam1;
-    /* 30 */ le_float fparam2;
-    /* 34 */ le_float fparam3;
-    /* 38 */ le_float fparam4;
-    /* 3C */ le_float fparam5;
-    /* 40 */ le_uint16_t uparam1;
-    /* 42 */ le_uint16_t uparam2;
-    /* 44 */ le_uint32_t unused; // Reserved for pointer in client's memory; unused by server
-    /* 48 */
-
-    std::string str() const;
-  } __packed_ws__(EnemyEntry, 0x48);
-
-  struct EventsSectionHeader { // Section type 3 (WAVE_EVENTS)
-    /* 00 */ le_uint32_t action_stream_offset;
-    /* 04 */ le_uint32_t entries_offset;
-    /* 08 */ le_uint32_t entry_count;
-    /* 0C */ be_uint32_t format; // 0 or 'evt2'
-    /* 10 */
-  } __packed_ws__(EventsSectionHeader, 0x10);
-
-  struct Event1Entry { // Section type 3 (WAVE_EVENTS) if format == 0
-    /* 00 */ le_uint32_t event_id;
-    // Bits in flags:
-    //   0004 = is active
-    //   0008 = post-wave actions have been run
-    //   0010 = all enemies killed
-    /* 04 */ le_uint16_t flags;
-    /* 06 */ le_uint16_t event_type;
-    /* 08 */ le_uint16_t section;
-    /* 0A */ le_uint16_t wave_number;
-    /* 0C */ le_uint32_t delay;
-    /* 10 */ le_uint32_t action_stream_offset;
-    /* 14 */
-  } __packed_ws__(Event1Entry, 0x14);
-
-  struct Event2Entry { // Section type 3 (WAVE_EVENTS) if format == 'evt2'
-    /* 00 */ le_uint32_t event_id;
-    /* 04 */ le_uint16_t flags;
-    /* 06 */ le_uint16_t event_type;
-    /* 08 */ le_uint16_t section;
-    /* 0A */ le_uint16_t wave_number;
-    /* 0C */ le_uint16_t min_delay;
-    /* 0E */ le_uint16_t max_delay;
-    /* 10 */ uint8_t min_enemies;
-    /* 11 */ uint8_t max_enemies;
-    /* 12 */ le_uint16_t max_waves;
-    /* 14 */ le_uint32_t action_stream_offset;
-    /* 18 */
-  } __packed_ws__(Event2Entry, 0x18);
-
-  struct RandomEnemyLocationsHeader { // Section type 4 (RANDOM_ENEMY_LOCATIONS)
-    /* 00 */ le_uint32_t section_table_offset; // Offset to RandomEnemyLocationSegment structs, from start of this struct
-    /* 04 */ le_uint32_t entries_offset; // Offset to RandomEnemyLocationEntry structs, from start of this struct
-    /* 08 */ le_uint32_t num_sections;
-    /* 0C */
-  } __packed_ws__(RandomEnemyLocationsHeader, 0x0C);
-
-  struct RandomEnemyLocationSection { // Section type 4 (RANDOM_ENEMY_LOCATIONS)
-    /* 00 */ le_uint16_t section;
-    /* 02 */ le_uint16_t count;
-    /* 04 */ le_uint32_t offset;
-    /* 08 */
-  } __packed_ws__(RandomEnemyLocationSection, 8);
-
-  struct RandomEnemyLocationEntry { // Section type 4 (RANDOM_ENEMY_LOCATIONS)
-    /* 00 */ le_float x;
-    /* 04 */ le_float y;
-    /* 08 */ le_float z;
-    /* 0C */ le_uint32_t x_angle;
-    /* 10 */ le_uint32_t y_angle;
-    /* 14 */ le_uint32_t z_angle;
-    /* 18 */ uint16_t unknown_a9;
-    /* 1A */ uint16_t unknown_a10;
-    /* 1C */
-  } __packed_ws__(RandomEnemyLocationEntry, 0x1C);
-
-  struct RandomEnemyDefinitionsHeader { // Section type 5 (RANDOM_ENEMY_DEFINITIONS)
-    /* 00 */ le_uint32_t entries_offset; // Offset to RandomEnemyDefinition structs, from start of this struct
-    /* 04 */ le_uint32_t weight_entries_offset; // Offset to RandomEnemyDefinitionWeights structs, from start of this struct
-    /* 08 */ le_uint32_t entry_count;
-    /* 0C */ le_uint32_t weight_entry_count;
-    /* 10 */
-  } __packed_ws__(RandomEnemyDefinitionsHeader, 0x10);
-
-  struct RandomEnemyDefinition { // Section type 5 (RANDOM_ENEMY_DEFINITIONS)
-    // All fields through entry_num map to the corresponding fields in
-    // EnemyEntry. Note that the order of the uparam fields is switched!
-    /* 00 */ le_float fparam1;
-    /* 04 */ le_float fparam2;
-    /* 08 */ le_float fparam3;
-    /* 0C */ le_float fparam4;
-    /* 10 */ le_float fparam5;
-    /* 14 */ le_uint16_t uparam2;
-    /* 16 */ le_uint16_t uparam1;
-    /* 18 */ le_uint32_t entry_num;
-    /* 1C */ le_uint16_t min_children;
-    /* 1E */ le_uint16_t max_children;
-    /* 20 */
-  } __packed_ws__(RandomEnemyDefinition, 0x20);
-
-  struct RandomEnemyWeight { // Section type 5 (RANDOM_ENEMY_DEFINITIONS)
-    /* 00 */ uint8_t base_type_index;
-    /* 01 */ uint8_t definition_entry_num;
-    /* 02 */ uint8_t weight;
-    /* 03 */ uint8_t unknown_a4;
-    /* 04 */
-  } __packed_ws__(RandomEnemyWeight, 4);
-
-  struct RareEnemyRates {
-    uint32_t hildeblue; // HILDEBEAR -> HILDEBLUE
-    uint32_t rappy; // RAG_RAPPY -> {AL_RAPPY or seasonal rappies}; SAND_RAPPY -> DEL_RAPPY
-    uint32_t nar_lily; // POISON_LILY -> NAR_LILY
-    uint32_t pouilly_slime; // POFUILLY_SLIME -> POUILLY_SLIME
-    uint32_t merissa_aa; // MERISSA_A -> MERISSA_AA
-    uint32_t pazuzu; // ZU -> PAZUZU (and _ALT variants)
-    uint32_t dorphon_eclair; // DORPHON -> DORPHON_ECLAIR
-    uint32_t kondrieu; // {SAINT_MILLION, SHAMBERTIN} -> KONDRIEU
-
-    RareEnemyRates(uint32_t enemy_rate, uint32_t boss_rate);
-    explicit RareEnemyRates(const JSON& json);
-
-    JSON json() const;
-  };
-
-  static const std::shared_ptr<const RareEnemyRates> NO_RARE_ENEMIES;
-  static const std::shared_ptr<const RareEnemyRates> DEFAULT_RARE_ENEMIES;
-
-  struct Object {
-    // TODO: Add more fields in here if we ever care about them. Currently we
-    // only care about boxes with fixed item drops.
-    size_t source_index;
-    uint8_t floor;
-    uint16_t object_id;
-    uint16_t base_type;
-    uint16_t section;
-    uint16_t group;
-    float param1; // If <= 0, this is a specialized box, and the specialization is in param4/5/6
-    float param3; // If == 0, the item should be varied by difficulty and area
-    uint32_t param4;
-    uint32_t param5;
-    uint32_t param6;
-    uint16_t game_flags;
-    // Technically set_flags shouldn't be part of the Object struct, but all
-    // object entries always generate exactly one object, so we store it here.
-    uint16_t set_flags;
-    bool item_drop_checked;
-
-    std::string str() const;
-  };
-
-  struct Enemy {
-    enum Flag {
-      EXP_REQUESTED_BY_PLAYER0 = 0x01,
-      EXP_REQUESTED_BY_PLAYER1 = 0x02,
-      EXP_REQUESTED_BY_PLAYER2 = 0x04,
-      EXP_REQUESTED_BY_PLAYER3 = 0x08,
-      ITEM_DROPPED = 0x10,
-    };
-    size_t source_index;
-    size_t set_index;
-    uint16_t enemy_id;
-    uint16_t total_damage;
-    uint32_t game_flags; // From 6x0A
-    uint16_t section;
-    uint16_t wave_number;
-    EnemyType type;
-    uint8_t floor;
-    uint8_t state_flags;
-
-    Enemy(
-        uint16_t enemy_id,
-        size_t source_index,
-        size_t set_index,
-        uint8_t floor,
-        uint16_t section,
-        uint16_t wave_number,
-        EnemyType type);
-
-    std::string str() const;
-  };
-
-  struct Event {
-    uint32_t event_id;
-    uint16_t flags;
-    uint16_t section;
-    uint16_t wave_number;
-    uint8_t floor;
-    uint32_t action_stream_offset;
-    std::vector<size_t> enemy_indexes;
-
-    std::string str() const;
-  };
-
-  struct DATParserRandomState {
-    PSOV2Encryption random;
-    PSOV2Encryption location_table_random;
-    std::array<uint32_t, 0x20> location_index_table;
-    uint32_t location_indexes_populated;
-    uint32_t location_indexes_used;
-    uint32_t location_entries_base_offset;
-
-    DATParserRandomState(uint32_t rare_seed);
-    size_t rand_int_biased(size_t min_v, size_t max_v);
-    uint32_t next_location_index();
-    void generate_shuffled_location_table(const Map::RandomEnemyLocationsHeader& header, StringReader r, uint16_t section);
-  };
-
-  Map(Version version, uint32_t lobby_id, uint32_t rare_seed, std::shared_ptr<PSOLFGEncryption> opt_rand_crypt);
-  ~Map() = default;
-
-  void clear();
-
-  void add_objects_from_map_data(uint8_t floor, const void* data, size_t size);
-
-  bool check_and_log_rare_enemy(bool default_is_rare, uint32_t rare_rate);
-  void add_enemy(
-      Episode episode,
-      uint8_t difficulty,
-      uint8_t event,
-      uint8_t floor,
-      size_t index,
-      const EnemyEntry& e,
-      std::shared_ptr<const RareEnemyRates> rare_rates = DEFAULT_RARE_ENEMIES);
-  void add_enemies_from_map_data(
-      Episode episode,
-      uint8_t difficulty,
-      uint8_t event,
-      uint8_t floor,
-      const void* data,
-      size_t size,
-      std::shared_ptr<const RareEnemyRates> rare_rates = DEFAULT_RARE_ENEMIES);
-  void add_random_enemies_from_map_data(
-      Episode episode,
-      uint8_t difficulty,
-      uint8_t event,
-      uint8_t floor,
-      StringReader wave_events_r,
-      StringReader random_enemy_locations_r,
-      StringReader random_enemy_definitions_r,
-      std::shared_ptr<DATParserRandomState> random_state,
-      std::shared_ptr<const RareEnemyRates> rare_rates = DEFAULT_RARE_ENEMIES);
-
-  void add_event(
-      uint32_t event_id,
-      uint16_t flags,
-      uint8_t floor,
-      uint16_t section,
-      uint16_t wave_number,
-      uint32_t action_stream_offset);
-  std::vector<Event*> get_events(uint8_t floor, uint32_t event_id);
-  std::vector<const Event*> get_events(uint8_t floor, uint32_t event_id) const;
-  void add_events_from_map_data(uint8_t floor, const void* data, size_t size);
-
-  struct DATSectionsForFloor {
-    uint32_t objects = 0xFFFFFFFF;
-    uint32_t enemies = 0xFFFFFFFF;
-    uint32_t wave_events = 0xFFFFFFFF;
-    uint32_t random_enemy_locations = 0xFFFFFFFF;
-    uint32_t random_enemy_definitions = 0xFFFFFFFF;
-  };
-  static std::vector<DATSectionsForFloor> collect_quest_map_data_sections(const void* data, size_t size);
-
-  void add_entities_from_quest_data(
-      Episode episode,
-      uint8_t difficulty,
-      uint8_t event,
-      const void* data,
-      size_t size,
-      std::shared_ptr<const RareEnemyRates> rare_rates = Map::DEFAULT_RARE_ENEMIES);
-
-  const Enemy& find_enemy(uint8_t floor, EnemyType type) const;
-  Enemy& find_enemy(uint8_t floor, EnemyType type);
-  std::vector<Object*> get_objects(uint8_t floor, uint16_t section, uint16_t wave_number);
-  std::vector<Enemy*> get_enemies(uint8_t floor, uint16_t section, uint16_t wave_number);
-  std::vector<Event*> get_events(uint8_t floor, uint16_t section, uint16_t wave_number);
-  std::vector<Event*> get_events(uint8_t floor);
-
-  static std::string disassemble_objects_data(const void* data, size_t size, size_t* object_number = nullptr);
-  static std::string disassemble_enemies_data(const void* data, size_t size, size_t* enemy_number = nullptr);
-  static std::string disassemble_wave_events_data(const void* data, size_t size, uint8_t floor = 0xFF);
-  static std::string disassemble_quest_data(const void* data, size_t size);
-
-  PrefixedLogger log;
-  Version version;
-  uint32_t rare_seed;
-  std::shared_ptr<PSOLFGEncryption> opt_rand_crypt;
-  std::vector<Object> objects;
-  std::vector<Enemy> enemies;
-  std::vector<uint16_t> enemy_set_flags;
-  std::vector<size_t> rare_enemy_indexes;
-  std::vector<Event> events;
-  std::string event_action_stream;
-  std::multimap<uint64_t, size_t> floor_and_event_id_to_index;
-  std::unordered_multimap<uint64_t, size_t> floor_section_and_group_to_object_index;
-  std::unordered_multimap<uint64_t, size_t> floor_section_and_wave_number_to_enemy_index;
-  std::unordered_multimap<uint64_t, size_t> floor_section_and_wave_number_to_event_index;
-};
-
-class SetDataTableBase {
-public:
-  virtual ~SetDataTableBase() = default;
-
-  parray<le_uint32_t, 0x20> generate_variations(
-      Episode episode,
-      bool is_solo,
-      std::shared_ptr<PSOLFGEncryption> opt_rand_crypt = nullptr) const;
-  virtual std::pair<uint32_t, uint32_t> num_available_variations_for_floor(Episode episode, uint8_t floor) const = 0;
-  virtual std::pair<uint32_t, uint32_t> num_free_roam_variations_for_floor(Episode episode, bool is_solo, uint8_t floor) const = 0;
-
-  enum class FilenameType {
-    OBJECTS = 0,
-    ENEMIES,
-    EVENTS,
-  };
-
-  virtual std::string map_filename_for_variation(
-      uint8_t floor, uint32_t var1, uint32_t var2, Episode episode, GameMode mode, FilenameType type) const = 0;
-  std::vector<std::string> map_filenames_for_variations(
-      const parray<le_uint32_t, 0x20>& variations, Episode episode, GameMode mode, FilenameType type) const;
-
-  uint8_t default_area_for_floor(Episode episode, uint8_t floor) const;
-
-protected:
-  explicit SetDataTableBase(Version version);
-
-  Version version;
-};
-
-class SetDataTable : public SetDataTableBase {
-public:
-  struct SetEntry {
-    std::string object_list_basename;
-    std::string enemy_and_event_list_basename;
-    std::string area_setup_filename;
-  };
-
-  SetDataTable(Version version, const std::string& data);
-  virtual ~SetDataTable() = default;
-
-  virtual std::pair<uint32_t, uint32_t> num_available_variations_for_floor(Episode episode, uint8_t floor) const;
-  virtual std::pair<uint32_t, uint32_t> num_free_roam_variations_for_floor(Episode episode, bool is_solo, uint8_t floor) const;
-  virtual std::string map_filename_for_variation(
-      uint8_t floor, uint32_t var1, uint32_t var2, Episode episode, GameMode mode, FilenameType type) const;
-
-  std::string str() const;
-
-private:
-  template <bool IsBigEndian>
-  void load_table_t(const std::string& data);
-
-  // Indexes are [floor][variation1][variation2]
-  // floor is cumulative per episode, so Ep2 starts at floor=18.
-  std::vector<std::vector<std::vector<SetEntry>>> entries;
-};
-
-class SetDataTableDCNTE : public SetDataTableBase {
-public:
-  SetDataTableDCNTE();
-  virtual ~SetDataTableDCNTE() = default;
-
-  virtual std::pair<uint32_t, uint32_t> num_available_variations_for_floor(Episode episode, uint8_t floor) const;
-  virtual std::pair<uint32_t, uint32_t> num_free_roam_variations_for_floor(Episode episode, bool is_solo, uint8_t floor) const;
-  virtual std::string map_filename_for_variation(
-      uint8_t floor, uint32_t var1, uint32_t var2, Episode episode, GameMode mode, FilenameType type) const;
-
-private:
-  static const std::array<std::vector<std::vector<std::string>>, 0x12> NAMES;
-};
-
-class SetDataTableDC112000 : public SetDataTableBase {
-public:
-  SetDataTableDC112000();
-  virtual ~SetDataTableDC112000() = default;
-
-  virtual std::pair<uint32_t, uint32_t> num_available_variations_for_floor(Episode episode, uint8_t floor) const;
-  virtual std::pair<uint32_t, uint32_t> num_free_roam_variations_for_floor(Episode episode, bool is_solo, uint8_t floor) const;
-  virtual std::string map_filename_for_variation(
-      uint8_t floor, uint32_t var1, uint32_t var2, Episode episode, GameMode mode, FilenameType type) const;
-
-private:
-  static const std::array<std::vector<std::vector<std::string>>, 0x12> NAMES;
-};
-
-void generate_variations_deprecated(
-    parray<le_uint32_t, 0x20>& variations,
-    std::shared_ptr<PSOLFGEncryption> random,
-    Version version,
-    Episode episode,
-    bool is_solo);
-
-parray<le_uint32_t, 0x20> variation_maxes_deprecated(Version version, Episode episode, bool is_solo);
-bool next_variation_deprecated(parray<le_uint32_t, 0x20>& variations, Version version, Episode episode, bool is_solo);
-
-std::vector<std::string> map_filenames_for_variation_deprecated(
-    uint8_t floor, uint32_t var1, uint32_t var2, Version version, Episode episode, GameMode mode, bool is_enemies);
-std::vector<std::vector<std::string>> map_filenames_for_variations_deprecated(
-    const parray<le_uint32_t, 0x20>& variations,
-    Version version,
-    Episode episode,
-    GameMode mode,
-    bool is_enemies);
+#pragma once
+
+#include <inttypes.h>
+
+#include <memory>
+#include <phosg/Encoding.hh>
+#include <phosg/JSON.hh>
+#include <random>
+#include <string>
+#include <vector>
+
+#include "BattleParamsIndex.hh"
+#include "PSOEncryption.hh"
+#include "StaticGameData.hh"
+#include "Text.hh"
+
+struct Map {
+  static const char* name_for_object_type(uint16_t type);
+
+  struct SectionHeader {
+    enum class Type {
+      END = 0,
+      OBJECTS = 1,
+      ENEMIES = 2,
+      WAVE_EVENTS = 3,
+      RANDOM_ENEMY_LOCATIONS = 4,
+      RANDOM_ENEMY_DEFINITIONS = 5,
+    };
+    le_uint32_t le_type;
+    le_uint32_t section_size; // Includes this header
+    le_uint32_t floor;
+    le_uint32_t data_size;
+
+    inline Type type() const {
+      return static_cast<Type>(this->le_type.load());
+    }
+  } __packed_ws__(SectionHeader, 0x10);
+
+  struct ObjectEntry { // Section type 1 (OBJECTS)
+    /* 00 */ le_uint16_t base_type;
+    /* 02 */ le_uint16_t flags;
+    /* 04 */ le_uint16_t index;
+    /* 06 */ le_uint16_t unknown_a2;
+    /* 08 */ le_uint16_t entity_id; // == index + 0x4000
+    /* 0A */ le_uint16_t group;
+    /* 0C */ le_uint16_t section;
+    /* 0E */ le_uint16_t unknown_a3;
+    /* 10 */ le_float x;
+    /* 14 */ le_float y;
+    /* 18 */ le_float z;
+    /* 1C */ le_uint32_t x_angle;
+    /* 20 */ le_uint32_t y_angle;
+    /* 24 */ le_uint32_t z_angle;
+    /* 28 */ le_float param1; // If <= 0, this is a specialized box, and the specialization is in param4/5/6
+    /* 2C */ le_float param2;
+    /* 30 */ le_float param3;
+    /* 34 */ le_uint32_t param4;
+    /* 38 */ le_uint32_t param5;
+    /* 3C */ le_uint32_t param6;
+    /* 40 */ le_uint32_t unused; // Reserved for pointer in client's memory; unused by server
+    /* 44 */
+
+    std::string str() const;
+  } __packed_ws__(ObjectEntry, 0x44);
+
+  struct EnemyEntry { // Section type 2 (ENEMIES)
+    /* 00 */ le_uint16_t base_type;
+    /* 02 */ le_uint16_t flags;
+    /* 04 */ le_uint16_t index;
+    /* 06 */ le_uint16_t num_children;
+    /* 08 */ le_uint16_t floor;
+    /* 0A */ le_uint16_t entity_id; // == index + 0x1000
+    /* 0C */ le_uint16_t section;
+    /* 0E */ le_uint16_t wave_number;
+    /* 10 */ le_uint16_t wave_number2;
+    /* 12 */ le_uint16_t unknown_a1;
+    /* 14 */ le_float x;
+    /* 18 */ le_float y;
+    /* 1C */ le_float z;
+    /* 20 */ le_uint32_t x_angle;
+    /* 24 */ le_uint32_t y_angle;
+    /* 28 */ le_uint32_t z_angle;
+    /* 2C */ le_float fparam1;
+    /* 30 */ le_float fparam2;
+    /* 34 */ le_float fparam3;
+    /* 38 */ le_float fparam4;
+    /* 3C */ le_float fparam5;
+    /* 40 */ le_uint16_t uparam1;
+    /* 42 */ le_uint16_t uparam2;
+    /* 44 */ le_uint32_t unused; // Reserved for pointer in client's memory; unused by server
+    /* 48 */
+
+    std::string str() const;
+  } __packed_ws__(EnemyEntry, 0x48);
+
+  struct EventsSectionHeader { // Section type 3 (WAVE_EVENTS)
+    /* 00 */ le_uint32_t action_stream_offset;
+    /* 04 */ le_uint32_t entries_offset;
+    /* 08 */ le_uint32_t entry_count;
+    /* 0C */ be_uint32_t format; // 0 or 'evt2'
+    /* 10 */
+  } __packed_ws__(EventsSectionHeader, 0x10);
+
+  struct Event1Entry { // Section type 3 (WAVE_EVENTS) if format == 0
+    /* 00 */ le_uint32_t event_id;
+    // Bits in flags:
+    //   0004 = is active
+    //   0008 = post-wave actions have been run
+    //   0010 = all enemies killed
+    /* 04 */ le_uint16_t flags;
+    /* 06 */ le_uint16_t event_type;
+    /* 08 */ le_uint16_t section;
+    /* 0A */ le_uint16_t wave_number;
+    /* 0C */ le_uint32_t delay;
+    /* 10 */ le_uint32_t action_stream_offset;
+    /* 14 */
+  } __packed_ws__(Event1Entry, 0x14);
+
+  struct Event2Entry { // Section type 3 (WAVE_EVENTS) if format == 'evt2'
+    /* 00 */ le_uint32_t event_id;
+    /* 04 */ le_uint16_t flags;
+    /* 06 */ le_uint16_t event_type;
+    /* 08 */ le_uint16_t section;
+    /* 0A */ le_uint16_t wave_number;
+    /* 0C */ le_uint16_t min_delay;
+    /* 0E */ le_uint16_t max_delay;
+    /* 10 */ uint8_t min_enemies;
+    /* 11 */ uint8_t max_enemies;
+    /* 12 */ le_uint16_t max_waves;
+    /* 14 */ le_uint32_t action_stream_offset;
+    /* 18 */
+  } __packed_ws__(Event2Entry, 0x18);
+
+  struct RandomEnemyLocationsHeader { // Section type 4 (RANDOM_ENEMY_LOCATIONS)
+    /* 00 */ le_uint32_t section_table_offset; // Offset to RandomEnemyLocationSegment structs, from start of this struct
+    /* 04 */ le_uint32_t entries_offset; // Offset to RandomEnemyLocationEntry structs, from start of this struct
+    /* 08 */ le_uint32_t num_sections;
+    /* 0C */
+  } __packed_ws__(RandomEnemyLocationsHeader, 0x0C);
+
+  struct RandomEnemyLocationSection { // Section type 4 (RANDOM_ENEMY_LOCATIONS)
+    /* 00 */ le_uint16_t section;
+    /* 02 */ le_uint16_t count;
+    /* 04 */ le_uint32_t offset;
+    /* 08 */
+  } __packed_ws__(RandomEnemyLocationSection, 8);
+
+  struct RandomEnemyLocationEntry { // Section type 4 (RANDOM_ENEMY_LOCATIONS)
+    /* 00 */ le_float x;
+    /* 04 */ le_float y;
+    /* 08 */ le_float z;
+    /* 0C */ le_uint32_t x_angle;
+    /* 10 */ le_uint32_t y_angle;
+    /* 14 */ le_uint32_t z_angle;
+    /* 18 */ uint16_t unknown_a9;
+    /* 1A */ uint16_t unknown_a10;
+    /* 1C */
+  } __packed_ws__(RandomEnemyLocationEntry, 0x1C);
+
+  struct RandomEnemyDefinitionsHeader { // Section type 5 (RANDOM_ENEMY_DEFINITIONS)
+    /* 00 */ le_uint32_t entries_offset; // Offset to RandomEnemyDefinition structs, from start of this struct
+    /* 04 */ le_uint32_t weight_entries_offset; // Offset to RandomEnemyDefinitionWeights structs, from start of this struct
+    /* 08 */ le_uint32_t entry_count;
+    /* 0C */ le_uint32_t weight_entry_count;
+    /* 10 */
+  } __packed_ws__(RandomEnemyDefinitionsHeader, 0x10);
+
+  struct RandomEnemyDefinition { // Section type 5 (RANDOM_ENEMY_DEFINITIONS)
+    // All fields through entry_num map to the corresponding fields in
+    // EnemyEntry. Note that the order of the uparam fields is switched!
+    /* 00 */ le_float fparam1;
+    /* 04 */ le_float fparam2;
+    /* 08 */ le_float fparam3;
+    /* 0C */ le_float fparam4;
+    /* 10 */ le_float fparam5;
+    /* 14 */ le_uint16_t uparam2;
+    /* 16 */ le_uint16_t uparam1;
+    /* 18 */ le_uint32_t entry_num;
+    /* 1C */ le_uint16_t min_children;
+    /* 1E */ le_uint16_t max_children;
+    /* 20 */
+  } __packed_ws__(RandomEnemyDefinition, 0x20);
+
+  struct RandomEnemyWeight { // Section type 5 (RANDOM_ENEMY_DEFINITIONS)
+    /* 00 */ uint8_t base_type_index;
+    /* 01 */ uint8_t definition_entry_num;
+    /* 02 */ uint8_t weight;
+    /* 03 */ uint8_t unknown_a4;
+    /* 04 */
+  } __packed_ws__(RandomEnemyWeight, 4);
+
+  struct RareEnemyRates {
+    uint32_t hildeblue; // HILDEBEAR -> HILDEBLUE
+    uint32_t rappy; // RAG_RAPPY -> {AL_RAPPY or seasonal rappies}; SAND_RAPPY -> DEL_RAPPY
+    uint32_t nar_lily; // POISON_LILY -> NAR_LILY
+    uint32_t pouilly_slime; // POFUILLY_SLIME -> POUILLY_SLIME
+    uint32_t merissa_aa; // MERISSA_A -> MERISSA_AA
+    uint32_t pazuzu; // ZU -> PAZUZU (and _ALT variants)
+    uint32_t dorphon_eclair; // DORPHON -> DORPHON_ECLAIR
+    uint32_t kondrieu; // {SAINT_MILLION, SHAMBERTIN} -> KONDRIEU
+
+    RareEnemyRates(uint32_t enemy_rate, uint32_t boss_rate);
+    explicit RareEnemyRates(const JSON& json);
+
+    JSON json() const;
+  };
+
+  static const std::shared_ptr<const RareEnemyRates> NO_RARE_ENEMIES;
+  static const std::shared_ptr<const RareEnemyRates> DEFAULT_RARE_ENEMIES;
+
+  struct Object {
+    // TODO: Add more fields in here if we ever care about them. Currently we
+    // only care about boxes with fixed item drops.
+    size_t source_index;
+    uint8_t floor;
+    uint16_t object_id;
+    uint16_t base_type;
+    uint16_t section;
+    uint16_t group;
+    float param1; // If <= 0, this is a specialized box, and the specialization is in param4/5/6
+    float param3; // If == 0, the item should be varied by difficulty and area
+    uint32_t param4;
+    uint32_t param5;
+    uint32_t param6;
+    uint16_t game_flags;
+    // Technically set_flags shouldn't be part of the Object struct, but all
+    // object entries always generate exactly one object, so we store it here.
+    uint16_t set_flags;
+    bool item_drop_checked;
+
+    std::string str() const;
+  };
+
+  struct Enemy {
+    enum Flag {
+      LAST_HIT_MASK = 0x03,
+      EXP_GIVEN = 0x04,
+      ITEM_DROPPED = 0x08,
+      ALL_HITS_MASK_FIRST = 0x10,
+      ALL_HITS_MASK = 0xF0,
+    };
+    size_t source_index;
+    size_t set_index;
+    uint16_t enemy_id;
+    uint16_t total_damage;
+    uint32_t game_flags; // From 6x0A
+    uint16_t section;
+    uint16_t wave_number;
+    EnemyType type;
+    uint8_t floor;
+    uint8_t server_flags;
+
+    Enemy(
+        uint16_t enemy_id,
+        size_t source_index,
+        size_t set_index,
+        uint8_t floor,
+        uint16_t section,
+        uint16_t wave_number,
+        EnemyType type);
+
+    std::string str() const;
+
+    inline bool ever_hit_by_client_id(uint8_t client_id) const {
+      return this->server_flags & (Flag::ALL_HITS_MASK_FIRST << client_id);
+    }
+    inline bool last_hit_by_client_id(uint8_t client_id) const {
+      return (this->server_flags & Flag::LAST_HIT_MASK) == client_id;
+    }
+    inline void set_last_hit_by_client_id(uint8_t client_id) {
+      this->server_flags = (this->server_flags & (~Flag::LAST_HIT_MASK)) | (Flag::ALL_HITS_MASK_FIRST << client_id) | (client_id & 3);
+    }
+  };
+
+  struct Event {
+    uint32_t event_id;
+    uint16_t flags;
+    uint16_t section;
+    uint16_t wave_number;
+    uint8_t floor;
+    uint32_t action_stream_offset;
+    std::vector<size_t> enemy_indexes;
+
+    std::string str() const;
+  };
+
+  struct DATParserRandomState {
+    PSOV2Encryption random;
+    PSOV2Encryption location_table_random;
+    std::array<uint32_t, 0x20> location_index_table;
+    uint32_t location_indexes_populated;
+    uint32_t location_indexes_used;
+    uint32_t location_entries_base_offset;
+
+    DATParserRandomState(uint32_t rare_seed);
+    size_t rand_int_biased(size_t min_v, size_t max_v);
+    uint32_t next_location_index();
+    void generate_shuffled_location_table(const Map::RandomEnemyLocationsHeader& header, StringReader r, uint16_t section);
+  };
+
+  Map(Version version, uint32_t lobby_id, uint32_t rare_seed, std::shared_ptr<PSOLFGEncryption> opt_rand_crypt);
+  ~Map() = default;
+
+  void clear();
+
+  void add_objects_from_map_data(uint8_t floor, const void* data, size_t size);
+
+  bool check_and_log_rare_enemy(bool default_is_rare, uint32_t rare_rate);
+  void add_enemy(
+      Episode episode,
+      uint8_t difficulty,
+      uint8_t event,
+      uint8_t floor,
+      size_t index,
+      const EnemyEntry& e,
+      std::shared_ptr<const RareEnemyRates> rare_rates = DEFAULT_RARE_ENEMIES);
+  void add_enemies_from_map_data(
+      Episode episode,
+      uint8_t difficulty,
+      uint8_t event,
+      uint8_t floor,
+      const void* data,
+      size_t size,
+      std::shared_ptr<const RareEnemyRates> rare_rates = DEFAULT_RARE_ENEMIES);
+  void add_random_enemies_from_map_data(
+      Episode episode,
+      uint8_t difficulty,
+      uint8_t event,
+      uint8_t floor,
+      StringReader wave_events_r,
+      StringReader random_enemy_locations_r,
+      StringReader random_enemy_definitions_r,
+      std::shared_ptr<DATParserRandomState> random_state,
+      std::shared_ptr<const RareEnemyRates> rare_rates = DEFAULT_RARE_ENEMIES);
+
+  void add_event(
+      uint32_t event_id,
+      uint16_t flags,
+      uint8_t floor,
+      uint16_t section,
+      uint16_t wave_number,
+      uint32_t action_stream_offset);
+  std::vector<Event*> get_events(uint8_t floor, uint32_t event_id);
+  std::vector<const Event*> get_events(uint8_t floor, uint32_t event_id) const;
+  void add_events_from_map_data(uint8_t floor, const void* data, size_t size);
+
+  struct DATSectionsForFloor {
+    uint32_t objects = 0xFFFFFFFF;
+    uint32_t enemies = 0xFFFFFFFF;
+    uint32_t wave_events = 0xFFFFFFFF;
+    uint32_t random_enemy_locations = 0xFFFFFFFF;
+    uint32_t random_enemy_definitions = 0xFFFFFFFF;
+  };
+  static std::vector<DATSectionsForFloor> collect_quest_map_data_sections(const void* data, size_t size);
+
+  void add_entities_from_quest_data(
+      Episode episode,
+      uint8_t difficulty,
+      uint8_t event,
+      const void* data,
+      size_t size,
+      std::shared_ptr<const RareEnemyRates> rare_rates = Map::DEFAULT_RARE_ENEMIES);
+
+  const Enemy& find_enemy(uint8_t floor, EnemyType type) const;
+  Enemy& find_enemy(uint8_t floor, EnemyType type);
+  std::vector<Object*> get_objects(uint8_t floor, uint16_t section, uint16_t wave_number);
+  std::vector<Enemy*> get_enemies(uint8_t floor, uint16_t section, uint16_t wave_number);
+  std::vector<Event*> get_events(uint8_t floor, uint16_t section, uint16_t wave_number);
+  std::vector<Event*> get_events(uint8_t floor);
+
+  static std::string disassemble_objects_data(const void* data, size_t size, size_t* object_number = nullptr);
+  static std::string disassemble_enemies_data(const void* data, size_t size, size_t* enemy_number = nullptr);
+  static std::string disassemble_wave_events_data(const void* data, size_t size, uint8_t floor = 0xFF);
+  static std::string disassemble_quest_data(const void* data, size_t size);
+
+  PrefixedLogger log;
+  Version version;
+  uint32_t rare_seed;
+  std::shared_ptr<PSOLFGEncryption> opt_rand_crypt;
+  std::vector<Object> objects;
+  std::vector<Enemy> enemies;
+  std::vector<uint16_t> enemy_set_flags;
+  std::vector<size_t> rare_enemy_indexes;
+  std::vector<Event> events;
+  std::string event_action_stream;
+  std::multimap<uint64_t, size_t> floor_and_event_id_to_index;
+  std::unordered_multimap<uint64_t, size_t> floor_section_and_group_to_object_index;
+  std::unordered_multimap<uint64_t, size_t> floor_section_and_wave_number_to_enemy_index;
+  std::unordered_multimap<uint64_t, size_t> floor_section_and_wave_number_to_event_index;
+};
+
+class SetDataTableBase {
+public:
+  virtual ~SetDataTableBase() = default;
+
+  parray<le_uint32_t, 0x20> generate_variations(
+      Episode episode,
+      bool is_solo,
+      std::shared_ptr<PSOLFGEncryption> opt_rand_crypt = nullptr) const;
+  virtual std::pair<uint32_t, uint32_t> num_available_variations_for_floor(Episode episode, uint8_t floor) const = 0;
+  virtual std::pair<uint32_t, uint32_t> num_free_roam_variations_for_floor(Episode episode, bool is_solo, uint8_t floor) const = 0;
+
+  enum class FilenameType {
+    OBJECTS = 0,
+    ENEMIES,
+    EVENTS,
+  };
+
+  virtual std::string map_filename_for_variation(
+      uint8_t floor, uint32_t var1, uint32_t var2, Episode episode, GameMode mode, FilenameType type) const = 0;
+  std::vector<std::string> map_filenames_for_variations(
+      const parray<le_uint32_t, 0x20>& variations, Episode episode, GameMode mode, FilenameType type) const;
+
+  uint8_t default_area_for_floor(Episode episode, uint8_t floor) const;
+
+protected:
+  explicit SetDataTableBase(Version version);
+
+  Version version;
+};
+
+class SetDataTable : public SetDataTableBase {
+public:
+  struct SetEntry {
+    std::string object_list_basename;
+    std::string enemy_and_event_list_basename;
+    std::string area_setup_filename;
+  };
+
+  SetDataTable(Version version, const std::string& data);
+  virtual ~SetDataTable() = default;
+
+  virtual std::pair<uint32_t, uint32_t> num_available_variations_for_floor(Episode episode, uint8_t floor) const;
+  virtual std::pair<uint32_t, uint32_t> num_free_roam_variations_for_floor(Episode episode, bool is_solo, uint8_t floor) const;
+  virtual std::string map_filename_for_variation(
+      uint8_t floor, uint32_t var1, uint32_t var2, Episode episode, GameMode mode, FilenameType type) const;
+
+  std::string str() const;
+
+private:
+  template <bool IsBigEndian>
+  void load_table_t(const std::string& data);
+
+  // Indexes are [floor][variation1][variation2]
+  // floor is cumulative per episode, so Ep2 starts at floor=18.
+  std::vector<std::vector<std::vector<SetEntry>>> entries;
+};
+
+class SetDataTableDCNTE : public SetDataTableBase {
+public:
+  SetDataTableDCNTE();
+  virtual ~SetDataTableDCNTE() = default;
+
+  virtual std::pair<uint32_t, uint32_t> num_available_variations_for_floor(Episode episode, uint8_t floor) const;
+  virtual std::pair<uint32_t, uint32_t> num_free_roam_variations_for_floor(Episode episode, bool is_solo, uint8_t floor) const;
+  virtual std::string map_filename_for_variation(
+      uint8_t floor, uint32_t var1, uint32_t var2, Episode episode, GameMode mode, FilenameType type) const;
+
+private:
+  static const std::array<std::vector<std::vector<std::string>>, 0x12> NAMES;
+};
+
+class SetDataTableDC112000 : public SetDataTableBase {
+public:
+  SetDataTableDC112000();
+  virtual ~SetDataTableDC112000() = default;
+
+  virtual std::pair<uint32_t, uint32_t> num_available_variations_for_floor(Episode episode, uint8_t floor) const;
+  virtual std::pair<uint32_t, uint32_t> num_free_roam_variations_for_floor(Episode episode, bool is_solo, uint8_t floor) const;
+  virtual std::string map_filename_for_variation(
+      uint8_t floor, uint32_t var1, uint32_t var2, Episode episode, GameMode mode, FilenameType type) const;
+
+private:
+  static const std::array<std::vector<std::vector<std::string>>, 0x12> NAMES;
+};
+
+void generate_variations_deprecated(
+    parray<le_uint32_t, 0x20>& variations,
+    std::shared_ptr<PSOLFGEncryption> random,
+    Version version,
+    Episode episode,
+    bool is_solo);
+
+parray<le_uint32_t, 0x20> variation_maxes_deprecated(Version version, Episode episode, bool is_solo);
+bool next_variation_deprecated(parray<le_uint32_t, 0x20>& variations, Version version, Episode episode, bool is_solo);
+
+std::vector<std::string> map_filenames_for_variation_deprecated(
+    uint8_t floor, uint32_t var1, uint32_t var2, Version version, Episode episode, GameMode mode, bool is_enemies);
+std::vector<std::vector<std::string>> map_filenames_for_variations_deprecated(
+    const parray<le_uint32_t, 0x20>& variations,
+    Version version,
+    Episode episode,
+    GameMode mode,
+    bool is_enemies);

src/Menu.hh

@@ -1,146 +1,150 @@
-#pragma once
-
-#include <stdint.h>
-
-#include <functional>
-#include <string>
-#include <vector>
-
-// Note: These aren't enums because neither enum nor enum class does what we
-// want. Specifically, we need GO_BACK to be valid in multiple enums (and enums
-// aren't namespaced unless they're enum classes), so we can't use enums. But we
-// also want to be able to use non-enum values in switch statements without
-// casting values all over the place, so we can't use enum classes either.
-
-namespace MenuID {
-constexpr uint32_t MAIN = 0x11000011;
-constexpr uint32_t CLEAR_LICENSE_CONFIRMATION = 0x11111111;
-constexpr uint32_t INFORMATION = 0x22000022;
-constexpr uint32_t LOBBY = 0x33000033;
-constexpr uint32_t GAME = 0x44000044;
-constexpr uint32_t QUEST_EP1 = 0x55010155;
-constexpr uint32_t QUEST_EP2 = 0x55020255;
-constexpr uint32_t QUEST_CATEGORIES = 0x66010166;
-constexpr uint32_t PROXY_DESTINATIONS = 0x77000077;
-constexpr uint32_t PROGRAMS = 0x88000088;
-constexpr uint32_t PATCHES = 0x99000099;
-constexpr uint32_t PATCH_SWITCHES = 0x99010199;
-constexpr uint32_t PROXY_OPTIONS = 0xAA0000AA;
-constexpr uint32_t TOURNAMENTS = 0xBB0000BB;
-constexpr uint32_t TOURNAMENTS_FOR_SPEC = 0xBB1111BB;
-constexpr uint32_t TOURNAMENT_ENTRIES = 0xCC0000CC;
-} // namespace MenuID
-
-namespace MainMenuItemID {
-constexpr uint32_t GO_TO_LOBBY = 0x11222211;
-constexpr uint32_t INFORMATION = 0x11333311;
-constexpr uint32_t DOWNLOAD_QUESTS = 0x11444411;
-constexpr uint32_t PROXY_DESTINATIONS = 0x11555511;
-constexpr uint32_t PATCHES = 0x11666611;
-constexpr uint32_t PATCH_SWITCHES = 0x11676711;
-constexpr uint32_t PROGRAMS = 0x11777711;
-constexpr uint32_t DISCONNECT = 0x11888811;
-constexpr uint32_t CLEAR_LICENSE = 0x11999911;
-} // namespace MainMenuItemID
-
-namespace ClearLicenseConfirmationMenuItemID {
-constexpr uint32_t CANCEL = 0x01010101;
-constexpr uint32_t CLEAR_LICENSE = 0x02020202;
-} // namespace ClearLicenseConfirmationMenuItemID
-
-namespace InformationMenuItemID {
-constexpr uint32_t GO_BACK = 0x22FFFF22;
-}
-
-namespace ProxyDestinationsMenuItemID {
-constexpr uint32_t GO_BACK = 0x77FFFF77;
-constexpr uint32_t OPTIONS = 0x77EEEE77;
-} // namespace ProxyDestinationsMenuItemID
-
-namespace ProgramsMenuItemID {
-constexpr uint32_t GO_BACK = 0x88FFFF88;
-}
-
-namespace PatchesMenuItemID {
-constexpr uint32_t GO_BACK = 0x99FFFF99;
-}
-
-namespace ProxyOptionsMenuItemID {
-constexpr uint32_t GO_BACK = 0xAAFFFFAA;
-constexpr uint32_t CHAT_COMMANDS = 0xAA0101AA;
-constexpr uint32_t PLAYER_NOTIFICATIONS = 0xAA0202AA;
-constexpr uint32_t DROP_NOTIFICATIONS = 0xAA0303AA;
-constexpr uint32_t BLOCK_PINGS = 0xAA0404AA;
-constexpr uint32_t INFINITE_HP = 0xAA0505AA;
-constexpr uint32_t INFINITE_TP = 0xAA0606AA;
-constexpr uint32_t SWITCH_ASSIST = 0xAA0707AA;
-constexpr uint32_t BLOCK_EVENTS = 0xAA0808AA;
-constexpr uint32_t BLOCK_PATCHES = 0xAA0909AA;
-constexpr uint32_t SAVE_FILES = 0xAA0A0AAA;
-constexpr uint32_t RED_NAME = 0xAA0B0BAA;
-constexpr uint32_t BLANK_NAME = 0xAA0C0CAA;
-constexpr uint32_t SUPPRESS_LOGIN = 0xAA0D0DAA;
-constexpr uint32_t SKIP_CARD = 0xAA0E0EAA;
-constexpr uint32_t EP3_INFINITE_MESETA = 0xAA0F0FAA;
-constexpr uint32_t EP3_INFINITE_TIME = 0xAA1010AA;
-constexpr uint32_t EP3_UNMASK_WHISPERS = 0xAA1111AA;
-} // namespace ProxyOptionsMenuItemID
-
-namespace TeamRewardMenuItemID {
-constexpr uint32_t TEAM_FLAG = 0x01010101;
-constexpr uint32_t DRESSING_ROOM = 0x02020202;
-constexpr uint32_t MEMBERS_20_LEADERS_3 = 0x03030303;
-constexpr uint32_t MEMBERS_40_LEADERS_5 = 0x04040404;
-constexpr uint32_t MEMBERS_70_LEADERS_8 = 0x05050505;
-constexpr uint32_t MEMBERS_100_LEADERS_10 = 0x06060606;
-// constexpr uint32_t POINT_OF_DISASTER = ...;
-// constexpr uint32_t TOYS_TWILIGHT = ...;
-// constexpr uint32_t COMMANDER_BLADE = ...;
-// constexpr uint32_t UNION_GUARD = ...;
-// constexpr uint32_t TEAM_POINTS_500 = ...;
-// constexpr uint32_t TEAM_POINTS_1000 = ...;
-// constexpr uint32_t TEAM_POINTS_5000 = ...;
-// constexpr uint32_t TEAM_POINTS_10000 = ...;
-} // namespace TeamRewardMenuItemID
-
-struct MenuItem {
-  enum Flag {
-    // For menu items to be visible on DC NTE, they must not have either of the
-    // following two flags. (The INVISIBLE_ON_GC_NTE flag behaves similarly.)
-    INVISIBLE_ON_DC_PROTOS = 0x001,
-    INVISIBLE_ON_DC = 0x002,
-    INVISIBLE_ON_PC_NTE = 0x004,
-    INVISIBLE_ON_PC = 0x008,
-    INVISIBLE_ON_GC_NTE = 0x010,
-    INVISIBLE_ON_GC = 0x020,
-    INVISIBLE_ON_XB = 0x040,
-    INVISIBLE_ON_BB = 0x080,
-    DC_ONLY = INVISIBLE_ON_PC | INVISIBLE_ON_GC | INVISIBLE_ON_XB | INVISIBLE_ON_BB,
-    PC_ONLY = INVISIBLE_ON_DC | INVISIBLE_ON_GC | INVISIBLE_ON_XB | INVISIBLE_ON_BB,
-    GC_ONLY = INVISIBLE_ON_DC | INVISIBLE_ON_PC | INVISIBLE_ON_XB | INVISIBLE_ON_BB,
-    XB_ONLY = INVISIBLE_ON_DC | INVISIBLE_ON_PC | INVISIBLE_ON_GC | INVISIBLE_ON_BB,
-    BB_ONLY = INVISIBLE_ON_DC | INVISIBLE_ON_PC | INVISIBLE_ON_GC | INVISIBLE_ON_XB,
-    REQUIRES_MESSAGE_BOXES = 0x100,
-    REQUIRES_SEND_FUNCTION_CALL = 0x200,
-    REQUIRES_SAVE_DISABLED = 0x400,
-    INVISIBLE_IN_INFO_MENU = 0x800,
-  };
-
-  uint32_t item_id;
-  std::string name;
-  std::string description;
-  std::function<std::string()> get_description;
-  uint32_t flags;
-
-  MenuItem(uint32_t item_id, const std::string& name, const std::string& description, uint32_t flags);
-  MenuItem(uint32_t item_id, const std::string& name, std::function<std::string()> get_description, uint32_t flags);
-};
-
-struct Menu {
-  uint32_t menu_id;
-  std::string name;
-  std::vector<MenuItem> items;
-
-  Menu() = delete;
-  Menu(uint32_t menu_id, const std::string& name);
-};
+#pragma once
+
+#include <stdint.h>
+
+#include <functional>
+#include <string>
+#include <vector>
+
+// Note: These aren't enums because neither enum nor enum class does what we
+// want. Specifically, we need GO_BACK to be valid in multiple enums (and enums
+// aren't namespaced unless they're enum classes), so we can't use enums. But we
+// also want to be able to use non-enum values in switch statements without
+// casting values all over the place, so we can't use enum classes either.
+
+namespace MenuID {
+constexpr uint32_t MAIN = 0x11000011;
+constexpr uint32_t CLEAR_LICENSE_CONFIRMATION = 0x11111111;
+constexpr uint32_t INFORMATION = 0x22000022;
+constexpr uint32_t LOBBY = 0x33000033;
+constexpr uint32_t GAME = 0x44000044;
+constexpr uint32_t QUEST_EP1 = 0x55010155;
+constexpr uint32_t QUEST_EP2 = 0x55020255;
+// See the decsription of the A2 command in CommandFormats.hh for why these
+// menu IDs don't fit the rest of the pattern.
+constexpr uint32_t QUEST_CATEGORIES_EP1 = 0x01000001;
+constexpr uint32_t QUEST_CATEGORIES_EP2 = 0x02000002;
+constexpr uint32_t PROXY_DESTINATIONS = 0x77000077;
+constexpr uint32_t PROGRAMS = 0x88000088;
+constexpr uint32_t PATCHES = 0x99000099;
+constexpr uint32_t PATCH_SWITCHES = 0x99010199;
+constexpr uint32_t PROXY_OPTIONS = 0xAA0000AA;
+constexpr uint32_t TOURNAMENTS = 0xBB0000BB;
+constexpr uint32_t TOURNAMENTS_FOR_SPEC = 0xBB1111BB;
+constexpr uint32_t TOURNAMENT_ENTRIES = 0xCC0000CC;
+} // namespace MenuID
+
+namespace MainMenuItemID {
+constexpr uint32_t GO_TO_LOBBY = 0x11222211;
+constexpr uint32_t INFORMATION = 0x11333311;
+constexpr uint32_t DOWNLOAD_QUESTS = 0x11444411;
+constexpr uint32_t PROXY_DESTINATIONS = 0x11555511;
+constexpr uint32_t PATCHES = 0x11666611;
+constexpr uint32_t PATCH_SWITCHES = 0x11676711;
+constexpr uint32_t PROGRAMS = 0x11777711;
+constexpr uint32_t DISCONNECT = 0x11888811;
+constexpr uint32_t CLEAR_LICENSE = 0x11999911;
+} // namespace MainMenuItemID
+
+namespace ClearLicenseConfirmationMenuItemID {
+constexpr uint32_t CANCEL = 0x01010101;
+constexpr uint32_t CLEAR_LICENSE = 0x02020202;
+} // namespace ClearLicenseConfirmationMenuItemID
+
+namespace InformationMenuItemID {
+constexpr uint32_t GO_BACK = 0x22FFFF22;
+}
+
+namespace ProxyDestinationsMenuItemID {
+constexpr uint32_t GO_BACK = 0x77FFFF77;
+constexpr uint32_t OPTIONS = 0x77EEEE77;
+} // namespace ProxyDestinationsMenuItemID
+
+namespace ProgramsMenuItemID {
+constexpr uint32_t GO_BACK = 0x88FFFF88;
+}
+
+namespace PatchesMenuItemID {
+constexpr uint32_t GO_BACK = 0x99FFFF99;
+}
+
+namespace ProxyOptionsMenuItemID {
+constexpr uint32_t GO_BACK = 0xAAFFFFAA;
+constexpr uint32_t CHAT_COMMANDS = 0xAA0101AA;
+constexpr uint32_t PLAYER_NOTIFICATIONS = 0xAA0202AA;
+constexpr uint32_t DROP_NOTIFICATIONS = 0xAA0303AA;
+constexpr uint32_t BLOCK_PINGS = 0xAA0404AA;
+constexpr uint32_t INFINITE_HP = 0xAA0505AA;
+constexpr uint32_t INFINITE_TP = 0xAA0606AA;
+constexpr uint32_t SWITCH_ASSIST = 0xAA0707AA;
+constexpr uint32_t BLOCK_EVENTS = 0xAA0808AA;
+constexpr uint32_t BLOCK_PATCHES = 0xAA0909AA;
+constexpr uint32_t SAVE_FILES = 0xAA0A0AAA;
+constexpr uint32_t VIRTUAL_CLIENT = 0xAA0B0BAA;
+constexpr uint32_t RED_NAME = 0xAA0C0CAA;
+constexpr uint32_t BLANK_NAME = 0xAA0D0DAA;
+constexpr uint32_t SUPPRESS_LOGIN = 0xAA0E0EAA;
+constexpr uint32_t SKIP_CARD = 0xAA0F0FAA;
+constexpr uint32_t EP3_INFINITE_MESETA = 0xAA1010AA;
+constexpr uint32_t EP3_INFINITE_TIME = 0xAA1111AA;
+constexpr uint32_t EP3_UNMASK_WHISPERS = 0xAA1212AA;
+} // namespace ProxyOptionsMenuItemID
+
+namespace TeamRewardMenuItemID {
+constexpr uint32_t TEAM_FLAG = 0x01010101;
+constexpr uint32_t DRESSING_ROOM = 0x02020202;
+constexpr uint32_t MEMBERS_20_LEADERS_3 = 0x03030303;
+constexpr uint32_t MEMBERS_40_LEADERS_5 = 0x04040404;
+constexpr uint32_t MEMBERS_70_LEADERS_8 = 0x05050505;
+constexpr uint32_t MEMBERS_100_LEADERS_10 = 0x06060606;
+// constexpr uint32_t POINT_OF_DISASTER = ...;
+// constexpr uint32_t TOYS_TWILIGHT = ...;
+// constexpr uint32_t COMMANDER_BLADE = ...;
+// constexpr uint32_t UNION_GUARD = ...;
+// constexpr uint32_t TEAM_POINTS_500 = ...;
+// constexpr uint32_t TEAM_POINTS_1000 = ...;
+// constexpr uint32_t TEAM_POINTS_5000 = ...;
+// constexpr uint32_t TEAM_POINTS_10000 = ...;
+} // namespace TeamRewardMenuItemID
+
+struct MenuItem {
+  enum Flag {
+    // For menu items to be visible on DC NTE, they must not have either of the
+    // following two flags. (The INVISIBLE_ON_GC_NTE flag behaves similarly.)
+    INVISIBLE_ON_DC_PROTOS = 0x001,
+    INVISIBLE_ON_DC = 0x002,
+    INVISIBLE_ON_PC_NTE = 0x004,
+    INVISIBLE_ON_PC = 0x008,
+    INVISIBLE_ON_GC_NTE = 0x010,
+    INVISIBLE_ON_GC = 0x020,
+    INVISIBLE_ON_XB = 0x040,
+    INVISIBLE_ON_BB = 0x080,
+    DC_ONLY = INVISIBLE_ON_PC | INVISIBLE_ON_GC | INVISIBLE_ON_XB | INVISIBLE_ON_BB,
+    PC_ONLY = INVISIBLE_ON_DC | INVISIBLE_ON_GC | INVISIBLE_ON_XB | INVISIBLE_ON_BB,
+    GC_ONLY = INVISIBLE_ON_DC | INVISIBLE_ON_PC | INVISIBLE_ON_XB | INVISIBLE_ON_BB,
+    XB_ONLY = INVISIBLE_ON_DC | INVISIBLE_ON_PC | INVISIBLE_ON_GC | INVISIBLE_ON_BB,
+    BB_ONLY = INVISIBLE_ON_DC | INVISIBLE_ON_PC | INVISIBLE_ON_GC | INVISIBLE_ON_XB,
+    REQUIRES_MESSAGE_BOXES = 0x100,
+    REQUIRES_SEND_FUNCTION_CALL = 0x200,
+    REQUIRES_SAVE_DISABLED = 0x400,
+    INVISIBLE_IN_INFO_MENU = 0x800,
+  };
+
+  uint32_t item_id;
+  std::string name;
+  std::string description;
+  std::function<std::string()> get_description;
+  uint32_t flags;
+
+  MenuItem(uint32_t item_id, const std::string& name, const std::string& description, uint32_t flags);
+  MenuItem(uint32_t item_id, const std::string& name, std::function<std::string()> get_description, uint32_t flags);
+};
+
+struct Menu {
+  uint32_t menu_id;
+  std::string name;
+  std::vector<MenuItem> items;
+
+  Menu() = delete;
+  Menu(uint32_t menu_id, const std::string& name);
+};

src/NetworkAddresses.cc

@@ -1,104 +1,104 @@
-#include "NetworkAddresses.hh"
-
-#include <arpa/inet.h>
-#include <errno.h>
-#include <ifaddrs.h>
-#include <netdb.h>
-#include <netinet/in.h>
-#include <sys/socket.h>
-#include <sys/types.h>
-
-#include <memory>
-#include <phosg/Encoding.hh>
-#include <phosg/Network.hh>
-#include <phosg/Strings.hh>
-#include <stdexcept>
-
-using namespace std;
-
-uint32_t resolve_address(const char* address) {
-  struct addrinfo* res0;
-  if (getaddrinfo(address, nullptr, nullptr, &res0)) {
-    auto e = string_for_error(errno);
-    throw runtime_error(string_printf(
-        "can\'t resolve hostname %s: %s", address, e.c_str()));
-  }
-
-  std::unique_ptr<struct addrinfo, void (*)(struct addrinfo*)> res0_unique(res0, freeaddrinfo);
-  struct addrinfo* res4 = nullptr;
-  for (struct addrinfo* res = res0; res; res = res->ai_next) {
-    if (res->ai_family == AF_INET) {
-      res4 = res;
-    }
-  }
-  if (!res4) {
-    throw runtime_error(string_printf(
-        "can\'t resolve hostname %s: no usable data", address));
-  }
-
-  struct sockaddr_in* res_sin = (struct sockaddr_in*)res4->ai_addr;
-  return ntohl(res_sin->sin_addr.s_addr);
-}
-
-map<string, uint32_t> get_local_addresses() {
-  struct ifaddrs* ifa_raw;
-  if (getifaddrs(&ifa_raw)) {
-    auto s = string_for_error(errno);
-    throw runtime_error(string_printf("failed to get interface addresses: %s", s.c_str()));
-  }
-
-  unique_ptr<struct ifaddrs, void (*)(struct ifaddrs*)> ifa(ifa_raw, freeifaddrs);
-
-  map<string, uint32_t> ret;
-  for (struct ifaddrs* i = ifa.get(); i; i = i->ifa_next) {
-    if (!i->ifa_addr) {
-      continue;
-    }
-
-    auto* sin = reinterpret_cast<sockaddr_in*>(i->ifa_addr);
-    if (sin->sin_family != AF_INET) {
-      continue;
-    }
-
-    ret.emplace(i->ifa_name, ntohl(sin->sin_addr.s_addr));
-  }
-
-  return ret;
-}
-
-bool is_local_address(uint32_t addr) {
-  uint8_t net = (addr >> 24) & 0xFF;
-  return ((net == 127) || (net == 172) || (net == 10) || (net == 192));
-}
-
-bool is_local_address(const sockaddr_storage& daddr) {
-  if (daddr.ss_family != AF_INET) {
-    return false;
-  }
-  const sockaddr_in* sin = reinterpret_cast<const sockaddr_in*>(&daddr);
-  return is_local_address(ntohl(sin->sin_addr.s_addr));
-}
-
-string string_for_address(uint32_t address) {
-  return string_printf("%hhu.%hhu.%hhu.%hhu",
-      static_cast<uint8_t>(address >> 24), static_cast<uint8_t>(address >> 16),
-      static_cast<uint8_t>(address >> 8), static_cast<uint8_t>(address));
-}
-
-uint32_t address_for_string(const char* address) {
-  return ntohl(inet_addr(address));
-}
-
-uint64_t devolution_phone_number_for_netloc(uint32_t addr, uint16_t port) {
-  // It seems the address part of the number is fixed-width, but the port is
-  // not. Why did they do it this way?
-  if (port & 0xF000) {
-    return (static_cast<uint64_t>(addr) << 16) | port;
-  } else if (port & 0x0F00) {
-    return (static_cast<uint64_t>(addr) << 12) | port;
-  } else if (port & 0x00F0) {
-    return (static_cast<uint64_t>(addr) << 8) | port;
-  } else {
-    return (static_cast<uint64_t>(addr) << 4) | port;
-  }
-}
+#include "NetworkAddresses.hh"
+
+#include <arpa/inet.h>
+#include <errno.h>
+#include <ifaddrs.h>
+#include <netdb.h>
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+
+#include <memory>
+#include <phosg/Encoding.hh>
+#include <phosg/Network.hh>
+#include <phosg/Strings.hh>
+#include <stdexcept>
+
+using namespace std;
+
+uint32_t resolve_address(const char* address) {
+  struct addrinfo* res0;
+  if (getaddrinfo(address, nullptr, nullptr, &res0)) {
+    auto e = string_for_error(errno);
+    throw runtime_error(string_printf(
+        "can\'t resolve hostname %s: %s", address, e.c_str()));
+  }
+
+  std::unique_ptr<struct addrinfo, void (*)(struct addrinfo*)> res0_unique(res0, freeaddrinfo);
+  struct addrinfo* res4 = nullptr;
+  for (struct addrinfo* res = res0; res; res = res->ai_next) {
+    if (res->ai_family == AF_INET) {
+      res4 = res;
+    }
+  }
+  if (!res4) {
+    throw runtime_error(string_printf(
+        "can\'t resolve hostname %s: no usable data", address));
+  }
+
+  struct sockaddr_in* res_sin = (struct sockaddr_in*)res4->ai_addr;
+  return ntohl(res_sin->sin_addr.s_addr);
+}
+
+map<string, uint32_t> get_local_addresses() {
+  struct ifaddrs* ifa_raw;
+  if (getifaddrs(&ifa_raw)) {
+    auto s = string_for_error(errno);
+    throw runtime_error(string_printf("failed to get interface addresses: %s", s.c_str()));
+  }
+
+  unique_ptr<struct ifaddrs, void (*)(struct ifaddrs*)> ifa(ifa_raw, freeifaddrs);
+
+  map<string, uint32_t> ret;
+  for (struct ifaddrs* i = ifa.get(); i; i = i->ifa_next) {
+    if (!i->ifa_addr) {
+      continue;
+    }
+
+    auto* sin = reinterpret_cast<sockaddr_in*>(i->ifa_addr);
+    if (sin->sin_family != AF_INET) {
+      continue;
+    }
+
+    ret.emplace(i->ifa_name, ntohl(sin->sin_addr.s_addr));
+  }
+
+  return ret;
+}
+
+bool is_local_address(uint32_t addr) {
+  uint8_t net = (addr >> 24) & 0xFF;
+  return ((net == 127) || (net == 172) || (net == 10) || (net == 192));
+}
+
+bool is_local_address(const sockaddr_storage& daddr) {
+  if (daddr.ss_family != AF_INET) {
+    return false;
+  }
+  const sockaddr_in* sin = reinterpret_cast<const sockaddr_in*>(&daddr);
+  return is_local_address(ntohl(sin->sin_addr.s_addr));
+}
+
+string string_for_address(uint32_t address) {
+  return string_printf("%hhu.%hhu.%hhu.%hhu",
+      static_cast<uint8_t>(address >> 24), static_cast<uint8_t>(address >> 16),
+      static_cast<uint8_t>(address >> 8), static_cast<uint8_t>(address));
+}
+
+uint32_t address_for_string(const char* address) {
+  return ntohl(inet_addr(address));
+}
+
+uint64_t devolution_phone_number_for_netloc(uint32_t addr, uint16_t port) {
+  // It seems the address part of the number is fixed-width, but the port is
+  // not. Why did they do it this way?
+  if (port & 0xF000) {
+    return (static_cast<uint64_t>(addr) << 16) | port;
+  } else if (port & 0x0F00) {
+    return (static_cast<uint64_t>(addr) << 12) | port;
+  } else if (port & 0x00F0) {
+    return (static_cast<uint64_t>(addr) << 8) | port;
+  } else {
+    return (static_cast<uint64_t>(addr) << 4) | port;
+  }
+}

src/NetworkAddresses.hh

@@ -1,21 +1,21 @@
-#pragma once
-
-#include <netinet/in.h>
-#include <stdint.h>
-
-#include <map>
-#include <string>
-
-// PSO is IPv4-only, so we just treat addresses as uint32_t everywhere because
-// it's easier
-
-uint32_t resolve_address(const char* address);
-std::map<std::string, uint32_t> get_local_addresses();
-uint32_t get_connected_address(int fd);
-bool is_local_address(uint32_t daddr);
-bool is_local_address(const sockaddr_storage& daddr);
-
-std::string string_for_address(uint32_t address);
-uint32_t address_for_string(const char* address);
-
-uint64_t devolution_phone_number_for_netloc(uint32_t addr, uint16_t port);
+#pragma once
+
+#include <netinet/in.h>
+#include <stdint.h>
+
+#include <map>
+#include <string>
+
+// PSO is IPv4-only, so we just treat addresses as uint32_t everywhere because
+// it's easier
+
+uint32_t resolve_address(const char* address);
+std::map<std::string, uint32_t> get_local_addresses();
+uint32_t get_connected_address(int fd);
+bool is_local_address(uint32_t daddr);
+bool is_local_address(const sockaddr_storage& daddr);
+
+std::string string_for_address(uint32_t address);
+uint32_t address_for_string(const char* address);
+
+uint64_t devolution_phone_number_for_netloc(uint32_t addr, uint16_t port);

src/PSOEncryption.hh

@@ -1,359 +1,359 @@
-#pragma once
-
-#include <inttypes.h>
-#include <stddef.h>
-
-#include <memory>
-#include <phosg/Encoding.hh>
-#include <phosg/Random.hh>
-#include <stdexcept>
-#include <string>
-#include <vector>
-
-#include "Compression.hh"
-#include "Text.hh"
-
-class PSOEncryption {
-public:
-  enum class Type {
-    V2 = 0,
-    V3,
-    BB,
-    JSD0,
-  };
-
-  virtual ~PSOEncryption() = default;
-
-  virtual void encrypt(void* data, size_t size, bool advance = true) = 0;
-  virtual void decrypt(void* data, size_t size, bool advance = true);
-
-  inline void encrypt(std::string& data, bool advance = true) {
-    this->encrypt(data.data(), data.size(), advance);
-  }
-  inline void decrypt(std::string& data, bool advance = true) {
-    this->decrypt(data.data(), data.size(), advance);
-  }
-
-  virtual Type type() const = 0;
-
-protected:
-  PSOEncryption() = default;
-};
-
-class PSOLFGEncryption : public PSOEncryption {
-public:
-  virtual void encrypt(void* data, size_t size, bool advance = true);
-  void encrypt_big_endian(void* data, size_t size, bool advance = true);
-  void encrypt_minus(void* data, size_t size, bool advance = true);
-  void encrypt_big_endian_minus(void* data, size_t size, bool advance = true);
-  void encrypt_both_endian(void* le_data, void* be_data, size_t size, bool advance = true);
-
-  template <bool IsBigEndian>
-  void encrypt_t(void* data, size_t size, bool advance = true);
-  template <bool IsBigEndian>
-  void encrypt_minus_t(void* data, size_t size, bool advance = true);
-
-  uint32_t next(bool advance = true);
-
-  inline uint32_t seed() const {
-    return this->initial_seed;
-  }
-  uint32_t absolute_offset() const {
-    return (this->cycles * this->end_offset) + this->offset;
-  }
-
-protected:
-  PSOLFGEncryption(uint32_t seed, size_t stream_length, size_t end_offset);
-
-  virtual void update_stream() = 0;
-
-  std::vector<uint32_t> stream;
-  size_t offset;
-  size_t end_offset;
-  uint32_t initial_seed;
-  size_t cycles;
-};
-
-class PSOV2Encryption : public PSOLFGEncryption {
-public:
-  explicit PSOV2Encryption(uint32_t seed);
-  virtual Type type() const;
-
-protected:
-  virtual void update_stream();
-
-  static constexpr size_t STREAM_LENGTH = 0x38;
-};
-
-class PSOV3Encryption : public PSOLFGEncryption {
-public:
-  explicit PSOV3Encryption(uint32_t key);
-  virtual Type type() const;
-
-protected:
-  virtual void update_stream();
-
-  static constexpr size_t STREAM_LENGTH = 521;
-};
-
-class PSOBBEncryption : public PSOEncryption {
-public:
-  enum Subtype : uint8_t {
-    STANDARD = 0x00,
-    MOCB1 = 0x01,
-    JSD1 = 0x02,
-    TFS1 = 0x03,
-  };
-
-  struct KeyFile {
-    // initial_keys are actually a stream of uint32_ts, but we treat them as
-    // bytes for code simplicity
-    union InitialKeys {
-      uint8_t jsd1_stream_offset;
-      parray<uint8_t, 0x48> as8;
-      parray<le_uint32_t, 0x12> as32;
-      InitialKeys() : as32() {}
-      InitialKeys(const InitialKeys& other) : as32(other.as32) {}
-    } __packed_ws__(InitialKeys, 0x48);
-    union PrivateKeys {
-      parray<uint8_t, 0x1000> as8;
-      parray<le_uint32_t, 0x400> as32;
-      PrivateKeys() : as32() {}
-      PrivateKeys(const PrivateKeys& other) : as32(other.as32) {}
-    } __packed_ws__(PrivateKeys, 0x1000);
-    InitialKeys initial_keys;
-    PrivateKeys private_keys;
-    // This field only really needs to be one byte, but annoyingly, some
-    // compilers pad this structure to a longer alignment, presumably because
-    // the unions above contain structures with 32-bit alignment. To prevent
-    // this structure's size from not matching the .nsk files' sizes, we use
-    // an unnecessarily large size for this field.
-    le_uint64_t subtype;
-  } __packed_ws__(KeyFile, 0x1050);
-
-  PSOBBEncryption(const KeyFile& key, const void* seed, size_t seed_size);
-
-  virtual void encrypt(void* data, size_t size, bool advance = true);
-  virtual void decrypt(void* data, size_t size, bool advance = true);
-
-  virtual Type type() const;
-
-protected:
-  KeyFile state;
-
-  void tfs1_scramble(uint32_t* out1, uint32_t* out2) const;
-  void apply_seed(const void* original_seed, size_t seed_size);
-};
-
-// The following classes provide support for automatically detecting which type
-// of encryption a client is using based on their initial response to the server
-
-class PSOV2OrV3DetectorEncryption : public PSOEncryption {
-public:
-  PSOV2OrV3DetectorEncryption(
-      uint32_t key,
-      const std::unordered_set<uint32_t>& v2_matches,
-      const std::unordered_set<uint32_t>& v3_matches);
-
-  virtual void encrypt(void* data, size_t size, bool advance = true);
-
-  virtual Type type() const;
-
-protected:
-  uint32_t key;
-  const std::unordered_set<uint32_t>& v2_matches;
-  const std::unordered_set<uint32_t>& v3_matches;
-  std::unique_ptr<PSOEncryption> active_crypt;
-};
-
-class PSOV2OrV3ImitatorEncryption : public PSOEncryption {
-public:
-  PSOV2OrV3ImitatorEncryption(
-      uint32_t key, std::shared_ptr<PSOV2OrV3DetectorEncryption> client_crypt);
-
-  virtual void encrypt(void* data, size_t size, bool advance = true);
-
-  virtual Type type() const;
-
-protected:
-  uint32_t key;
-  std::shared_ptr<const PSOV2OrV3DetectorEncryption> detector_crypt;
-  std::shared_ptr<PSOEncryption> active_crypt;
-};
-
-// The following classes provide support for multiple PSOBB private keys, and
-// the ability to automatically detect which key the client is using based on
-// the first 8 bytes they send
-
-class PSOBBMultiKeyDetectorEncryption : public PSOEncryption {
-public:
-  PSOBBMultiKeyDetectorEncryption(
-      const std::vector<std::shared_ptr<const PSOBBEncryption::KeyFile>>& possible_keys,
-      const std::unordered_set<std::string>& expected_first_data,
-      const void* seed,
-      size_t seed_size);
-
-  virtual void encrypt(void* data, size_t size, bool advance = true);
-  virtual void decrypt(void* data, size_t size, bool advance = true);
-
-  inline std::shared_ptr<const PSOBBEncryption::KeyFile> get_active_key() const {
-    return this->active_key;
-  }
-  inline const std::string& get_seed() const {
-    return this->seed;
-  }
-
-  virtual Type type() const;
-
-protected:
-  std::vector<std::shared_ptr<const PSOBBEncryption::KeyFile>> possible_keys;
-  std::shared_ptr<const PSOBBEncryption::KeyFile> active_key;
-  std::shared_ptr<PSOBBEncryption> active_crypt;
-  const std::unordered_set<std::string>& expected_first_data;
-  std::string seed;
-};
-
-class PSOBBMultiKeyImitatorEncryption : public PSOEncryption {
-public:
-  PSOBBMultiKeyImitatorEncryption(
-      std::shared_ptr<const PSOBBMultiKeyDetectorEncryption> client_crypt,
-      const void* seed,
-      size_t seed_size,
-      bool jsd1_use_detector_seed);
-
-  virtual void encrypt(void* data, size_t size, bool advance = true);
-  virtual void decrypt(void* data, size_t size, bool advance = true);
-
-  virtual Type type() const;
-
-protected:
-  std::shared_ptr<PSOBBEncryption> ensure_crypt();
-
-  std::shared_ptr<const PSOBBMultiKeyDetectorEncryption> detector_crypt;
-  std::shared_ptr<PSOBBEncryption> active_crypt;
-  std::string seed;
-  bool jsd1_use_detector_seed;
-};
-
-class JSD0Encryption : public PSOEncryption {
-public:
-  JSD0Encryption(const void* seed, size_t seed_size);
-
-  virtual void encrypt(void* data, size_t size, bool advance = true);
-  virtual void decrypt(void* data, size_t size, bool advance = true);
-
-  virtual Type type() const = 0;
-
-private:
-  uint8_t key;
-};
-
-void decrypt_trivial_gci_data(void* data, size_t size, uint8_t basis);
-
-uint32_t encrypt_challenge_time(uint16_t value);
-uint16_t decrypt_challenge_time(uint32_t value);
-
-template <bool IsBigEndian>
-class ChallengeTimeT {
-private:
-  using U32T = typename std::conditional<IsBigEndian, be_uint32_t, le_uint32_t>::type;
-  U32T value;
-
-public:
-  ChallengeTimeT() = default;
-  ChallengeTimeT(uint16_t v) {
-    this->encode(v);
-  }
-  ChallengeTimeT(const ChallengeTimeT& other) = default;
-  ChallengeTimeT(ChallengeTimeT&& other) = default;
-  ChallengeTimeT& operator=(const ChallengeTimeT& other) = default;
-  ChallengeTimeT& operator=(ChallengeTimeT&& other) = default;
-
-  bool has_value() const {
-    return this->value != 0;
-  }
-
-  uint32_t load_raw() const {
-    return this->value;
-  }
-  void store_raw(uint32_t value) {
-    this->value = value;
-  }
-
-  uint16_t decode() const {
-    return decrypt_challenge_time(this->value);
-  }
-  void encode(uint16_t v) {
-    this->value = ((v == 0) || (v == 0xFFFF)) ? 0 : encrypt_challenge_time(v);
-  }
-
-  operator ChallengeTimeT<!IsBigEndian>() const {
-    ChallengeTimeT<!IsBigEndian> ret;
-    ret.store_raw(this->value);
-    return ret;
-  }
-} __packed__;
-using ChallengeTime = ChallengeTimeT<false>;
-using ChallengeTimeBE = ChallengeTimeT<true>;
-check_struct_size(ChallengeTime, 4);
-check_struct_size(ChallengeTimeBE, 4);
-
-std::string decrypt_v2_registry_value(const void* data, size_t size);
-
-struct DecryptedPR2 {
-  std::string compressed_data;
-  size_t decompressed_size;
-};
-
-template <bool IsBigEndian>
-DecryptedPR2 decrypt_pr2_data(const std::string& data) {
-  using U32T = std::conditional_t<IsBigEndian, be_uint32_t, le_uint32_t>;
-
-  if (data.size() < 8) {
-    throw std::runtime_error("not enough data for PR2 header");
-  }
-  StringReader r(data);
-  DecryptedPR2 ret = {
-      .compressed_data = data.substr(8),
-      .decompressed_size = r.get<U32T>()};
-  PSOV2Encryption crypt(r.get<U32T>());
-  if (IsBigEndian) {
-    crypt.encrypt_big_endian(ret.compressed_data.data(), ret.compressed_data.size());
-  } else {
-    crypt.decrypt(ret.compressed_data.data(), ret.compressed_data.size());
-  }
-  return ret;
-}
-
-template <bool IsBigEndian>
-std::string decrypt_and_decompress_pr2_data(const std::string& data) {
-  auto decrypted = decrypt_pr2_data<IsBigEndian>(data);
-  std::string decompressed = prs_decompress(decrypted.compressed_data);
-  if (decompressed.size() != decrypted.decompressed_size) {
-    throw std::runtime_error("decompressed size does not match expected size");
-  }
-  return decompressed;
-}
-
-template <bool IsBigEndian>
-std::string encrypt_pr2_data(const std::string& data, size_t decompressed_size, uint32_t seed) {
-  using U32T = std::conditional_t<IsBigEndian, be_uint32_t, le_uint32_t>;
-
-  StringWriter w;
-  w.put<U32T>(decompressed_size);
-  w.put<U32T>(seed);
-  w.write(data);
-
-  std::string ret = std::move(w.str());
-  PSOV2Encryption crypt(seed);
-  if (IsBigEndian) {
-    crypt.encrypt_big_endian(ret.data() + 8, ret.size() - 8);
-  } else {
-    crypt.decrypt(ret.data() + 8, ret.size() - 8);
-  }
-  return ret;
-}
-
-inline uint32_t random_from_optional_crypt(std::shared_ptr<PSOLFGEncryption> random_crypt) {
-  return random_crypt ? random_crypt->next() : random_object<uint32_t>();
-}
+#pragma once
+
+#include <inttypes.h>
+#include <stddef.h>
+
+#include <memory>
+#include <phosg/Encoding.hh>
+#include <phosg/Random.hh>
+#include <stdexcept>
+#include <string>
+#include <vector>
+
+#include "Compression.hh"
+#include "Text.hh"
+
+class PSOEncryption {
+public:
+  enum class Type {
+    V2 = 0,
+    V3,
+    BB,
+    JSD0,
+  };
+
+  virtual ~PSOEncryption() = default;
+
+  virtual void encrypt(void* data, size_t size, bool advance = true) = 0;
+  virtual void decrypt(void* data, size_t size, bool advance = true);
+
+  inline void encrypt(std::string& data, bool advance = true) {
+    this->encrypt(data.data(), data.size(), advance);
+  }
+  inline void decrypt(std::string& data, bool advance = true) {
+    this->decrypt(data.data(), data.size(), advance);
+  }
+
+  virtual Type type() const = 0;
+
+protected:
+  PSOEncryption() = default;
+};
+
+class PSOLFGEncryption : public PSOEncryption {
+public:
+  virtual void encrypt(void* data, size_t size, bool advance = true);
+  void encrypt_big_endian(void* data, size_t size, bool advance = true);
+  void encrypt_minus(void* data, size_t size, bool advance = true);
+  void encrypt_big_endian_minus(void* data, size_t size, bool advance = true);
+  void encrypt_both_endian(void* le_data, void* be_data, size_t size, bool advance = true);
+
+  template <bool IsBigEndian>
+  void encrypt_t(void* data, size_t size, bool advance = true);
+  template <bool IsBigEndian>
+  void encrypt_minus_t(void* data, size_t size, bool advance = true);
+
+  uint32_t next(bool advance = true);
+
+  inline uint32_t seed() const {
+    return this->initial_seed;
+  }
+  uint32_t absolute_offset() const {
+    return (this->cycles * this->end_offset) + this->offset;
+  }
+
+protected:
+  PSOLFGEncryption(uint32_t seed, size_t stream_length, size_t end_offset);
+
+  virtual void update_stream() = 0;
+
+  std::vector<uint32_t> stream;
+  size_t offset;
+  size_t end_offset;
+  uint32_t initial_seed;
+  size_t cycles;
+};
+
+class PSOV2Encryption : public PSOLFGEncryption {
+public:
+  explicit PSOV2Encryption(uint32_t seed);
+  virtual Type type() const;
+
+protected:
+  virtual void update_stream();
+
+  static constexpr size_t STREAM_LENGTH = 0x38;
+};
+
+class PSOV3Encryption : public PSOLFGEncryption {
+public:
+  explicit PSOV3Encryption(uint32_t key);
+  virtual Type type() const;
+
+protected:
+  virtual void update_stream();
+
+  static constexpr size_t STREAM_LENGTH = 521;
+};
+
+class PSOBBEncryption : public PSOEncryption {
+public:
+  enum Subtype : uint8_t {
+    STANDARD = 0x00,
+    MOCB1 = 0x01,
+    JSD1 = 0x02,
+    TFS1 = 0x03,
+  };
+
+  struct KeyFile {
+    // initial_keys are actually a stream of uint32_ts, but we treat them as
+    // bytes for code simplicity
+    union InitialKeys {
+      uint8_t jsd1_stream_offset;
+      parray<uint8_t, 0x48> as8;
+      parray<le_uint32_t, 0x12> as32;
+      InitialKeys() : as32() {}
+      InitialKeys(const InitialKeys& other) : as32(other.as32) {}
+    } __packed_ws__(InitialKeys, 0x48);
+    union PrivateKeys {
+      parray<uint8_t, 0x1000> as8;
+      parray<le_uint32_t, 0x400> as32;
+      PrivateKeys() : as32() {}
+      PrivateKeys(const PrivateKeys& other) : as32(other.as32) {}
+    } __packed_ws__(PrivateKeys, 0x1000);
+    InitialKeys initial_keys;
+    PrivateKeys private_keys;
+    // This field only really needs to be one byte, but annoyingly, some
+    // compilers pad this structure to a longer alignment, presumably because
+    // the unions above contain structures with 32-bit alignment. To prevent
+    // this structure's size from not matching the .nsk files' sizes, we use
+    // an unnecessarily large size for this field.
+    le_uint64_t subtype;
+  } __packed_ws__(KeyFile, 0x1050);
+
+  PSOBBEncryption(const KeyFile& key, const void* seed, size_t seed_size);
+
+  virtual void encrypt(void* data, size_t size, bool advance = true);
+  virtual void decrypt(void* data, size_t size, bool advance = true);
+
+  virtual Type type() const;
+
+protected:
+  KeyFile state;
+
+  void tfs1_scramble(uint32_t* out1, uint32_t* out2) const;
+  void apply_seed(const void* original_seed, size_t seed_size);
+};
+
+// The following classes provide support for automatically detecting which type
+// of encryption a client is using based on their initial response to the server
+
+class PSOV2OrV3DetectorEncryption : public PSOEncryption {
+public:
+  PSOV2OrV3DetectorEncryption(
+      uint32_t key,
+      const std::unordered_set<uint32_t>& v2_matches,
+      const std::unordered_set<uint32_t>& v3_matches);
+
+  virtual void encrypt(void* data, size_t size, bool advance = true);
+
+  virtual Type type() const;
+
+protected:
+  uint32_t key;
+  const std::unordered_set<uint32_t>& v2_matches;
+  const std::unordered_set<uint32_t>& v3_matches;
+  std::unique_ptr<PSOEncryption> active_crypt;
+};
+
+class PSOV2OrV3ImitatorEncryption : public PSOEncryption {
+public:
+  PSOV2OrV3ImitatorEncryption(
+      uint32_t key, std::shared_ptr<PSOV2OrV3DetectorEncryption> client_crypt);
+
+  virtual void encrypt(void* data, size_t size, bool advance = true);
+
+  virtual Type type() const;
+
+protected:
+  uint32_t key;
+  std::shared_ptr<const PSOV2OrV3DetectorEncryption> detector_crypt;
+  std::shared_ptr<PSOEncryption> active_crypt;
+};
+
+// The following classes provide support for multiple PSOBB private keys, and
+// the ability to automatically detect which key the client is using based on
+// the first 8 bytes they send
+
+class PSOBBMultiKeyDetectorEncryption : public PSOEncryption {
+public:
+  PSOBBMultiKeyDetectorEncryption(
+      const std::vector<std::shared_ptr<const PSOBBEncryption::KeyFile>>& possible_keys,
+      const std::unordered_set<std::string>& expected_first_data,
+      const void* seed,
+      size_t seed_size);
+
+  virtual void encrypt(void* data, size_t size, bool advance = true);
+  virtual void decrypt(void* data, size_t size, bool advance = true);
+
+  inline std::shared_ptr<const PSOBBEncryption::KeyFile> get_active_key() const {
+    return this->active_key;
+  }
+  inline const std::string& get_seed() const {
+    return this->seed;
+  }
+
+  virtual Type type() const;
+
+protected:
+  std::vector<std::shared_ptr<const PSOBBEncryption::KeyFile>> possible_keys;
+  std::shared_ptr<const PSOBBEncryption::KeyFile> active_key;
+  std::shared_ptr<PSOBBEncryption> active_crypt;
+  const std::unordered_set<std::string>& expected_first_data;
+  std::string seed;
+};
+
+class PSOBBMultiKeyImitatorEncryption : public PSOEncryption {
+public:
+  PSOBBMultiKeyImitatorEncryption(
+      std::shared_ptr<const PSOBBMultiKeyDetectorEncryption> client_crypt,
+      const void* seed,
+      size_t seed_size,
+      bool jsd1_use_detector_seed);
+
+  virtual void encrypt(void* data, size_t size, bool advance = true);
+  virtual void decrypt(void* data, size_t size, bool advance = true);
+
+  virtual Type type() const;
+
+protected:
+  std::shared_ptr<PSOBBEncryption> ensure_crypt();
+
+  std::shared_ptr<const PSOBBMultiKeyDetectorEncryption> detector_crypt;
+  std::shared_ptr<PSOBBEncryption> active_crypt;
+  std::string seed;
+  bool jsd1_use_detector_seed;
+};
+
+class JSD0Encryption : public PSOEncryption {
+public:
+  JSD0Encryption(const void* seed, size_t seed_size);
+
+  virtual void encrypt(void* data, size_t size, bool advance = true);
+  virtual void decrypt(void* data, size_t size, bool advance = true);
+
+  virtual Type type() const = 0;
+
+private:
+  uint8_t key;
+};
+
+void decrypt_trivial_gci_data(void* data, size_t size, uint8_t basis);
+
+uint32_t encrypt_challenge_time(uint16_t value);
+uint16_t decrypt_challenge_time(uint32_t value);
+
+template <bool IsBigEndian>
+class ChallengeTimeT {
+private:
+  using U32T = typename std::conditional<IsBigEndian, be_uint32_t, le_uint32_t>::type;
+  U32T value;
+
+public:
+  ChallengeTimeT() = default;
+  ChallengeTimeT(uint16_t v) {
+    this->encode(v);
+  }
+  ChallengeTimeT(const ChallengeTimeT& other) = default;
+  ChallengeTimeT(ChallengeTimeT&& other) = default;
+  ChallengeTimeT& operator=(const ChallengeTimeT& other) = default;
+  ChallengeTimeT& operator=(ChallengeTimeT&& other) = default;
+
+  bool has_value() const {
+    return this->value != 0;
+  }
+
+  uint32_t load_raw() const {
+    return this->value;
+  }
+  void store_raw(uint32_t value) {
+    this->value = value;
+  }
+
+  uint16_t decode() const {
+    return decrypt_challenge_time(this->value);
+  }
+  void encode(uint16_t v) {
+    this->value = ((v == 0) || (v == 0xFFFF)) ? 0 : encrypt_challenge_time(v);
+  }
+
+  operator ChallengeTimeT<!IsBigEndian>() const {
+    ChallengeTimeT<!IsBigEndian> ret;
+    ret.store_raw(this->value);
+    return ret;
+  }
+} __packed__;
+using ChallengeTime = ChallengeTimeT<false>;
+using ChallengeTimeBE = ChallengeTimeT<true>;
+check_struct_size(ChallengeTime, 4);
+check_struct_size(ChallengeTimeBE, 4);
+
+std::string decrypt_v2_registry_value(const void* data, size_t size);
+
+struct DecryptedPR2 {
+  std::string compressed_data;
+  size_t decompressed_size;
+};
+
+template <bool IsBigEndian>
+DecryptedPR2 decrypt_pr2_data(const std::string& data) {
+  using U32T = std::conditional_t<IsBigEndian, be_uint32_t, le_uint32_t>;
+
+  if (data.size() < 8) {
+    throw std::runtime_error("not enough data for PR2 header");
+  }
+  StringReader r(data);
+  DecryptedPR2 ret = {
+      .compressed_data = data.substr(8),
+      .decompressed_size = r.get<U32T>()};
+  PSOV2Encryption crypt(r.get<U32T>());
+  if (IsBigEndian) {
+    crypt.encrypt_big_endian(ret.compressed_data.data(), ret.compressed_data.size());
+  } else {
+    crypt.decrypt(ret.compressed_data.data(), ret.compressed_data.size());
+  }
+  return ret;
+}
+
+template <bool IsBigEndian>
+std::string decrypt_and_decompress_pr2_data(const std::string& data) {
+  auto decrypted = decrypt_pr2_data<IsBigEndian>(data);
+  std::string decompressed = prs_decompress(decrypted.compressed_data);
+  if (decompressed.size() != decrypted.decompressed_size) {
+    throw std::runtime_error("decompressed size does not match expected size");
+  }
+  return decompressed;
+}
+
+template <bool IsBigEndian>
+std::string encrypt_pr2_data(const std::string& data, size_t decompressed_size, uint32_t seed) {
+  using U32T = std::conditional_t<IsBigEndian, be_uint32_t, le_uint32_t>;
+
+  StringWriter w;
+  w.put<U32T>(decompressed_size);
+  w.put<U32T>(seed);
+  w.write(data);
+
+  std::string ret = std::move(w.str());
+  PSOV2Encryption crypt(seed);
+  if (IsBigEndian) {
+    crypt.encrypt_big_endian(ret.data() + 8, ret.size() - 8);
+  } else {
+    crypt.decrypt(ret.data() + 8, ret.size() - 8);
+  }
+  return ret;
+}
+
+inline uint32_t random_from_optional_crypt(std::shared_ptr<PSOLFGEncryption> random_crypt) {
+  return random_crypt ? random_crypt->next() : random_object<uint32_t>();
+}

src/PSOProtocol.cc

@@ -1,270 +1,270 @@
-#include "PSOProtocol.hh"
-
-#include <event2/buffer.h>
-
-#include <phosg/Strings.hh>
-#include <stdexcept>
-
-#include "Text.hh"
-
-using namespace std;
-
-extern bool use_terminal_colors;
-
-PSOCommandHeader::PSOCommandHeader() {
-  this->bb.size = 0;
-  this->bb.command = 0;
-  this->bb.flag = 0;
-}
-
-uint16_t PSOCommandHeader::command(Version version) const {
-  switch (version) {
-    case Version::PC_PATCH:
-    case Version::BB_PATCH:
-    case Version::PC_NTE:
-    case Version::PC_V2:
-      return this->pc.command;
-    case Version::DC_NTE:
-    case Version::DC_V1_11_2000_PROTOTYPE:
-    case Version::DC_V1:
-    case Version::DC_V2:
-      return this->dc.command;
-    case Version::GC_NTE:
-    case Version::GC_V3:
-    case Version::GC_EP3_NTE:
-    case Version::GC_EP3:
-      return this->gc.command;
-    case Version::XB_V3:
-      return this->xb.command;
-    case Version::BB_V4:
-      return this->bb.command;
-    default:
-      throw logic_error("unknown game version");
-  }
-}
-
-void PSOCommandHeader::set_command(Version version, uint16_t command) {
-  switch (version) {
-    case Version::PC_PATCH:
-    case Version::BB_PATCH:
-    case Version::PC_NTE:
-    case Version::PC_V2:
-      this->pc.command = command;
-      break;
-    case Version::DC_NTE:
-    case Version::DC_V1_11_2000_PROTOTYPE:
-    case Version::DC_V1:
-    case Version::DC_V2:
-      this->dc.command = command;
-      break;
-    case Version::GC_NTE:
-    case Version::GC_V3:
-    case Version::GC_EP3_NTE:
-    case Version::GC_EP3:
-      this->gc.command = command;
-      break;
-    case Version::XB_V3:
-      this->xb.command = command;
-      break;
-    case Version::BB_V4:
-      this->bb.command = command;
-      break;
-    default:
-      throw logic_error("unknown game version");
-  }
-}
-
-uint16_t PSOCommandHeader::size(Version version) const {
-  switch (version) {
-    case Version::PC_PATCH:
-    case Version::BB_PATCH:
-    case Version::PC_NTE:
-    case Version::PC_V2:
-      return this->pc.size;
-    case Version::DC_NTE:
-    case Version::DC_V1_11_2000_PROTOTYPE:
-    case Version::DC_V1:
-    case Version::DC_V2:
-      return this->dc.size;
-    case Version::GC_NTE:
-    case Version::GC_V3:
-    case Version::GC_EP3_NTE:
-    case Version::GC_EP3:
-      return this->gc.size;
-    case Version::XB_V3:
-      return this->xb.size;
-    case Version::BB_V4:
-      return this->bb.size;
-    default:
-      throw logic_error("unknown game version");
-  }
-}
-
-void PSOCommandHeader::set_size(Version version, uint32_t size) {
-  switch (version) {
-    case Version::PC_PATCH:
-    case Version::BB_PATCH:
-    case Version::PC_NTE:
-    case Version::PC_V2:
-      this->pc.size = size;
-      break;
-    case Version::DC_NTE:
-    case Version::DC_V1_11_2000_PROTOTYPE:
-    case Version::DC_V1:
-    case Version::DC_V2:
-      this->dc.size = size;
-      break;
-    case Version::GC_NTE:
-    case Version::GC_V3:
-    case Version::GC_EP3_NTE:
-    case Version::GC_EP3:
-      this->gc.size = size;
-      break;
-    case Version::XB_V3:
-      this->xb.size = size;
-      break;
-    case Version::BB_V4:
-      this->bb.size = size;
-      break;
-    default:
-      throw logic_error("unknown game version");
-  }
-}
-
-uint32_t PSOCommandHeader::flag(Version version) const {
-  switch (version) {
-    case Version::PC_PATCH:
-    case Version::BB_PATCH:
-    case Version::PC_NTE:
-    case Version::PC_V2:
-      return this->pc.flag;
-    case Version::DC_NTE:
-    case Version::DC_V1_11_2000_PROTOTYPE:
-    case Version::DC_V1:
-    case Version::DC_V2:
-      return this->dc.flag;
-    case Version::GC_NTE:
-    case Version::GC_V3:
-    case Version::GC_EP3_NTE:
-    case Version::GC_EP3:
-      return this->gc.flag;
-    case Version::XB_V3:
-      return this->xb.flag;
-    case Version::BB_V4:
-      return this->bb.flag;
-    default:
-      throw logic_error("unknown game version");
-  }
-}
-
-void PSOCommandHeader::set_flag(Version version, uint32_t flag) {
-  switch (version) {
-    case Version::PC_PATCH:
-    case Version::BB_PATCH:
-    case Version::PC_NTE:
-    case Version::PC_V2:
-      this->pc.flag = flag;
-      break;
-    case Version::DC_NTE:
-    case Version::DC_V1_11_2000_PROTOTYPE:
-    case Version::DC_V1:
-    case Version::DC_V2:
-      this->dc.flag = flag;
-      break;
-    case Version::GC_NTE:
-    case Version::GC_V3:
-    case Version::GC_EP3_NTE:
-    case Version::GC_EP3:
-      this->gc.flag = flag;
-      break;
-    case Version::XB_V3:
-      this->xb.flag = flag;
-      break;
-    case Version::BB_V4:
-      this->bb.flag = flag;
-      break;
-    default:
-      throw logic_error("unknown game version");
-  }
-}
-
-void check_size_v(size_t size, size_t min_size, size_t max_size) {
-  if (size < min_size) {
-    throw std::runtime_error(string_printf(
-        "command too small (expected at least 0x%zX bytes, received 0x%zX bytes)",
-        min_size, size));
-  }
-  if (max_size < min_size) {
-    max_size = min_size;
-  }
-  if (size > max_size) {
-    throw std::runtime_error(string_printf(
-        "command too large (expected at most 0x%zX bytes, received 0x%zX bytes)",
-        max_size, size));
-  }
-}
-
-std::string prepend_command_header(
-    Version version,
-    bool encryption_enabled,
-    uint16_t cmd,
-    uint32_t flag,
-    const std::string& data) {
-  StringWriter ret;
-  switch (version) {
-    case Version::DC_NTE:
-    case Version::DC_V1_11_2000_PROTOTYPE:
-    case Version::DC_V1:
-    case Version::DC_V2:
-    case Version::GC_NTE:
-    case Version::GC_V3:
-    case Version::GC_EP3_NTE:
-    case Version::GC_EP3:
-    case Version::XB_V3: {
-      PSOCommandHeaderDCV3 header;
-      if (encryption_enabled) {
-        header.size = (sizeof(header) + data.size() + 3) & ~3;
-      } else {
-        header.size = (sizeof(header) + data.size());
-      }
-      header.command = cmd;
-      header.flag = flag;
-      ret.put(header);
-      break;
-    }
-
-    case Version::PC_PATCH:
-    case Version::BB_PATCH:
-    case Version::PC_NTE:
-    case Version::PC_V2: {
-      PSOCommandHeaderPC header;
-      if (encryption_enabled) {
-        header.size = (sizeof(header) + data.size() + 3) & ~3;
-      } else {
-        header.size = (sizeof(header) + data.size());
-      }
-      header.command = cmd;
-      header.flag = flag;
-      ret.put(header);
-      break;
-    }
-
-    case Version::BB_V4: {
-      PSOCommandHeaderBB header;
-      if (encryption_enabled) {
-        header.size = (sizeof(header) + data.size() + 3) & ~3;
-      } else {
-        header.size = (sizeof(header) + data.size());
-      }
-      header.command = cmd;
-      header.flag = flag;
-      ret.put(header);
-      break;
-    }
-
-    default:
-      throw logic_error("unimplemented game version in prepend_command_header");
-  }
-  ret.write(data);
-  return std::move(ret.str());
-}
+#include "PSOProtocol.hh"
+
+#include <event2/buffer.h>
+
+#include <phosg/Strings.hh>
+#include <stdexcept>
+
+#include "Text.hh"
+
+using namespace std;
+
+extern bool use_terminal_colors;
+
+PSOCommandHeader::PSOCommandHeader() {
+  this->bb.size = 0;
+  this->bb.command = 0;
+  this->bb.flag = 0;
+}
+
+uint16_t PSOCommandHeader::command(Version version) const {
+  switch (version) {
+    case Version::PC_PATCH:
+    case Version::BB_PATCH:
+    case Version::PC_NTE:
+    case Version::PC_V2:
+      return this->pc.command;
+    case Version::DC_NTE:
+    case Version::DC_V1_11_2000_PROTOTYPE:
+    case Version::DC_V1:
+    case Version::DC_V2:
+      return this->dc.command;
+    case Version::GC_NTE:
+    case Version::GC_V3:
+    case Version::GC_EP3_NTE:
+    case Version::GC_EP3:
+      return this->gc.command;
+    case Version::XB_V3:
+      return this->xb.command;
+    case Version::BB_V4:
+      return this->bb.command;
+    default:
+      throw logic_error("unknown game version");
+  }
+}
+
+void PSOCommandHeader::set_command(Version version, uint16_t command) {
+  switch (version) {
+    case Version::PC_PATCH:
+    case Version::BB_PATCH:
+    case Version::PC_NTE:
+    case Version::PC_V2:
+      this->pc.command = command;
+      break;
+    case Version::DC_NTE:
+    case Version::DC_V1_11_2000_PROTOTYPE:
+    case Version::DC_V1:
+    case Version::DC_V2:
+      this->dc.command = command;
+      break;
+    case Version::GC_NTE:
+    case Version::GC_V3:
+    case Version::GC_EP3_NTE:
+    case Version::GC_EP3:
+      this->gc.command = command;
+      break;
+    case Version::XB_V3:
+      this->xb.command = command;
+      break;
+    case Version::BB_V4:
+      this->bb.command = command;
+      break;
+    default:
+      throw logic_error("unknown game version");
+  }
+}
+
+uint16_t PSOCommandHeader::size(Version version) const {
+  switch (version) {
+    case Version::PC_PATCH:
+    case Version::BB_PATCH:
+    case Version::PC_NTE:
+    case Version::PC_V2:
+      return this->pc.size;
+    case Version::DC_NTE:
+    case Version::DC_V1_11_2000_PROTOTYPE:
+    case Version::DC_V1:
+    case Version::DC_V2:
+      return this->dc.size;
+    case Version::GC_NTE:
+    case Version::GC_V3:
+    case Version::GC_EP3_NTE:
+    case Version::GC_EP3:
+      return this->gc.size;
+    case Version::XB_V3:
+      return this->xb.size;
+    case Version::BB_V4:
+      return this->bb.size;
+    default:
+      throw logic_error("unknown game version");
+  }
+}
+
+void PSOCommandHeader::set_size(Version version, uint32_t size) {
+  switch (version) {
+    case Version::PC_PATCH:
+    case Version::BB_PATCH:
+    case Version::PC_NTE:
+    case Version::PC_V2:
+      this->pc.size = size;
+      break;
+    case Version::DC_NTE:
+    case Version::DC_V1_11_2000_PROTOTYPE:
+    case Version::DC_V1:
+    case Version::DC_V2:
+      this->dc.size = size;
+      break;
+    case Version::GC_NTE:
+    case Version::GC_V3:
+    case Version::GC_EP3_NTE:
+    case Version::GC_EP3:
+      this->gc.size = size;
+      break;
+    case Version::XB_V3:
+      this->xb.size = size;
+      break;
+    case Version::BB_V4:
+      this->bb.size = size;
+      break;
+    default:
+      throw logic_error("unknown game version");
+  }
+}
+
+uint32_t PSOCommandHeader::flag(Version version) const {
+  switch (version) {
+    case Version::PC_PATCH:
+    case Version::BB_PATCH:
+    case Version::PC_NTE:
+    case Version::PC_V2:
+      return this->pc.flag;
+    case Version::DC_NTE:
+    case Version::DC_V1_11_2000_PROTOTYPE:
+    case Version::DC_V1:
+    case Version::DC_V2:
+      return this->dc.flag;
+    case Version::GC_NTE:
+    case Version::GC_V3:
+    case Version::GC_EP3_NTE:
+    case Version::GC_EP3:
+      return this->gc.flag;
+    case Version::XB_V3:
+      return this->xb.flag;
+    case Version::BB_V4:
+      return this->bb.flag;
+    default:
+      throw logic_error("unknown game version");
+  }
+}
+
+void PSOCommandHeader::set_flag(Version version, uint32_t flag) {
+  switch (version) {
+    case Version::PC_PATCH:
+    case Version::BB_PATCH:
+    case Version::PC_NTE:
+    case Version::PC_V2:
+      this->pc.flag = flag;
+      break;
+    case Version::DC_NTE:
+    case Version::DC_V1_11_2000_PROTOTYPE:
+    case Version::DC_V1:
+    case Version::DC_V2:
+      this->dc.flag = flag;
+      break;
+    case Version::GC_NTE:
+    case Version::GC_V3:
+    case Version::GC_EP3_NTE:
+    case Version::GC_EP3:
+      this->gc.flag = flag;
+      break;
+    case Version::XB_V3:
+      this->xb.flag = flag;
+      break;
+    case Version::BB_V4:
+      this->bb.flag = flag;
+      break;
+    default:
+      throw logic_error("unknown game version");
+  }
+}
+
+void check_size_v(size_t size, size_t min_size, size_t max_size) {
+  if (size < min_size) {
+    throw std::runtime_error(string_printf(
+        "command too small (expected at least 0x%zX bytes, received 0x%zX bytes)",
+        min_size, size));
+  }
+  if (max_size < min_size) {
+    max_size = min_size;
+  }
+  if (size > max_size) {
+    throw std::runtime_error(string_printf(
+        "command too large (expected at most 0x%zX bytes, received 0x%zX bytes)",
+        max_size, size));
+  }
+}
+
+std::string prepend_command_header(
+    Version version,
+    bool encryption_enabled,
+    uint16_t cmd,
+    uint32_t flag,
+    const std::string& data) {
+  StringWriter ret;
+  switch (version) {
+    case Version::DC_NTE:
+    case Version::DC_V1_11_2000_PROTOTYPE:
+    case Version::DC_V1:
+    case Version::DC_V2:
+    case Version::GC_NTE:
+    case Version::GC_V3:
+    case Version::GC_EP3_NTE:
+    case Version::GC_EP3:
+    case Version::XB_V3: {
+      PSOCommandHeaderDCV3 header;
+      if (encryption_enabled) {
+        header.size = (sizeof(header) + data.size() + 3) & ~3;
+      } else {
+        header.size = (sizeof(header) + data.size());
+      }
+      header.command = cmd;
+      header.flag = flag;
+      ret.put(header);
+      break;
+    }
+
+    case Version::PC_PATCH:
+    case Version::BB_PATCH:
+    case Version::PC_NTE:
+    case Version::PC_V2: {
+      PSOCommandHeaderPC header;
+      if (encryption_enabled) {
+        header.size = (sizeof(header) + data.size() + 3) & ~3;
+      } else {
+        header.size = (sizeof(header) + data.size());
+      }
+      header.command = cmd;
+      header.flag = flag;
+      ret.put(header);
+      break;
+    }
+
+    case Version::BB_V4: {
+      PSOCommandHeaderBB header;
+      if (encryption_enabled) {
+        header.size = (sizeof(header) + data.size() + 3) & ~3;
+      } else {
+        header.size = (sizeof(header) + data.size());
+      }
+      header.command = cmd;
+      header.flag = flag;
+      ret.put(header);
+      break;
+    }
+
+    default:
+      throw logic_error("unimplemented game version in prepend_command_header");
+  }
+  ret.write(data);
+  return std::move(ret.str());
+}

src/PSOProtocol.hh

@@ -1,130 +1,130 @@
-#pragma once
-
-#include <event2/bufferevent.h>
-#include <inttypes.h>
-
-#include <functional>
-#include <phosg/Strings.hh>
-
-#include "PSOEncryption.hh"
-#include "Version.hh"
-
-struct PSOCommandHeaderPC {
-  le_uint16_t size;
-  uint8_t command;
-  uint8_t flag;
-} __packed_ws__(PSOCommandHeaderPC, 4);
-
-struct PSOCommandHeaderDCV3 {
-  uint8_t command;
-  uint8_t flag;
-  le_uint16_t size;
-} __packed_ws__(PSOCommandHeaderDCV3, 4);
-
-struct PSOCommandHeaderBB {
-  le_uint16_t size;
-  le_uint16_t command;
-  le_uint32_t flag;
-} __packed_ws__(PSOCommandHeaderBB, 8);
-
-union PSOCommandHeader {
-  PSOCommandHeaderDCV3 dc;
-  PSOCommandHeaderPC pc;
-  PSOCommandHeaderDCV3 gc;
-  PSOCommandHeaderDCV3 xb;
-  PSOCommandHeaderBB bb;
-
-  uint16_t command(Version version) const;
-  void set_command(Version version, uint16_t command);
-  uint16_t size(Version version) const;
-  void set_size(Version version, uint32_t size);
-  uint32_t flag(Version version) const;
-  void set_flag(Version version, uint32_t flag);
-  static inline size_t header_size(Version version) {
-    return (version == Version::BB_V4) ? 8 : 4;
-  }
-
-  PSOCommandHeader();
-} __packed_ws__(PSOCommandHeader, 8);
-
-// This function is used in a lot of places to check received command sizes and
-// cast them to the appropriate type
-template <typename RetT, typename PtrT>
-RetT& check_size_generic(
-    PtrT data,
-    size_t size,
-    size_t min_size,
-    size_t max_size) {
-  if (size < min_size) {
-    throw std::runtime_error(string_printf(
-        "command too small (expected at least 0x%zX bytes, received 0x%zX bytes)",
-        min_size, size));
-  }
-  if (size > max_size) {
-    throw std::runtime_error(string_printf(
-        "command too large (expected at most 0x%zX bytes, received 0x%zX bytes)",
-        max_size, size));
-  }
-  return *reinterpret_cast<RetT*>(data);
-}
-
-template <typename T>
-const T& check_size_t(const std::string& data, size_t min_size, size_t max_size) {
-  return check_size_generic<const T, const void*>(data.data(), data.size(), min_size, max_size);
-}
-template <typename T>
-const T& check_size_t(const std::string& data, size_t max_size) {
-  return check_size_generic<const T, const void*>(data.data(), data.size(), sizeof(T), max_size);
-}
-template <typename T>
-const T& check_size_t(const std::string& data) {
-  return check_size_generic<const T, const void*>(data.data(), data.size(), sizeof(T), sizeof(T));
-}
-
-template <typename T>
-T& check_size_t(std::string& data, size_t min_size, size_t max_size) {
-  return check_size_generic<T, void*>(data.data(), data.size(), min_size, max_size);
-}
-template <typename T>
-T& check_size_t(std::string& data, size_t max_size) {
-  return check_size_generic<T, void*>(data.data(), data.size(), sizeof(T), max_size);
-}
-template <typename T>
-T& check_size_t(std::string& data) {
-  return check_size_generic<T, void*>(data.data(), data.size(), sizeof(T), sizeof(T));
-}
-
-template <typename T>
-const T& check_size_t(const void* data, size_t size, size_t min_size, size_t max_size) {
-  return check_size_generic<const T, const void*>(data, size, min_size, max_size);
-}
-template <typename T>
-const T& check_size_t(const void* data, size_t size, size_t max_size) {
-  return check_size_generic<const T, const void*>(data, size, sizeof(T), max_size);
-}
-template <typename T>
-const T& check_size_t(const void* data, size_t size) {
-  return check_size_generic<const T, const void*>(data, size, sizeof(T), sizeof(T));
-}
-
-template <typename T>
-T& check_size_t(void* data, size_t size, size_t min_size, size_t max_size) {
-  return check_size_generic<T, void*>(data, size, min_size, max_size);
-}
-template <typename T>
-T& check_size_t(void* data, size_t size, size_t max_size) {
-  return check_size_generic<T, void*>(data, size, sizeof(T), max_size);
-}
-template <typename T>
-T& check_size_t(void* data, size_t size) {
-  return check_size_generic<T, void*>(data, size, sizeof(T), sizeof(T));
-}
-
-void check_size_v(size_t size, size_t min_size, size_t max_size = 0);
-
-std::string prepend_command_header(
-    Version version,
-    bool encryption_enabled,
-    uint16_t cmd,
-    uint32_t flag,
-    const std::string& data);
+#pragma once
+
+#include <event2/bufferevent.h>
+#include <inttypes.h>
+
+#include <functional>
+#include <phosg/Strings.hh>
+
+#include "PSOEncryption.hh"
+#include "Version.hh"
+
+struct PSOCommandHeaderPC {
+  le_uint16_t size;
+  uint8_t command;
+  uint8_t flag;
+} __packed_ws__(PSOCommandHeaderPC, 4);
+
+struct PSOCommandHeaderDCV3 {
+  uint8_t command;
+  uint8_t flag;
+  le_uint16_t size;
+} __packed_ws__(PSOCommandHeaderDCV3, 4);
+
+struct PSOCommandHeaderBB {
+  le_uint16_t size;
+  le_uint16_t command;
+  le_uint32_t flag;
+} __packed_ws__(PSOCommandHeaderBB, 8);
+
+union PSOCommandHeader {
+  PSOCommandHeaderDCV3 dc;
+  PSOCommandHeaderPC pc;
+  PSOCommandHeaderDCV3 gc;
+  PSOCommandHeaderDCV3 xb;
+  PSOCommandHeaderBB bb;
+
+  uint16_t command(Version version) const;
+  void set_command(Version version, uint16_t command);
+  uint16_t size(Version version) const;
+  void set_size(Version version, uint32_t size);
+  uint32_t flag(Version version) const;
+  void set_flag(Version version, uint32_t flag);
+  static inline size_t header_size(Version version) {
+    return (version == Version::BB_V4) ? 8 : 4;
+  }
+
+  PSOCommandHeader();
+} __packed_ws__(PSOCommandHeader, 8);
+
+// This function is used in a lot of places to check received command sizes and
+// cast them to the appropriate type
+template <typename RetT, typename PtrT>
+RetT& check_size_generic(
+    PtrT data,
+    size_t size,
+    size_t min_size,
+    size_t max_size) {
+  if (size < min_size) {
+    throw std::runtime_error(string_printf(
+        "command too small (expected at least 0x%zX bytes, received 0x%zX bytes)",
+        min_size, size));
+  }
+  if (size > max_size) {
+    throw std::runtime_error(string_printf(
+        "command too large (expected at most 0x%zX bytes, received 0x%zX bytes)",
+        max_size, size));
+  }
+  return *reinterpret_cast<RetT*>(data);
+}
+
+template <typename T>
+const T& check_size_t(const std::string& data, size_t min_size, size_t max_size) {
+  return check_size_generic<const T, const void*>(data.data(), data.size(), min_size, max_size);
+}
+template <typename T>
+const T& check_size_t(const std::string& data, size_t max_size) {
+  return check_size_generic<const T, const void*>(data.data(), data.size(), sizeof(T), max_size);
+}
+template <typename T>
+const T& check_size_t(const std::string& data) {
+  return check_size_generic<const T, const void*>(data.data(), data.size(), sizeof(T), sizeof(T));
+}
+
+template <typename T>
+T& check_size_t(std::string& data, size_t min_size, size_t max_size) {
+  return check_size_generic<T, void*>(data.data(), data.size(), min_size, max_size);
+}
+template <typename T>
+T& check_size_t(std::string& data, size_t max_size) {
+  return check_size_generic<T, void*>(data.data(), data.size(), sizeof(T), max_size);
+}
+template <typename T>
+T& check_size_t(std::string& data) {
+  return check_size_generic<T, void*>(data.data(), data.size(), sizeof(T), sizeof(T));
+}
+
+template <typename T>
+const T& check_size_t(const void* data, size_t size, size_t min_size, size_t max_size) {
+  return check_size_generic<const T, const void*>(data, size, min_size, max_size);
+}
+template <typename T>
+const T& check_size_t(const void* data, size_t size, size_t max_size) {
+  return check_size_generic<const T, const void*>(data, size, sizeof(T), max_size);
+}
+template <typename T>
+const T& check_size_t(const void* data, size_t size) {
+  return check_size_generic<const T, const void*>(data, size, sizeof(T), sizeof(T));
+}
+
+template <typename T>
+T& check_size_t(void* data, size_t size, size_t min_size, size_t max_size) {
+  return check_size_generic<T, void*>(data, size, min_size, max_size);
+}
+template <typename T>
+T& check_size_t(void* data, size_t size, size_t max_size) {
+  return check_size_generic<T, void*>(data, size, sizeof(T), max_size);
+}
+template <typename T>
+T& check_size_t(void* data, size_t size) {
+  return check_size_generic<T, void*>(data, size, sizeof(T), sizeof(T));
+}
+
+void check_size_v(size_t size, size_t min_size, size_t max_size = 0);
+
+std::string prepend_command_header(
+    Version version,
+    bool encryption_enabled,
+    uint16_t cmd,
+    uint32_t flag,
+    const std::string& data);

src/PatchFileIndex.cc

@@ -1,162 +1,162 @@
-#include "PatchFileIndex.hh"
-
-#include <stdio.h>
-#include <string.h>
-
-#include <functional>
-#include <phosg/Filesystem.hh>
-#include <phosg/Hash.hh>
-#include <phosg/Strings.hh>
-#include <stdexcept>
-
-#include "Loggers.hh"
-
-using namespace std;
-
-PatchFileIndex::File::File(PatchFileIndex* index)
-    : index(index),
-      crc32(0),
-      size(0) {}
-
-std::shared_ptr<const std::string> PatchFileIndex::File::load_data() {
-  if (!this->loaded_data) {
-    string relative_path = join(this->path_directories, "/") + "/" + this->name;
-    string full_path = this->index->root_dir + "/" + relative_path;
-    patch_index_log.info("Loading data for %s", relative_path.c_str());
-    this->loaded_data = make_shared<string>(load_file(full_path));
-    this->size = this->loaded_data->size();
-  }
-  return this->loaded_data;
-}
-
-PatchFileIndex::PatchFileIndex(const string& root_dir)
-    : root_dir(root_dir) {
-
-  string metadata_cache_filename = root_dir + "/.metadata-cache.json";
-  JSON metadata_cache_json;
-  try {
-    string metadata_text = load_file(metadata_cache_filename);
-    metadata_cache_json = JSON::parse(metadata_text);
-    patch_index_log.info("Loaded patch metadata cache from %s", metadata_cache_filename.c_str());
-  } catch (const exception& e) {
-    metadata_cache_json = JSON::dict();
-    patch_index_log.warning("Cannot load patch metadata cache from %s: %s", metadata_cache_filename.c_str(), e.what());
-  }
-
-  // Assuming it's rare for patch files to change, we skip writing the metadata
-  // cache if no files were changed at all (which should usually be the case)
-  bool should_write_metadata_cache = false;
-  JSON new_metadata_cache_json = JSON::dict();
-
-  vector<string> path_directories;
-  function<void(const string&)> collect_dir = [&](const string& dir) -> void {
-    path_directories.emplace_back(dir);
-
-    string relative_dirs = join(path_directories, "/");
-    string full_dir_path = root_dir + '/' + relative_dirs;
-    patch_index_log.info("Listing directory %s", full_dir_path.c_str());
-
-    for (const auto& item : list_directory(full_dir_path)) {
-      // Skip invisible files (e.g. .DS_Store on macOS)
-      if (starts_with(item, ".")) {
-        continue;
-      }
-
-      string relative_item_path = relative_dirs + '/' + item;
-      string full_item_path = root_dir + '/' + relative_item_path;
-      if (isdir(full_item_path)) {
-        collect_dir(item);
-      } else if (isfile(full_item_path)) {
-
-        auto st = stat(full_item_path);
-
-        auto f = make_shared<File>(this);
-        f->path_directories = path_directories;
-        f->name = item;
-
-        string compute_crc32s_message; // If not empty, should compute crc32s
-        JSON cache_item_json;
-        try {
-          cache_item_json = metadata_cache_json.at(relative_item_path);
-          uint64_t cached_size = cache_item_json.get_int(0);
-          uint64_t cached_mtime = cache_item_json.get_int(1);
-          if (static_cast<uint64_t>(st.st_mtime) != cached_mtime) {
-            throw runtime_error("file has been modified");
-          }
-          if (static_cast<uint64_t>(st.st_size) != cached_size) {
-            throw runtime_error("file size has changed");
-          }
-          f->size = cached_size;
-          f->crc32 = cache_item_json.get_int(2);
-          for (const auto& chunk_crc32_json : cache_item_json.get_list(3)) {
-            f->chunk_crcs.emplace_back(chunk_crc32_json->as_int());
-          }
-
-        } catch (const exception& e) {
-          compute_crc32s_message = e.what();
-        }
-
-        if (!compute_crc32s_message.empty()) {
-          auto data = f->load_data(); // Sets f->size
-          f->crc32 = crc32(data->data(), f->size);
-          for (size_t x = 0; x < data->size(); x += 0x4000) {
-            size_t chunk_bytes = min<size_t>(f->size - x, 0x4000);
-            f->chunk_crcs.emplace_back(::crc32(data->data() + x, chunk_bytes));
-          }
-
-          // File was modified or cache item was missing; make a new cache item
-          auto chunk_crcs_item = JSON::list();
-          for (uint32_t chunk_crc : f->chunk_crcs) {
-            chunk_crcs_item.emplace_back(chunk_crc);
-          }
-          new_metadata_cache_json.emplace(
-              relative_item_path, JSON::list({f->size, st.st_mtime, f->crc32, std::move(chunk_crcs_item)}));
-          should_write_metadata_cache = true;
-
-        } else {
-          // File was not modified and cache item was valid; just use the
-          // existing cache item
-          new_metadata_cache_json.emplace(
-              relative_item_path, std::move(cache_item_json));
-        }
-
-        this->files_by_patch_order.emplace_back(f);
-        this->files_by_name.emplace(relative_item_path, f);
-        if (compute_crc32s_message.empty()) {
-          patch_index_log.info(
-              "Added file %s (%" PRIu32 " bytes; %zu chunks; %08" PRIX32 " from cache)",
-              full_item_path.c_str(), f->size, f->chunk_crcs.size(), f->crc32);
-        } else {
-          patch_index_log.info(
-              "Added file %s (%" PRIu32 " bytes; %zu chunks; %08" PRIX32 " [%s])",
-              full_item_path.c_str(), f->size, f->chunk_crcs.size(), f->crc32, compute_crc32s_message.c_str());
-        }
-      }
-    }
-
-    path_directories.pop_back();
-  };
-
-  collect_dir(".");
-
-  if (should_write_metadata_cache) {
-    try {
-      save_file(metadata_cache_filename, new_metadata_cache_json.serialize());
-      patch_index_log.info("Saved patch metadata cache to %s", metadata_cache_filename.c_str());
-    } catch (const exception& e) {
-      patch_index_log.warning("Cannot save patch metadata cache to %s: %s", metadata_cache_filename.c_str(), e.what());
-    }
-  } else {
-    patch_index_log.info("No files were modified; skipping metadata cache update");
-  }
-}
-
-const vector<shared_ptr<PatchFileIndex::File>>&
-PatchFileIndex::all_files() const {
-  return this->files_by_patch_order;
-}
-
-shared_ptr<PatchFileIndex::File> PatchFileIndex::get(
-    const string& filename) const {
-  return this->files_by_name.at(filename);
-}
+#include "PatchFileIndex.hh"
+
+#include <stdio.h>
+#include <string.h>
+
+#include <functional>
+#include <phosg/Filesystem.hh>
+#include <phosg/Hash.hh>
+#include <phosg/Strings.hh>
+#include <stdexcept>
+
+#include "Loggers.hh"
+
+using namespace std;
+
+PatchFileIndex::File::File(PatchFileIndex* index)
+    : index(index),
+      crc32(0),
+      size(0) {}
+
+std::shared_ptr<const std::string> PatchFileIndex::File::load_data() {
+  if (!this->loaded_data) {
+    string relative_path = join(this->path_directories, "/") + "/" + this->name;
+    string full_path = this->index->root_dir + "/" + relative_path;
+    patch_index_log.info("Loading data for %s", relative_path.c_str());
+    this->loaded_data = make_shared<string>(load_file(full_path));
+    this->size = this->loaded_data->size();
+  }
+  return this->loaded_data;
+}
+
+PatchFileIndex::PatchFileIndex(const string& root_dir)
+    : root_dir(root_dir) {
+
+  string metadata_cache_filename = root_dir + "/.metadata-cache.json";
+  JSON metadata_cache_json;
+  try {
+    string metadata_text = load_file(metadata_cache_filename);
+    metadata_cache_json = JSON::parse(metadata_text);
+    patch_index_log.info("Loaded patch metadata cache from %s", metadata_cache_filename.c_str());
+  } catch (const exception& e) {
+    metadata_cache_json = JSON::dict();
+    patch_index_log.warning("Cannot load patch metadata cache from %s: %s", metadata_cache_filename.c_str(), e.what());
+  }
+
+  // Assuming it's rare for patch files to change, we skip writing the metadata
+  // cache if no files were changed at all (which should usually be the case)
+  bool should_write_metadata_cache = false;
+  JSON new_metadata_cache_json = JSON::dict();
+
+  vector<string> path_directories;
+  function<void(const string&)> collect_dir = [&](const string& dir) -> void {
+    path_directories.emplace_back(dir);
+
+    string relative_dirs = join(path_directories, "/");
+    string full_dir_path = root_dir + '/' + relative_dirs;
+    patch_index_log.info("Listing directory %s", full_dir_path.c_str());
+
+    for (const auto& item : list_directory(full_dir_path)) {
+      // Skip invisible files (e.g. .DS_Store on macOS)
+      if (starts_with(item, ".")) {
+        continue;
+      }
+
+      string relative_item_path = relative_dirs + '/' + item;
+      string full_item_path = root_dir + '/' + relative_item_path;
+      if (isdir(full_item_path)) {
+        collect_dir(item);
+      } else if (isfile(full_item_path)) {
+
+        auto st = stat(full_item_path);
+
+        auto f = make_shared<File>(this);
+        f->path_directories = path_directories;
+        f->name = item;
+
+        string compute_crc32s_message; // If not empty, should compute crc32s
+        JSON cache_item_json;
+        try {
+          cache_item_json = metadata_cache_json.at(relative_item_path);
+          uint64_t cached_size = cache_item_json.get_int(0);
+          uint64_t cached_mtime = cache_item_json.get_int(1);
+          if (static_cast<uint64_t>(st.st_mtime) != cached_mtime) {
+            throw runtime_error("file has been modified");
+          }
+          if (static_cast<uint64_t>(st.st_size) != cached_size) {
+            throw runtime_error("file size has changed");
+          }
+          f->size = cached_size;
+          f->crc32 = cache_item_json.get_int(2);
+          for (const auto& chunk_crc32_json : cache_item_json.get_list(3)) {
+            f->chunk_crcs.emplace_back(chunk_crc32_json->as_int());
+          }
+
+        } catch (const exception& e) {
+          compute_crc32s_message = e.what();
+        }
+
+        if (!compute_crc32s_message.empty()) {
+          auto data = f->load_data(); // Sets f->size
+          f->crc32 = crc32(data->data(), f->size);
+          for (size_t x = 0; x < data->size(); x += 0x4000) {
+            size_t chunk_bytes = min<size_t>(f->size - x, 0x4000);
+            f->chunk_crcs.emplace_back(::crc32(data->data() + x, chunk_bytes));
+          }
+
+          // File was modified or cache item was missing; make a new cache item
+          auto chunk_crcs_item = JSON::list();
+          for (uint32_t chunk_crc : f->chunk_crcs) {
+            chunk_crcs_item.emplace_back(chunk_crc);
+          }
+          new_metadata_cache_json.emplace(
+              relative_item_path, JSON::list({f->size, st.st_mtime, f->crc32, std::move(chunk_crcs_item)}));
+          should_write_metadata_cache = true;
+
+        } else {
+          // File was not modified and cache item was valid; just use the
+          // existing cache item
+          new_metadata_cache_json.emplace(
+              relative_item_path, std::move(cache_item_json));
+        }
+
+        this->files_by_patch_order.emplace_back(f);
+        this->files_by_name.emplace(relative_item_path, f);
+        if (compute_crc32s_message.empty()) {
+          patch_index_log.info(
+              "Added file %s (%" PRIu32 " bytes; %zu chunks; %08" PRIX32 " from cache)",
+              full_item_path.c_str(), f->size, f->chunk_crcs.size(), f->crc32);
+        } else {
+          patch_index_log.info(
+              "Added file %s (%" PRIu32 " bytes; %zu chunks; %08" PRIX32 " [%s])",
+              full_item_path.c_str(), f->size, f->chunk_crcs.size(), f->crc32, compute_crc32s_message.c_str());
+        }
+      }
+    }
+
+    path_directories.pop_back();
+  };
+
+  collect_dir(".");
+
+  if (should_write_metadata_cache) {
+    try {
+      save_file(metadata_cache_filename, new_metadata_cache_json.serialize());
+      patch_index_log.info("Saved patch metadata cache to %s", metadata_cache_filename.c_str());
+    } catch (const exception& e) {
+      patch_index_log.warning("Cannot save patch metadata cache to %s: %s", metadata_cache_filename.c_str(), e.what());
+    }
+  } else {
+    patch_index_log.info("No files were modified; skipping metadata cache update");
+  }
+}
+
+const vector<shared_ptr<PatchFileIndex::File>>&
+PatchFileIndex::all_files() const {
+  return this->files_by_patch_order;
+}
+
+shared_ptr<PatchFileIndex::File> PatchFileIndex::get(
+    const string& filename) const {
+  return this->files_by_name.at(filename);
+}

src/PatchFileIndex.hh

@@ -1,52 +1,52 @@
-#pragma once
-
-#include <inttypes.h>
-
-#include <map>
-#include <memory>
-#include <string>
-#include <unordered_map>
-#include <vector>
-
-struct PatchFileIndex {
-  explicit PatchFileIndex(const std::string& root_dir);
-
-  struct File {
-    PatchFileIndex* index;
-    std::vector<std::string> path_directories;
-    std::string name;
-    std::shared_ptr<const std::string> loaded_data;
-    std::vector<uint32_t> chunk_crcs;
-    uint32_t crc32;
-    uint32_t size;
-
-    explicit File(PatchFileIndex* index);
-    std::shared_ptr<const std::string> load_data();
-  };
-
-  const std::vector<std::shared_ptr<File>>& all_files() const;
-  std::shared_ptr<File> get(const std::string& filename) const;
-
-private:
-  std::vector<std::shared_ptr<File>> files_by_patch_order;
-  std::unordered_map<std::string, std::shared_ptr<File>> files_by_name;
-  std::string root_dir;
-};
-
-struct PatchFileChecksumRequest {
-  std::shared_ptr<PatchFileIndex::File> file;
-  uint32_t crc32;
-  uint32_t size;
-  bool response_received;
-
-  explicit PatchFileChecksumRequest(std::shared_ptr<PatchFileIndex::File> file)
-      : file(file),
-        crc32(0),
-        size(0),
-        response_received(false) {}
-  inline bool needs_update() const {
-    return !this->response_received ||
-        (this->crc32 != this->file->crc32) ||
-        (this->size != this->file->size);
-  }
-};
+#pragma once
+
+#include <inttypes.h>
+
+#include <map>
+#include <memory>
+#include <string>
+#include <unordered_map>
+#include <vector>
+
+struct PatchFileIndex {
+  explicit PatchFileIndex(const std::string& root_dir);
+
+  struct File {
+    PatchFileIndex* index;
+    std::vector<std::string> path_directories;
+    std::string name;
+    std::shared_ptr<const std::string> loaded_data;
+    std::vector<uint32_t> chunk_crcs;
+    uint32_t crc32;
+    uint32_t size;
+
+    explicit File(PatchFileIndex* index);
+    std::shared_ptr<const std::string> load_data();
+  };
+
+  const std::vector<std::shared_ptr<File>>& all_files() const;
+  std::shared_ptr<File> get(const std::string& filename) const;
+
+private:
+  std::vector<std::shared_ptr<File>> files_by_patch_order;
+  std::unordered_map<std::string, std::shared_ptr<File>> files_by_name;
+  std::string root_dir;
+};
+
+struct PatchFileChecksumRequest {
+  std::shared_ptr<PatchFileIndex::File> file;
+  uint32_t crc32;
+  uint32_t size;
+  bool response_received;
+
+  explicit PatchFileChecksumRequest(std::shared_ptr<PatchFileIndex::File> file)
+      : file(file),
+        crc32(0),
+        size(0),
+        response_received(false) {}
+  inline bool needs_update() const {
+    return !this->response_received ||
+        (this->crc32 != this->file->crc32) ||
+        (this->size != this->file->size);
+  }
+};