Skip to content

kleineluka/burial

Repository files navigation

Burial

A (pretty) one stop shop for Coffin of Andy and Leyley modding!
If you want to support the project, please leave a star ^_^

Straight to Downloads πŸ•―οΈ β€’ Discord πŸ₯° β€’ View Changelog πŸ…

Features 🐰 β€’ Install β˜• β€’ Documentation πŸ“» β€’ Roadmap 🚧 β€’ Contribute 🩷 β€’ Credits πŸŽ‰


Loading large Burial preview.. sorry Github doesn't support webm :'( or you are previewing this markdown in VSCode, if so, thanks for working on Burial!

Features 🐰

Burial is a program for mod players, mod creators, content creators and data miners! Burial has something for everyone~ πŸ…

  • Mod Manager 🍱: One-click install of modpacks, manage Tomb modloader, browse and download mods, manage installed mods, and (beta) manage multiple instances of the game.
  • Resources βœ‚οΈ: Decrypt/encrypt files from/to .k9a, export categories of resources, generate asset templates, parse/import dialogue, and decrypt/modify/manage save files.
  • Reversing 🧬: Targeted code injection, export/deobfuscate/comment the game's run-time code, manage NW.js SDK's, enable developer tools, view game information, and create backups of your game files.
  • Mod Tools πŸ–οΈ: Edit mod json files, edit repo json files, generate mod differences, and package your mod.
  • Knowledge πŸ“”: Easily access modding resources in one convenient place.
  • Easy and Safe 🍡: Burial only takes a few clicks to get you playing mods and has safety guardrails in place.
  • Quality of Life 🌸: Pretty GUI with character-based themes, persistent settings, built-in tutorials, update checking, lots of emojis..
  • By Fans, Not Thieves πŸ₯°: A legal copy of the game is required to use Burial! Burial will never implement any piracy tools.

Install β˜•

Executables will not be provided until a stable version is completed.

  1. Download the latest release from the Releases.
  2. Run the installer, silly!
    Questions: Why does Windows Defender appear? and Why is the program not portable?
  3. Open the program and enjoy!

Documentation πŸ“»

Please view the Wiki! For installation guidance, 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.

The tech stack 🍑 is a Rust back-end (Tauri framework), a Javascript front-end (vanilla), Python scripts to aid in development, TypeScript (Deno) for deobfuscation, and Javascript for game modification. Whew, that was a lot! If this sounds like something you may wanna help out with, check out the Contributing page on the Wiki.

Roadmap 🚧

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

  • Language Support
  • Steam Deck Compatibility (and Linux improvements)
  • More Tooltips
  • Better Folder & File Dialog Handling
  • Easier Save Editor
  • Code Cleanup
  • UI Improvements
  • More Error Handling (& Logging)
  • Game Instances
  • Self Updating
  • One-Click GameBanana Installation
  • Organise Code Structure (specifically utils)
  • Better Code Re-Usability (ex. validating game path, errors)
  • More Async (where it would actually be useful)
  • Theming
  • More User Settings!
  • Development Build Scripts