WYS Race Mod

WYS Race Mod is a multiplayer extension for Will You Snail? designed for racing. It synchronizes up to 16 other players in real-time.

Not compatible with other mods.

---

Features

• See other snails moving in real-time
• A live-updating leaderboard HUD
• Automatic disabling of "Automatic Difficulty"
• Snail customization
• A spectator view
• A ready-up system with a countdown

---

Installation

Follow the instructions below or use Möhrchen's mod launcher

1. Install the Base Game: Purchase and install Will You Snail? via Steam.
   • Note: To find your game folder, right-click the game in Steam > Manage > Browse local files.
2. Obtain the Sandbox Version:
   • For v2.12 (Current):
     1. Right-click the game in Steam > Properties.
     2. Select the Game Versions & Betas tab.
     3. Choose sandbox from the dropdown.
   • For v1.42 (Speedrunner):
     1. Download DepotDownloader.
     2. Run the following command in a terminal (replace placeholders with your Steam credentials):

        ./DepotDownloader -app 1115050 -depot 1115051 -manifest 8825902836070948945 -beta sandbox -username <USER> -password <PASS>
        

     3. Replace your Steam game files with the files downloaded by the tool.
3. Download the Patch: Get the .xdelta file for your version from the Releases page.
4. Apply the Patch:
   1. Go to xdelta-wasm.
   2. Upload the game's original data.win as the Source file.
   3. Upload the downloaded .xdelta file as the Patch file.
   4. Click Apply Patch and download the resulting file.
   5. Delete the original data.win in your game folder and replace it with the new file, ensuring it is named data.win.

---

Using

Networking

Press F1 to toggle the network manager menu.

• Hosting a Game:
  1. Port Forward: Forward a port (Default: 25565). Ensure the service type is set to UDP.
  2. Configure: Set your connection info in-game.
  3. Connect: Click Connect, then provide your connection info to other players.
• Joining a Game:
  1. Configure: Enter the connection info provided by the host into the in-game menu.
  2. Connect: Click Connect to join the lobby.

Customization

Press F2 to toggle the customization menu.

• Changes to your snail’s color and your in-game display name may take a few seconds to synchronize and appear for other players.

Spectating

Press F3 while in the pause menu to toggle the spectator view.

• Click and drag to pan around.
• Use the scroll wheel to zoom in or out.
• Click the pink buttons next to players' names on the leaderboard to follow them

Readying-Up

Press F4 while in a fresh save to toggle being ready

• Once all players are ready, a countdown will begin

Racing & Leaderboards

• Levels and times will only update while following the standard any% route.
• All leaderboard comparisons are calculated using in-game time.

Server

• Download: Get the Server executable for your operating system from the Releases page.
• Execution: Run the executable in a terminal with an optional argument to specify a port (Default: 25565):

  ./Server 27043
  

• Note for Windows Users: Running this server will enable a higher frequency timer than what might be default, which can increase power consumption.

---

Contributing

1. Repository Setup: Fork this repository and clone it.
2. Preparation:
   • In /Build, run the setup script (setup.ps1 for Windows, setup.sh for Linux).
   • This will download UndertaleModCli, xdelta3 (or install it via apt-get on Linux), and DepotDownloader which is then used to automatically download the game files.
   • Python 3.10+ is needed to run the build.py script, and .NET 10 is needed to build the Server.
3. Project Setup:
   • Use the game files from /Build/Game/1.42 to replace the game files installed by Steam.
   • Build the mod for WYS v1.42 by running:

     python3 ./Build/build.py --old
     

   • Use the 1.42.win file from Build/Output to replace the data.win file you just moved over, and make sure to rename it to data.win.
4. Modify:
   • Open data.win using UndertaleModTool and apply your changes.
5. Export:
   • In UndertaleModTool, go to Scripts > Resource Exporters > ExportSpecificCode.csx.
   • Select your local repository directory.
   • Enter the names of the scripts or objects you created or modified.
6. Submit: Commit your changes and create a Pull Request.

Development Notes

• UndertaleModTool may convert references into hardcoded numbers (e.g., 656 instead of obj_network_manager). You must manually change these back to named references after exporting to ensure compatibility.
• Do not redistribute original game files or code belonging to Will You Snail?, including modified *.win files.