¶ Introduction to the Bellwright Modkit
Welcome to the official documentation for the Bellwright Modkit! This guide will help you get started with creating and sharing your own content for Bellwright during its closed testing phase.
What is the Bellwright Modkit?
Bellwright Modkit is a powerful suite of tools that gives you access to the same modified version of Unreal Engine 5 (5.5.4) editor that we use to create the game. This means you can modify virtually anything in the game short of C++ code, and fill the game with any content you want.
The capabilities of this modkit are extensive - allowing you to create new items, buildings, quests, gameplay mechanics, and much more. The only limitation in terms of blueprint logic is what's already exposed from the game’s code, but the developers are committed to continuously expose more functionality over time, focusing on mod authors' feedback and requests.
¶ Getting Started
System Requirements
To use the Bellwright Modkit, your system should meet the same requirements as running the regular UE5 editor. Generally speaking, if your system can run the base game, it should be able to run the modkit, though more RAM and a faster CPU will improve your development experience.
Downloading and Installing
The modkit is available through the Epic Games Store (EGS):
https://store.epicgames.com/en-US/p/bellwright-modkit
Required Dependencies
The Bellwright Modkit has no additional dependencies to use it for mod creation. However, to upload mods to the Steam Workshop, you must:
- Own Bellwright on Steam.
- Have the Steam client running while uploading mods.
¶ Creating a Mod
Modkit Interface Overview
The Bellwright Modkit is a modified version of the UE5 editor. As such, it contains all the standard tools and features of Unreal Engine 5, plus some custom tooling specific to Bellwright development and modding.
Project and File Structure
Every time you start the modkit, you’ll need to create a new mod or choose an existing one from the list. The files of all the mods are backed up and loaded once the mod is chosen.
This system allows for simultaneous development of multiple mods without the need to manually handle file versioning (which is still very much encouraged).
Basic Workflow for Creating Mods
The basic workflow for creating mods in Bellwright is as follows:
- All modifications, creations, and deletions of assets are stored in the `modinfo.json` file of the currently active mod in `../Saved/Mods/ModName`.
- No special workflow is required to handle changes or additions in a given mod - just use regular UE5 editor workflows and the list of changes will automatically populate.
- Once your mod is complete and all changes are made, open the mod manager by clicking the Bellwright logo in the toolbar.
- In the mod manager, you can manually edit the list of assets that should be cooked and packaged by clicking on `Assets To Cook`.
- From the mod manager, you can initiate the cooking and packaging process for your mod by clicking on “Cook and Package Mod”
- If you want to upload the mod to Steam Workshop, switch to "Uploading" after cooking is complete, then make sure all the required fields are filled out, and a mod image is placed in `../Content/Mods/ModName`.
- Otherwise, the packaged mod files can be found in `../Saved/Mods/ModName/Pak`
Testing Your Mod
To test your mod in-game:
- For Steam Workshop mods: If you've uploaded your mod to Steam Workshop, simply subscribe to the mod to download it into your game.
- For local mods: Create a new folder in the game's directory at `../Bellwright/Content/Mods` named after your mod. Copy all files from the modkit folder `../Saved/Mods/ModName/Pak` into that new folder.
- Launch the game, open the Mods menu, and activate your mod.
- Restart the game and the mod will be loaded.
IMPORTANT NOTE: During the closed testing of the modkit, a special build of the game is required to load mods. It can be accessed by entering this password in Steam Betas: `ModKitTestBranch`
¶
Uploading a Mod
Sharing Your Creation
You have multiple options for sharing your mods, both during and after the closed test:
- Steam Workshop: You can upload directly to Steam Workshop via the modkit's mod manager. Simply click "Upload mod" after packaging is complete. Remember that you need to have the Steam client running for this to work.
- Your mod will be uploaded in an unlisted state, so you can finalize its description, add images, dependencies, and so on.
- Other Platforms: You can also share the packaged mod files on any other platforms like Nexus Mods. In this case, you would share ALL the files from `../Saved/Mods/ModName/Pak` and provide installation instructions to your users.
¶
Additional Guidelines and Information
There are no specific content restrictions for mods at this time. However, please be aware that some guidelines may apply during the testing of the modkit, depending on the version. As with any modding community, respectful and constructive participation is encouraged.
Known Issues and Shortcomings
The Bellwright Modkit is still in development, and we are aware of the following limitations that will be addressed in future updates:
- Currently, only a single mod modifying the Karvenia map will be loaded on the player's side, since any map modification requires cooking and packaging Karvenia_08.
- Sounds imported via modkit don’t support all codecs. Please use Bink with inline loading, PCM or ADPCM.
- Some operations require manually editing modinfo.json. For example, if you delete your mod from Steam, you’ll need to set steamId to 0 for the mod manager to recognize that a new mod page must be created when uploading it.
Getting Support
If you encounter issues not listed above or have questions about the modkit:
- A dedicated channel on the official Bellwright Discord is available all mod authors: #mod-dev-general
- #mod-development forum is also available on Discord, where you can post your feedback, questions, and discussions about the modkit and modding Bellwright in general.