Skip to content

kleineluka/burial

Repository files navigation

Features 🐰

Burial is a program for TCOAAL mod players, mod creators, or just about anybody who likes the game~ πŸ…

  • Mod Manager 🍱: One-click install of modpacks, modloader manager, browse/download mods (from various sources), manage installed mods, install mods from external URLs, one-click mod installation from websites (burial:// protocol), switch mods easily with a profile system, and preview upcoming mods.
  • Resources βœ‚οΈ: Decrypt/encrypt .k9a files, export categories of resources, generate asset templates, parse/import dialogue, and decrypt/modify save files.
  • Reversing 🧬: Targeted code injection, export/deobfuscate/comment game run-time code, manage NW.js SDK's, manage developer tools, view game information, and create backups of your game files.
  • Mod Tools πŸ–οΈ: Turn the game to an RPG Maker project, export an RPG Maker project to a mod, convert a non-Tomb mod to a Tomb mod, decompile a mod, edit mod.json files, edit repo.json files, and generate mod version differences.
  • Knowledge πŸ“”: Easily access modding resources in one convenient place.
  • Easy and Safe 🍡: Burial only takes a few clicks to get you playing mods, has lots of tooltips, and implements safety guardrails to protect your saves.
  • Quality of Life 🌸: Pretty GUI with character-based themes, settings, built-in tutorials, update checking, lots of emojis..
  • Fast, Small, and Open πŸ¦„: Built with Rust, a native webview (<30mb, no Electron!), and a forever open-source mindset.

Installing Burial 🩸

Burial is stable on Windows, but Linux and Mac builds are experimental!

  1. Download the latest app from Github Releases, GameBanana, Itch.io, or Nexus Mods.
  2. Run the installer, silly!
    Questions: Why does Windows Defender appear? and Why is the program not portable?
  3. Open the program and enjoy!

To compile the source code yourself, please see the Contributing page on the Wiki.

Installing Mods πŸ”ͺ

Burial has dedicated sections for installing mods and Tomb (modloader), or you can do everything in one-click in the modpacks section. Mod metadata is fetched from Llamawa.re, Burial's curated list, and Peachy's Visions. Burial also supports downloading mods from URLs, including GameBanana, Github, and direct links.

Burial is not associated with any mods and is simply a mod manager. Please only download mods that you trust. Burial does not host or distribute any mods and will only add mods when they can be downloaded from their official source.

Further reading: Submit my mod to Burial, submit somebody else's mod to Burial, and submitting a modpack to Burial. If you are having trouble with a third-party mod, please see why doesn't Burial support this or that mod?

Documentation πŸ₯©

Please view the Wiki! For help installing, go to the Installation and Help page. For further help, check out the Problems and Questions page. And if all else fails? Practice demonic magic with your favourite sibling- Open an issue on Github or contact me!.

The tech stack is a Rust back-end (Tauri framework), a web front-end (minimal dependencies), Python scripts to aid in development, TypeScript (Deno) for code deobfuscation, and Javascript for game modification. Wanna help? Check out the Contributing page on the Wiki~

Roadmap πŸ‘οΈ

(In no particular order and beyond basic planned features, aka luxury things that mostlyβ„’ will start after the first release..)

  • Steam Deck Optimization (high priority)
  • Disk Space Awareness (high priority)
  • Language Support (medium priority)
  • Better Dialog Handling (accept copy as path, take zips in place of folders)
  • Easier Save Editor (low priority)
  • Cleanup (Code, UI, Responsiveness, Code Warnings, Var Ownership, Structure, JS -> Rust, Logging, Async I/O)
  • Self Updating (medium priority)
  • One-Click GameBanana Installation (high priority)
  • Symbolic Linking Mod Installations (medium priority)
  • Mod Compatability Checking
  • 7z, TAR Support (switch to 7Zip, low priority)
  • NexusMods, Itch.Io Support (low priority)
  • Game Instances (Profiles)
  • More Tooltips
  • Theming System
  • Settings System
  • Development Build Scripts
  • Linux, MacOS Beta Builds

By Fans, Not Thieves πŸ’— A legal copy of the game is required to use Burial! Burial will never implement any piracy tools.
Please read the license and EULA before interacting with this software, and respect all licenses and rights in attributions. πŸ€“
This is a passion project that I work on constantly in my free-time. If you want to support me, please star 🌠 the repository or contribute!