You are viewing a potentially older version of this package. View all versions.
willis81808-Mache-0.0.2 icon

Mache

The Fundamental SoTF Modding Framework

Date uploaded 3 years ago
Version 0.0.2
Download link willis81808-Mache-0.0.2.zip
Downloads 327
Dependency string willis81808-Mache-0.0.2

This mod requires the following mods to function

BepInEx-BepInExPack_IL2CPP-6.0.667 icon
BepInEx-BepInExPack_IL2CPP

BepInEx pack for IL2CPP Unity games. Preconfigured and ready to use.

Preferred version: 6.0.667

README

Mache

Mache is a modding framework designed for Sons of the Forest. As a utility it provides support for modders, allowing simple creation of new game content and functions to tweak existing elements of the game. Mache provides access to a unified set of tools, menus, and actions that make the process of creating and implementing mods easier and more streamlined.

Usage

Press F1 to open the Mache mod menu

Modding API

Easily register your own menu action with Mache

Mache.RegisterMod(() => new ModDetails
{
	Name = "Example Mod",
	Id = "your.unique.mod.id",
	Version = "1.0.0",
	Description = "Lorem ipsum dolor sit amet...",
	OnMenuShow = () => Log("Player clicked the 'Open Settings' button for your mod")
});

Expanded Item Database

Easily access the IDs and data of all in-game items

ItemData meatData = GameItem.Meat.GetData();
int meatId = GameItem.Meat.GetId();

CHANGELOG

v0.2.0

  • Updated with forked version of UniverseLib to fix issues coming from UniverseLib.Input.CursorUnlocker

v0.1.4

  • Network events raised outside of a multiplayer game will now work as long as they target the sender

v0.1.3

  • Simplified the registration/raising of SimpleEvents further

v0.1.2

  • The following Mache overlay properties are now saved and restored on restart:
    • Overlay panel position
    • Overlay panel size
    • Last mod menu displayed

v0.1.1

  • esc key now closes Mache menu
  • Fixed issue with UniverseLib config preventing use of chat in multiplayer
  • Added methods for enabling/disabling the Mache menu and switching to specific mod details

v0.1.0

  • Improved dropdown component with configurable height
  • Bumped to minor version 1 so patch numbers will be more significant

v0.0.7

  • Added config option for changing the Mache Mod Menu toggle keybind

v0.0.6

  • Added functionality for mods to put UI elements directly into their Mache mod screen
  • Added helpful extensions for saving Vector2, Vector3, Vector4, and Rect values to BepInEx config
  • Added the MenuPanel::Builder to facilitate easier creation of simple UniverseLib based UI

v0.0.5

  • Added utilities for registering/raising custom networked events
  • Opening the Mache menu in-game will now also open the pause menu

v0.0.1

  • Initial release