YaBoiAlex-MuckApi icon

MuckApi

A Api For Muck With Working Items And Commands

Last updated 2 years ago
Total downloads 4807
Total rating 5 
Categories Addons
Dependency string YaBoiAlex-MuckApi-1.0.7
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_Muck-5.4.1100 icon
BepInEx-BepInExPack_Muck

BepInEx pack for Muck. Preconfigured and ready to use.

Preferred version: 5.4.1100

README

Muck Api

A Working API for all things muck

Features

Commands

Custom Items

Add as a Dependency

then in your Main.cs define undeer

[BepInPlugin(GUID, MODNAME, VERSION)]  

add

[BepInDependency("MuckApiGithub_MuckApi")]  

Custom Items: How To Use

Create a unity asset bundle then drag it into your project then you can do this

MuckApi.Main.LoadAllItemsFromResoruce("asset_bundle_filename", Assembly.GetExecutingAssembly())

this creates an item for each scriptable object in that asset bundle

How To Create a Asset Bundle:

comming soon

Commands: How To Use

to use it create a method of what you want to run useing this template for your method

public static bool Template(string message)
{
  var MessageArgs = message.Substring(1).Split(' ');
  ChatBox Chat = ChatBox.Instance;
  //Code Goes Here
  return true;
}  

to add commands to be registered in your main.cs under Start() do the following

MuckApi.Main.AddChatCommand("<Command In Chat>", new Func<string, bool>(<Method>));

or

MuckApi.Main.AddChatCommand("<Command In Chat>", "<Command Description>", new Func<string, bool>(<Method>));