CUCoreLib

CUCoreLib

A definitive open-source modding library for Casualties: Unknown.

"awwww dang it @jimmy_king im not trusting you with my code again ;;!!!"

- Moffee, C:U game creator

This clearly means you should trust my library with your mod :)

What Is CUCoreLib?

CUCoreLib is an exhaustive shared modding library and documentation project for Casualties: Unknown, built for both beginners and veteran mod authors.

Instead of every mod reinventing the same systems over and over, CUCoreLib provides a common foundation, with documentation.

We have:

• []A human-written shared framework for building mods faster[/]

  []A safer compatibility layer for future modding work and multi-mod compatibility (it works with QoL and Multiplayer off the bat!)[/]

  []A very well documented API surface with examples and videos (cucorelib.jimmyking.dev)[/]

  []A open-source project intended to grow with community feedback and contributions[/]

  []Hot loading, so you don't have to close your game every time you want to update your mod (!!)[/]

  What Does It Provide?

  Core library features

  • []Helper functions and shared utility systems[/]

    []Publicized access to useful private game data[/]

    []Mod-compatible patch hooks[/]

    []Documentation through an external webapp with examples, references, and videos[/]

    []Makes modding much faster and streamlined, with hot reloading[/]

  In-game modular API support
  • []Custom items, liquids, containers, weapons, crafting materials, drops, and more[/]

    []Equipment[/]

    []Moodles and custom status effects[/]

    []Crafting and recipes[/]

    []Console commands[/]

    []Automatic locale and translation support[/]

    []Settings menu support[/]

    []Saving and persistent mod data[/]

    []Custom world entities, tiles, traps, liquids, and interactables[/]

    []Multiplayer API and helpers[/]

    []Custom minigame and animation support via assetbundle loading[/]

    []XML documentation and normal documentation[/]

    []General utility systems for mod authors[/]

    Why Use It?

    A lot of mods need the same basic foundation:

    • []Loading custom assets[/]

      []Registering items, liquids, recipes, and world content[/]

      []Saving mod data safely[/]

      []Patching game systems without exploding on updates[/]

      []Staying compatible with other mods[/]

      []Handling multiplayer-related integration[/]

      Without a shared library, every mod author ends up building their own version of the same systems. That makes mods harder to maintain, harder to update, more likely to conflict, and more annoying to extend later.

      CUCoreLib aims to become a common framework the modding scene can build on together.

      ! This library is fully open source and open to pull requests! !

      ---

      Documentation

      The documentation site is designed to help both new and experienced modders get productive quickly.

      [*]Click to open the live documentation website[/ur