FloodForge

FloodForge is a C++ remake of a few Rain World modding tools.

It aims for intuitive controls, clean ui, and as few dependencies as possible.

Controls

Action	Key	Description
Delete	X	Removes hovered room or connection.
Change Room Layer	L	Switches between layers within the hovered room.
Change Flag	F	Change room flags (shelter, karma gate, savvy outpost, etc.).
Change Subregion	S	Openes a popup for adding, removing, and changing subregions.
Hide / Show	H	Toggle visibility of hovered room.
Print Debug Info	D	Outputs debug information for the hovered room or connection.
Cancel/Exit	ESC	Closes menus or cancels actions.
Accept	ENTER	Confirms selections or actions.

Building

Windows

Requirements:

• MSYS2 MINGW

One time build

If you want to have a permanent executable that you can run whenever, use this option. ./Build.bat

Building for debugging

Use this if you are editing the code and need to quickly test ./Build.bat --debug

Shell script

The build.sh script also works under Msys2.

First, install Make:

pacman -S make

Then refer to the Linux build instructions.

Linux

Warning

Linux builds are untested, they may not work.

Requirements:

• GLFW3
• pkg-config
• Make

./Build.sh

# build in debug mode
./Build.sh --debug

# build in release mode
./Build.sh --release

Custom Themes

To create a custom theme, you need to modify the file assets/theme.txt. FloodForge will only load theme.txt, so if you need a backup, feel free to duplicate it.

License

FloodForge is licensed under the GPL-3.0 License.
Please refer to the LICENSE file for full details.

GLFW License

GLFW binaries are included in this repository for ease-of-use. The license is at the top of both .h files (include/GLFW/glfw3.h, include/GLFW.glfw3native.h).

Asset Licenses

• Fonts: See associated README and license files in the fonts/ directory.
• Bitmap Fonts: Generated using Snow Bamboo.
• Splash Screen Art: Rendered from Rain World's Shoreline map.
• All other artwork: Hand-created by the FloodForge team.