A battle simulator/sandbox for OMORI, written in C# for the Godot engine. It aims to recreate the battle system from the game as accurately as possible, allowing users to create any kind of battle scenario they desire.
Simply download the latest release archive from the "Releases" section and extract the contents to any folder. There are two versions to choose from:
OmoriSandbox.zipuses the Vulkan renderer and works best on newer systems. Recommended for most users.OmoriSandbox_Compat.zipuses the OpenGL renderer and works best on older systems. Use this if you're having issues with the Vulkan version.
Either archive should contain two executables:
OmoriSandbox.console.exe: Runs the Sandbox alongside a separate console window. Useful for viewing debug information and any errors that may occur while using the Sandbox. (Recommended)OmoriSandbox.exe: Runs just the Sandbox without a console.
OmoriSandbox_Linux.zipuses the Vulkan renderer and works best on newer systems. Recommended for most users.OmoriSandbox_Linux_Compat.zipuses the OpenGL renderer and works best on older systems. Use this if you're having issues with the Vulkan version.
To run the Sandbox, you can either use the provided OmoriSandbox.sh script, or run the OmoriSandbox.x86_64 executable directly.
You can visit the Official Documentation to read more about how the sandbox works, configuration options, important file paths and folders, and modding.
As of update v0.8, official modding is now supported! You can read more about creating file driven, JSON, and fully fledged C# mods on the official Modding Wiki.
OmoriSandbox will auto-generate a mod called custom when first launched. Here, you can place your custom Battlebacks and/or BGM in their respective battlebacks and bgm folders without having to create a mod yourself. This auto-generated mod behaves exactly as any other mod and can be expanded as you see fit.
Important Note
When it comes to loading C# mods (mods that use a .dll file), OmoriSandbox does not perform any kind of sandboxing or malware checking when loading mods, meaning a malicious actor can create a mod that may harm your system. When using C#/.dll driven mods, ensure that you trust the author. You can use a program such as dnSpy or VirusTotal in order to read the mod code or check the file for viruses before loading it into OmoriSandbox.
Contributions to the project are welcome! You can help contribute to the project in three main ways:
If you find a bug or issue while using the Sandbox, please open an issue in the Issues tab. When opening a new issue, please keep the following in mind:
- Search for any other existing issues that may have already reported the issue you found.
- Please fill out as much as the issue template as you can, including any relevant info and screenshots/video if possible.
- Please be on the lookout for any replies to your issue that may ask for additional information.
- Ensure your issue uses the proper tags.
If there is a feature missing or not fully implemented in the Sandbox that is not listed in the To-Dos section, feel free to open an issue in the Issues tab. Similar to bug reports, please ensure that you use the proper tags and fill out the issue template as much as you can.
If you would like to contribute code to the Sandbox, you must first install the latest .NET Version of Godot.
After installation, simply clone the repository and open the project folder in Godot. All of the necessary assets should already be available to you.
If you need any other assets from the game that the Sandbox currently does not provide, you must retrieve them yourself from a valid copy of Omori.
When you are ready to submit your contribution, please open a pull request in the Pull Requests tab with a detailed description of what your PR accomplishes. While any contributions are welcome, PRs that target anything in the To-Dos section will most likely take priority. Please refrain from modifying anything that impacts the core functionality of the Sandbox, including logos, important filepaths, modifications of vanilla assets, and anything else that negatively impacts the goal of 100% accuracy. Any PRs that are deemed to do so will be rejected.
The assets used by the project were obtained via a legitimate copy of Omori, and are only meant to be used as fair-use and free of charge for this project alone. You may not use the assets contained within this project for any other purpose.
This project is in no way meant to replace the original game, it is for practice, speedrunning, and educational purposes only. It is heavily recommended that you purchase and play through Omori before using this program.
If you are the owner of the aforementioned assets and would like them removed from the repository, please contact me on Discord at alltoasters or submit an issue in the Issues tab.