Home - Woospringbreak1/Luamod_Docs GitHub Wiki

BONELAB Lua Modding Framework - Pre-alpha Release 0.1

The BONELAB Lua Modding Framework is designed to make BoneLab modding faster, easier and more feature complete by allowing modders to write Lua scripts - these scripts allow for easy creation of complex logic. The framework integrates Moonsharp, a mature Lua interpreter for C#

The framework is designed with a minimalist approach — providing direct access to Unity and Bonelab, with only unsafe or potentially harmful classes excluded.

Embedded Lua code can be included in Pallets distributed via Mod.io, enabling seamless integration of complex logic.

Installation

Download and install MelonLoader v0.7 into BONELAB

Run bonelab, get to the menu then quit

Download the source .zip from the repo

image

Copy the contents of the "Bonelab Install Directory" folder into your Bonelab install folder (with BONELAB_Oculus_Windows64.exe for Occulus or BONELAB_Steam_Windows64.exe for Steam)

This will install the following code mods:

Usage

See the Examples page for practical usage demonstrations.

See the Basic Concepts page for information on the design of the framework

Security

See Security for details on how the framework prevents malicious code

License

The Bonelab Lua modding framework is released under GNU GPLv3. It is built on top of intellectual property owned by Stress Level Zero (SLZ), and nothing in this license is intended to affect or limit SLZ’s rights.

Contributions

This codebase is in deep pre-alpha, with little testing. The best way to contribute at present is to use the Framework, develop your own code and report bugs and issues encountered.