owobot/README.md

# owobot

owobot is a Minecraft bot originally designed for [Kaboom](https://kaboom.pw/) and its clones. It has many of the features that you would expect in a modern Kaboom bot:

- commands (obviously)
- a self care system
- a command core, to run commands quickly
- a hashing system, to enable trusted users to securely run certain commands in chat

## How to install?

1. Install [Node.js](https://nodejs.org/) for your operating system.
2. Download the latest release, or alternatively, download the latest development version using `git clone https://code.chipmunk.land/7cc5c4f330d47060/owobot`.
3. Extract the files if necessary.
4. Run `npm install` in the bot's directory. If it doesn't work, try using the Node.js command prompt, or adding Node.js to your PATH.
5. Copy `settings_example.json` to `settings.json` and `secret_example.json` to `secret.json`, and adjust the settings to fit your needs. Change the example keys in secret.json as well. 
6. Run ./launch.sh (macOS, Linux, FreeBSD) or ./launch.cmd (Windows). This will start a bot launcher, which will restart the bot when the process closes. Alternatively, you can run `node index.js` to start the bot only once (it will still rejoin when kicked). If it displays an error saying `node` is not a command, please make sure Node.js is on your PATH.

## Command list

| Name | Usage | Description |
|-|-|-|
| about | [serverlist \| servers \| server] | About the bot. May also show system information or a list of connected servers. |
| cb | \<command\> | Run a command in a command block |
| cloop | add <rate> <command>, remove <index>, list, clear | Manage command loops |
| eval | \<code\> | Run JavaScript code (must run through console)|
| help | [cmd] | Shows command help |
| logoff | | Disconnect and reconnect the bot from a server |
| netmsg | \<message\> | Send a message to all servers the bot is connected to |
| refill | | Refill core |
| restart | | Restart bot, closes when launched directly |
| say | \<message\> | Sends a message to chat |
| settings | get, set <key> <value> | Set your user preferences |
| stop | | Close bot |
| template | | Used in development, does nothing |
| test | | Debug command for the chat parser |
| tpr | | Teleport to a random location |
| validate | | Check the hashing system |
Update branding If it causes problems, botvX 2024-09-08 22:04:10 -04:00			`# owobot`
omagad!!!! poco!!!! POCO ringtone 2024-07-27 02:39:18 -04:00
Update branding If it causes problems, botvX 2024-09-08 22:04:10 -04:00			`owobot is a Minecraft bot originally designed for [Kaboom](https://kaboom.pw/) and its clones. It has many of the features that you would expect in a modern Kaboom bot:`
71 unstaged files 2024-08-12 05:13:32 -04:00
			`- commands (obviously)`
			`- a self care system`
			`- a command core, to run commands quickly`
			`- a hashing system, to enable trusted users to securely run certain commands in chat`

			`## How to install?`

			`1. Install [Node.js](https://nodejs.org/) for your operating system.`
Update branding If it causes problems, botvX 2024-09-08 22:04:10 -04:00			2. Download the latest release, or alternatively, download the latest development version using `git clone https://code.chipmunk.land/7cc5c4f330d47060/owobot`.
71 unstaged files 2024-08-12 05:13:32 -04:00			`3. Extract the files if necessary.`
README improvements 2024-08-27 08:43:56 -04:00			4. Run `npm install` in the bot's directory. If it doesn't work, try using the Node.js command prompt, or adding Node.js to your PATH.
			5. Copy `settings_example.json` to `settings.json` and `secret_example.json` to `secret.json`, and adjust the settings to fit your needs. Change the example keys in secret.json as well.
			6. Run ./launch.sh (macOS, Linux, FreeBSD) or ./launch.cmd (Windows). This will start a bot launcher, which will restart the bot when the process closes. Alternatively, you can run `node index.js` to start the bot only once (it will still rejoin when kicked). If it displays an error saying `node` is not a command, please make sure Node.js is on your PATH.
71 unstaged files 2024-08-12 05:13:32 -04:00
			`## Command list`

			`\| Name \| Usage \| Description \|`
			`\|-\|-\|-\|`
Readme fix 2024-08-28 23:08:00 -04:00			`\| about \| [serverlist \\| servers \\| server] \| About the bot. May also show system information or a list of connected servers. \|`
71 unstaged files 2024-08-12 05:13:32 -04:00			`\| cb \| \<command\> \| Run a command in a command block \|`
			`\| cloop \| add <rate> <command>, remove <index>, list, clear \| Manage command loops \|`
			`\| eval \| \<code\> \| Run JavaScript code (must run through console)\|`
			`\| help \| [cmd] \| Shows command help \|`
			`\| logoff \| \| Disconnect and reconnect the bot from a server \|`
			`\| netmsg \| \<message\> \| Send a message to all servers the bot is connected to \|`
			`\| refill \| \| Refill core \|`
README improvements 2024-08-27 08:43:56 -04:00			`\| restart \| \| Restart bot, closes when launched directly \|`
71 unstaged files 2024-08-12 05:13:32 -04:00			`\| say \| \<message\> \| Sends a message to chat \|`
README improvements 2024-08-27 08:43:56 -04:00			`\| settings \| get, set <key> <value> \| Set your user preferences \|`
			`\| stop \| \| Close bot \|`
71 unstaged files 2024-08-12 05:13:32 -04:00			`\| template \| \| Used in development, does nothing \|`
README improvements 2024-08-27 08:43:56 -04:00			`\| test \| \| Debug command for the chat parser \|`
71 unstaged files 2024-08-12 05:13:32 -04:00			`\| tpr \| \| Teleport to a random location \|`
README improvements 2024-08-27 08:43:56 -04:00			`\| validate \| \| Check the hashing system \|`
71 unstaged files 2024-08-12 05:13:32 -04:00