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
Move Room / Popup	LMB	Move rooms around, hold ALT to move without snapping.
Move Camera	MMB	Pan camera.
Connect Rooms	RMB	Add connections between room exits.
Delete	X	Removes hovered room or connection.
Creature Den	C	Opens the hovered den.
Room Merge	G	Toggle room visual merging.
Change Room Layer	L	Switches between layers within the hovered room.
Change Room Tag	T	Change room tags (shelter, karma gate, scavenger outpost, etc.).
Change Subregion	S	Openes a popup for adding, removing, and changing subregions.
Change Room Attractiveness	A	Change the attractiveness of a room for specific creatures.
Hide / Show	H	Toggle visibility of hovered room.
Show other rooms	I	Places hovered room behind all other rooms.
Cancel/Exit	ESC	Closes menus or cancels actions.
Accept	ENTER	Confirms selections or actions.
Open Tutorial	ALT+T	Opens the tutorial popup.

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

Install:

sudo apt-get install make
sudo apt-get install libglfw3-dev
sudo apt-get install pkg-config
sudo apt-get install g++

Build:

./Build.sh

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

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

I found a bug!

Report it on the new FloodForge Discord server!

Settings

Settings are stored in assets/settings.txt

Setting	Default Value	Allowed Values	Description
Theme	N/A	any folder in assets/themes/
CameraPanSpeed	0.4	float
CameraZoomSpeed	0.4	float
PopupScrollSpeed	0.4	float
OriginalControls	false	true, false
ConnectionType	bezier	bezier, linear
SelectorScale	true	true, false	If true, creature icons stay the same size when zooming
DefaultFilePath		string
WarnMissingImages	false	true, false
HideTutorial	false	true, false	Prevents the tutorial from appearing when starting FloodForge
UpdateWorldFiles	true	true, false	Decide whether to modify imported world files when exporting, or to create new files in worlds

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.