SWRSToys

This repository was moved to https://github.com/SokuDev/SokuMods/ and is now archived.

A modding framework for Touhou Hisoutensoku (12.3).

This repository was originally created from the original SWRSToys release by Anonymous Coward with the following goals:

• make sure the source code for SWRSToys is easy to find
• make a repository of all released modules and their source code, including ones that were not made by Anonymous Coward
• have up-to-date headers of the latest reverse-engineered addresses from the game, updated as new people find more addresses
• set up a CI for easy, reproducible builds and deployment of the latest release of SWRSToys.

Most of the code was not written by delthas:

• this repository (and most of this code) is forked off a source archive of SWRSToys, made by Anonymous Coward
• Shinki and PC_volt made ReplayInputView+
• DPhoenix made UPnPNat
• fishshapedfish made DPadFix
• RhythmLunatic made WindowedFullscreen
• Ichirin made SWRSokuRoll (SokuRoll was made by FireSeal)
• Ichirin made CharactersInForeground
• S-len made SkipIntro
• delthas made all the plumbing: adding CMake, CI, formatting, ...

If you have made an SWRSToys module, do contact me either on GitHub or with a PM on Discord (cc#6439) so we can add it here, with proper credits!

Using

• Download the latest release and extract it in your game folder.
• Open SWRSToys.ini in Notepad and enable some modules by deleting their ;, then save the file.
• Modify the .ini configuration files of modules you enabled (in the modules/ folder)
• Run the game as usual.

Modules

BGMChanger

Replace some of the game BGMs.

The only supported format is OGG Vorbis.

CharactersInForeground

Draw characters over HP bars, for better clarity.

This module does not have a configuration file.

DPadFix

Map the joystick DPad and trigger buttons to game inputs.

MemoryPatch

Do some misceallenous patches to the game, such as disallowing spectating by default.

Edit MemoryPatch.ini to enable/disable options.

Available patches:

• 16bitsColor: reduce rendering color depth from 32 bits to 16 bits
• InputFreedom: accept gamepad input even when the device is inactive
• DefaultDenyWatch: disallow spectating by default
• DefaultDenyBattle: spectate by default
• AllowMultiInstance: allow running multiple instances of the game at once
• DisableWeatherEffect: disable all weather effects
• AlwaysRandomMusic: always play random stage music regardless of in-game choice
• NativeDPadFix: use the gamepad DPad rather than the circle pad (use only if DPadFix does not work)

NetBattleCounter

Display the number of consecutive online matches you play, and optionally play specific sounds on consecutive games played.

NetBellChanger

Change the game start bell sound for online matches.

NetProfileView

Display profile name for players in a game with a specific formatting (color, font, ...) (spectating and/or playing).

ReplayDnD

Drag and drop a replay file to the game executable file to watch it immediately.

Dragging a replay to a running game window does not work; you need to drag it to the game exacutable file in Windows Explorer.

ReplayInputView (deprecated)

This module is now deprecated, use ReplayInputView+ instead.

Display keystrokes in game replays in real time.

The replay speed can also be changed with hotkeys: F10 speeds up; F11 slows down; F12 returns to original speed; F8 and F9 cycle through different game inputs display, for the left and right player respectively.

This module does not have a configuration file.

ReplayInputView+

Display keystrokes in game replays in real time, as well as hitboxes, ...

The replay speed can also be changed with configurable hotkeys: by default F10 speeds up; F9 slows down; F11 pauses and unpauses the game; F12 steps a single frame forward; F4 toggles hitboxes display; F6 displays additional debug information; F7 cycles through different game inputs display.

SkipIntro

Skip the game intro screen, automatically enter a menu or a custom practice preset on start.

SWRSokuRoll

Load SokuRoll automatically.

This mod uses a configuration file in its module directory, not the SokuRoll.ini in the main game folder. This mod does not require installing SokuRoll (does not require SokuRoll.dll and SokuRoll.ini).

UPnPNat

Automatically forward your ports every time the game runs.

This mod uses the UPnP NAT technology, which lets applications automatically request a port forwarding without user intervention. This technology is known to be disabled by default on most routers and might therefore not work for everyone.

WindowedFullscreen

Make the game window fullscreen, but without stretching, and with fast Alt+Tab.

This module does not have a configuration file, and is not compatible with SokuEngine.

WindowResizer

Make the game window resizable.

Making a module

• Make a new folder in modules/. You can copy an existing module and adapt it.
• Edit the root CMakeLists.txt file accordingly.
• Your module will automatically be injected.

Building

Clone the project, including its submodules:

git clone --recursive git@github.com:delthas/SWRSToys.git

Or, if you have already cloned without pulling the submodules, download them:

git submodule update --init --recursive

Install Visual Studio (or CMake and the Visual C++ Build Tools).

If you're running Visual Studio 2017 or newer: import the directory in Visual Studio, the project will be recognized automatically.

If you're running Visual Studio 2015 or older: you will need to install CMake and run:

cmake .

MinGW and Cygwin are not supported (__thiscall is needed in order to be compatible with the base game, which only the Visual C++ Build Tools supports).

After building, run the install target, which will create an install folder with all the built files.

License

• Files in include/directx/ are licensed according to their license header
• Files in lib/ are pre-compiled archives copyrighted by Microsoft
• All other files are licensed according to the LICENSE file