Skip to content

A lightweight, source-distributed utilities library for both Unity and .NET Core projects.

License

MPL-2.0, Unknown licenses found

Licenses found

MPL-2.0
LICENSE
Unknown
LICENSE.meta
Notifications You must be signed in to change notification settings

SaltboxGames/SaltboxGames.Core

Repository files navigation

SaltboxGames.Core

A lightweight, source-distributed utilities library for both Unity and .NET Core projects. Includes optional support for MemoryPack serialization via conditional compilation.


📖 Documentation

See the full docs here:
👉 SaltboxGames.Core Documentation

📦 Installation

🎮 Unity

  1. install Nuget For Unity
  2. install Command Line Parser
  3. install zlinq
  4. install SaltboxGames.Core

🎮 (Via UPM)

"com.saltboxgames.core": "[email protected]:SaltboxGames/SaltboxGames.Core.git"

Add this to your project's Packages/manifest.json.


🎮 Unity (via Git Submodule)

git submodule add [email protected]:SaltboxGames/SaltboxGames.Core.git ./Packages/com.saltboxgames.core
  • Unity will automatically recognize this as an embedded package.
  • No .asmdef changes needed unless you want to add dependencies.

⚙️ .NET Core

  1. Add the library as a submodule:

    git submodule add [email protected]:SaltboxGames/SaltboxGames.Core.git SaltboxGames.Core
  2. Reference it in your consuming project's .csproj:

    <ProjectReference Include="SaltboxGames.Core/SaltboxGames.Core.csproj" />

🔧 Enabling MemoryPack Support (Optional)

SaltboxGames.Core can integrate with MemoryPack for fast, zero-allocation serialization. This support is opt-in via a build flag.


✅ For .NET Core Projects

To enable MemoryPack, create a file named Directory.Build.props at the root of your solution (alongside your .sln file):

<Project>
  <PropertyGroup>
    <EnableMemoryPack>true</EnableMemoryPack>
  </PropertyGroup>
</Project>

This will:

  • Define MEMORY_PACK
  • Add the MemoryPack NuGet package automatically

✅ For Unity Projects

  1. Install MemoryPack-Unity
  2. This will automatically define MEMORY_PACK

🙌 Credits

Built with ❤️ by SaltboxGames. Pull requests, issues, and feedback welcome!

About

A lightweight, source-distributed utilities library for both Unity and .NET Core projects.

Resources

License

MPL-2.0, Unknown licenses found

Licenses found

MPL-2.0
LICENSE
Unknown
LICENSE.meta

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages