mirror of
https://github.com/MCCTeam/Minecraft-Console-Client
synced 2025-10-14 21:22:49 +00:00
[skip ci] Updated the Documentation
Updated the Documentation
This commit is contained in:
commit
a113dc8430
3 changed files with 3226 additions and 1 deletions
3111
docs/guide/WebSocketChatBot.md
Normal file
3111
docs/guide/WebSocketChatBot.md
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -2573,3 +2573,72 @@ redirectFrom:
|
|||
- **Type:** `boolean`
|
||||
|
||||
- **Default:** `true`
|
||||
|
||||
|
||||
## WebSocket Chat Bot
|
||||
|
||||
- **Description:**
|
||||
|
||||
This chat bot allows you to remotely execute commands on the MCC and make Chat Bots in other programming languages over Web Socket.
|
||||
|
||||
You can make your own library to do this, or use the reference implementation one which has been writen in TypeScript/JavaScript: [MCC.js](https://github.com/milutinke/MCC.js)
|
||||
|
||||
If you want to write your own library, you can follow this guide on the protocol specification and avaliable events and commands: [WebSocket Chat Bot Guide](WebSocketChatBot.md)
|
||||
|
||||
- **Settings:**
|
||||
|
||||
**Section:** **`ChatBot.WebSocketBot`**
|
||||
|
||||
#### `Enabled`
|
||||
|
||||
- **Description:**
|
||||
|
||||
This setting specifies if the Web Socket chat bot is enabled.
|
||||
|
||||
- **Available values:** `true` and `false`.
|
||||
|
||||
- **Type:** `boolean`
|
||||
|
||||
- **Default:** `false`
|
||||
|
||||
#### `Ip`
|
||||
|
||||
- **Description:**
|
||||
|
||||
The IP address that Websocket server will be bound to.
|
||||
|
||||
- **Type:** `string`
|
||||
|
||||
- **Default:** `127.0.0.1` (localhost)
|
||||
|
||||
#### `Port`
|
||||
|
||||
- **Description:**
|
||||
|
||||
The Port that Websocket server will be bound to.
|
||||
|
||||
- **Type:** `number`
|
||||
|
||||
- **Default:** `8043`
|
||||
|
||||
#### `Password`
|
||||
|
||||
- **Description:**
|
||||
|
||||
A password that will be used to authenticate on thw Websocket server
|
||||
|
||||
**It is recommended to change the default password and to set a strong one**
|
||||
|
||||
- **Type:** `string`
|
||||
|
||||
- **Default:** `wspass12345`
|
||||
|
||||
#### `DebugMode`
|
||||
|
||||
- **Description:**
|
||||
|
||||
This setting is for developers who are developing a library that uses this chat bot to remotely execute procedures/commands/functions.
|
||||
|
||||
- **Type:** `boolean`
|
||||
|
||||
- **Default:** `false`
|
||||
|
|
@ -890,6 +890,51 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q
|
|||
/move center
|
||||
```
|
||||
|
||||
### `nameitem`
|
||||
|
||||
- **Description:**
|
||||
|
||||
This command allows you to name an item when you have an Anvil inventory open and an item in the first slot (slot number 0),
|
||||
|
||||
After you place an item in the first slot of the anvil, use this command, and then do a click on the slot 2 to get an item from the anvil, then do a click on an empty slot in your inventory.
|
||||
|
||||
- **Usage:**
|
||||
|
||||
```
|
||||
/nameitem <name of the item>
|
||||
```
|
||||
|
||||
- **Example:**
|
||||
|
||||
```
|
||||
/nameitem My super duper sword 2000
|
||||
```
|
||||
|
||||
- **Full Example with anvil:**
|
||||
|
||||
```
|
||||
# Open an anvil
|
||||
/useblock 12 74 321
|
||||
|
||||
# Click on an axe in slot 12
|
||||
/inventory container click 12
|
||||
|
||||
# Put an axe to the slot 0 in anvil
|
||||
/inventory container click 0
|
||||
|
||||
# Set the new name
|
||||
/nameitem My fancy axe
|
||||
|
||||
# Click on the axe in slot 2 in the anvil
|
||||
/inventory container click 2
|
||||
|
||||
# Put the axe back in your inventory in slot 12
|
||||
/inventory container click 12
|
||||
|
||||
# Close the anvil
|
||||
/inventory container close
|
||||
```
|
||||
|
||||
### `look`
|
||||
|
||||
- **Description:**
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue