GoldenGuy1000-gg1kommands_base icon

gg1kommands base

A library for adding commands (doesn't do anything by itself)'

Last updated 3 years ago
Total downloads 100628
Total rating 2 
Categories
Dependency string GoldenGuy1000-gg1kommands_base-1.4.0
Dependants 3 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

gg1kommands_base (Muck mod)

So basically just install this for extra functionality or whatever on other mods

Installation (manual)

If you are installing this manually, do the following

  1. Extract the archive into a folder. Do not extract into the game folder.
  2. Move the contents of plugins folder into <GameDirectory>\Bepinex\plugins.
  3. Run the game.

Development

Events

Whenever a new command is instantiated event Action<Command> addedCommand is called

Referencing

If you want to make commands for this first you'll want to reference it add this to your csproj:

<Reference Include="gg1kommands base"> <HintPath>$(GameDir)\BepInEx\plugins\gg1kommands base\gg1kommands base.dll</HintPath> <Private>False</Private> </Reference>

In your Main.cs file after [BepInPlugin(GUID, MODNAME, VERSION) add , BepInDependency(gg1kommands_base.Main.GUID, BepInDependency.DependencyFlags.(Soft/Hard)Dependency)]

Now at the top of your file add using gg1kommands_base

And finally make sure to add the dependency string of gg1kommands_base to the manifest.json

Adding a Command

To make a new command you'll need to instantiate the Command class

Command(Action<string[]> method, int lowerArgBound, int upperArgBound, params string[] aliases)

,,for the first argument pass your method (it must have a string array as one of the arguments),,

,,the second & third argument are how many extra arguments seperated by spaces can be put in (so for a range of 2-4 arguments you'd put in 2, 4, you can also just omit one if you have an exact amount of arguments in mind),,

,,put in as many 'aliases' as you want, they just basically are what you can type in to run the command (so maybe for a teleport command you'd do "tp", "teleport"),,