Home

MarrowSDK

Welcome to the MarrowSDK Wiki. This is a public resource containing usage documentation for the MarrowSDK.

How to create a Mod

• Requirements
• Project Setup
• Creating a Pallet / Crates
  • Spawnable Crate - Spawn vanilla Bonelab items with the Bonelab Spawnable Pallet, spawn custom items into levels
  • Avatar Crate - Create and play as a custom avatar
  • Level Crate - Design a custom Bonelab level
• GameObject Workflow
• Pallet Packing / Mod Installation
• Mod Repositories
• Developer Mode
• SplineJoint
• UltEvents

Requirements

• Unity Version 2021.3.5f1
  • Only SLZ-URP compatible shaders will render properly
• Basic Unity Knowledge

Project Setup

Watch a step-by-step MarrowSDK Project Setup Guide on YouTube or follow the written guide below.

1. Ensure Git is installed before launching Unity. You must log out of Windows or reboot your PC after installing Git as Unity uses the Windows System path to locate the Git installation.
2. If you already have Unity Hub installed (recommended), you can quickly install the correct Unity version, 2021.3.5f1, by copying the following into a browser: unityhub://2021.3.5f1/40eb3a945986. The Unity Hub is recommended to help manage different versions of Unity and multiple projects. Otherwise, download Unity 2021.3.5f1 manually from the Archives.
3. When installing Unity 2021.3.5f1, be sure to include the following modules: Under Platforms, select Android Build Support and it's sub-items, Android SDK & NDK Tools and the OpenJDK. Lower down the list, add Windows Build Support (IL2CPP).

4. Create a new 3D (URP) project for your mod.

5. If building for Quest 2, select File → Build Settings → Android → Switch Platform

6. Import the three required Packages using the Package Manager. If this is the first time using Unity's Add package from git URL... feature, the Windows firewall may prompt to allow Git.

   1. Window → Package Manager. In the upper-left corner, Select + → Add package from git URL... for each of the following links:
      https://github.com/StressLevelZero/Custom-RenderPipelineCore.git#Bonelab
      https://github.com/StressLevelZero/Custom-URP.git#Bonelab
      https://github.com/StressLevelZero/MarrowSDK.git

   It is suggested to right-click and copy each link to avoid mistakenly including any leading/trailing spaces. If you do select, copy and paste the links, be very careful to avoid selecting any leading or trailing spaces as the package install will error.

   Each package will have an Update button once installed that can be used to bring the package to its latest version, as needed. If the Update button is not visible, re-adding the package from the git URL will act as an upgrade.

7. Once installed, select Stress Level Zero → Void Tools → Validate Project Settings

8. In the Validation window, click the Fix All button.

License

MarrowSDK License