Black Souls Mod Loader

A modding framework for Black Souls II - RPG Maker VX Ace, RGSS3, Ruby 1.9.

The mod loader patches Game.rgss3a so the game loads custom Ruby mods (and their assets) from BLACK SOULS II/Mods/<your_mod>/ at startup. Drop a folder, ship a mod. Replace any graphic or audio file by putting it in the mod's assets/ subfolder. Hook any class, override any scene, change the game.

INSTALLATION

Download the .exe, pick your game folder, click Install.

CREATING MODS

Folder structure, main.rb, the alias_method pattern.

ASSET OVERRIDES

Replace any image / audio / data file via assets/.

TEMPLATES

Five starter mods showing common patterns.

API REFERENCE

What the loader exposes - ModLoader.log, hooks, etc.

ASSET EXTRACTOR

Standalone GUI to dump and repack Game.rgss3a.

SCRIPT INDEX

All 224 BS2 scripts, in load order. Pick what to monkey-patch.

CLASS REFERENCE

Every class / module / method, with the script that defines it.

Quick start

Download BlackSoulsModLoader.exe from the GitHub Releases page.
Run it.
Click Browse and pick your BLACK SOULS II folder (the folder containing Game.exe and Game.rgss3a).
Click Install / Update.
Launch the game. Drop mods into BLACK SOULS II/Mods/<your_mod>/.

To uninstall: launch the .exe again, pick the same folder, click Uninstall. The original Game.rgss3a is restored from its automatic backup. Your Mods/ folder is preserved.

What's in the box

The full project ships as three independent pieces:

Mod Loader - the patcher and its GUI; produces BlackSoulsModLoader.exe.
Asset Extractor - a separate tool that dumps and repacks Game.rgss3a; produces BlackSoulsAssetExtractor.exe.
This documentation site - the pages you're reading now.

New to RGSS3 modding? The How it works page explains the archive format, why a loader is needed at all, and what the patch actually does to Game.rgss3a.