Skip to content

A pretty one-stop-shop for The Coffin of Andy and Leyley modding! πŸ’šπŸ©·

License

Notifications You must be signed in to change notification settings

kleineluka/burial

Repository files navigation

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 TCOAAL mod players, mod creators, content creators and data miners~ πŸ…

  • 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), and switch mods easily with a profile system.
  • 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, 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 🩸

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

  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 presents a one-click solution for installing mods in the Mod Manager πŸ“¦ tab. These mods are primarily sourced from the Llamawa.re Mod Depository, but there is a curated foreign.json list in the API to add non-Llamawa.re mods to the Mod Browser πŸ•ΉοΈ tab. Burial also supports installing mods from many third-party websites directly through URL. Currently, this includes GameBanana, Github, hosted zip files, and hosted rar files. Burial is not associated with any mods, hosted on any platform, and is simply a mod manager. Please only download mods that you trust.

Please note: Burial takes multiple steps when installing mods to ensure a smooth process - this includes checking for dangerous files and converting to the Tomb modloader. There are a number of formats supported for the best flexibility. For the best experience, make sure your mod has a Tomb-compatible version and don't include any dangerous files (like .exe's) in your mod. Mods hosted on the Llamwa.re Mod Depository are already Tomb-compatible and are loosely vetted each update. I suggest this site! ^_^

Want your mod featured in Burial? Submit it to the Llamawa.re Mod Depository here! If you want your modpack featured in Burial, please fork this repo with an updated modpacks.json! If you are not the creator of the mod, or your mod is not Tomb-compatible, please fork with an updated foreign.json (or get the mod author to submit to the depository and/or convert to Tomb!). If you are a mod creator (or tool creator) and want to work directly with me and/or Burial in any capacity, please add me on Discord: kleineluka~

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..)

  • Language Support
  • Steam Deck / Linux Improvements (high priority)
  • Better Folder & File Dialog Handling
  • Easier Save Editor
  • Cleanup (Code, UI, Responsiveness, Code Warnings, Var Ownership, Structure, JS -> Rust, Logging, Async I/O)
  • Self Updating
  • One-Click GameBanana Installation
  • Symbolic Linking (for Profiles)
  • Disk Space Awareness
  • Mod Compatability Checking
  • 7z, TAR Support (where ZIP/RAR is, low priority)
  • Tauri V2 Migration (low priority)
  • NexusMods, Itch.Io Support (low priority)
  • Game Instances (Profiles)
  • More Tooltips
  • Theming System
  • Settings System
  • Development Build Scripts

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!