helpy4/Minecraft-Console-Client
1
0
Fork 0
mirror of https://github.com/MCCTeam/Minecraft-Console-Client synced 2025-11-07 17:36:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[SKIP_DEPLOY] Add plugin-container

Browse source
This commit is contained in:
BruceChen 2022-11-04 12:04:57 +08:00
parent bbdf5a3699
commit 52b6372be6
38 changed files with 767 additions and 151 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/guide/creating-bots.md
View file

@ -8,7 +8,9 @@
## Notes
> **ℹ️ NOTE: For now this page contains only the bare basics of the Chat Bot API, enough of details to teach you how to make basic Chat Bots. For more details you need to take a look at the [ChatBot.cs](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Scripting/ChatBot.cs) and [Examples](#examples). This page will be improved in the future.**
::: tip
**For now this page contains only the bare basics of the Chat Bot API, enough of details to teach you how to make basic Chat Bots. For more details you need to take a look at the [ChatBot.cs](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Scripting/ChatBot.cs) and [Examples](#examples). This page will be improved in the future.**
:::
**Minecraft Console Client** has a rich C# API which allows you to create Chat Bots (effectively plugins) which can help you create complex automations which normal scripts may not be able to do.
@ -32,7 +34,9 @@ More in-depth:
This introduction assumes that you have the basic knowledge of C#.
> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably**
::: tip
**Here we will use terms Chat Bot and Script interchangeably**
:::
Create a new empty file and name it `ExampleChatBot.cs` in the same folder where you have your MCC installed.
@ -110,7 +114,9 @@ MCC.LoadBot(new YourChatBotClassNameHere());
**Script Metadata** section allows for including C# packages and libraries with: `//using <namespace>` and `/dll <dll name>`.
> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords**
::: tip
**Avoid adding whitespace between `//` and keywords**
:::
By the default the following packages are loaded:
@ -157,7 +163,9 @@ There are no required methods, everything is optional.
When the Chat Bot (Script) has been initialized for the first time the `Initialize` method will be called.
In it you can initialize variables, eg. Dictionaries, etc..
> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**.
::: tip
**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**
:::.
## Examples