notnotnotswipez / marrow-extendedsdk-maintained

Fork Info

This is a new repository which will be maintained for the forseeable future.

Info

This repository allows the extension of the BONELAB Marrow SDK, allowing you to create custom guns and other types of items not yet supported by the Marrow SDK.

One of the major objectives of this repo, is to remove incentives to decompile the game, through strategic inclusion of assets which aren't useful elsewhere, and thorough documentation of what's possible.

How to Install

Install Git and Restart Unity / Unity Hub if they are open.

Begin installing the MarrowSDK by following the original instructions at https://github.com/StressLevelZero/MarrowSDK/wiki/ProjectSetup.

Important

DO NOT INSTALL THE SLZ MARROWSDK PACKAGE AFTER ADDING THE SCOPED REGISTRY

After you've added the scoped registry, go to the top left of the Package Manager and add a git URL. The git URL you should add is

https://github.com/notnotnotswipez/MarrowSDKExt.git

If you've done everything correctly, everything should install properly, including SLZ's URP.

After installation is complete and the Extended Marrow SDK package is listed as installed, download this repository from the green dropdown arrow at the top of this page.

Extract the contents of the zip into your project's Assets folder.

This repo contains DUMMY scripts. Which are scripts that are not functional and contain no code. They simply get replaced with their ingame equivalents upon being loaded.

IF YOU WOULD LIKE TO PR SOMETHING TO THIS REPO PLEASE FOLLOW THESE GUIDELINES:

Do not PR any FUNCTIONAL/NON DUMMY scripts that come from paid asset packs/utilities. Dummy scripts are fine. Functional and FREE open source/public scripts are fine.

Do not PR any art that must be paid for or was paid for by someone. This includes assets ripped directly from Bonelab (PRs containing direct Bonelab assets will not be accepted). Only free assets or assets personally made and granted free open access by the creator are allowed. (This keeps things like the examples usable with no worry about copyright)