From 0c6605462f4fc25f1c7d1c1cdb2d55d69da497c6 Mon Sep 17 00:00:00 2001 From: 7cc5c4f330d47060 Date: Tue, 27 Aug 2024 08:43:56 -0400 Subject: [PATCH] README improvements --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 8eac54d..8f6eb45 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # botvX -## What is it? - botvX 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) @@ -12,17 +10,17 @@ botvX is a Minecraft bot originally designed for [Kaboom](https://kaboom.pw/) an ## 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/botvX/. +2. Download the latest release, or alternatively, download the latest development version using `git clone https://code.chipmunk.land/7cc5c4f330d47060/botvX`. 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 adjust the settings to fit your needs. Do not forget to also create a secrets file. An example secrets file is provided as secret_example.json. Do not forget, if you use the secrets template, to change the keys (the ones in there are public after all!). -6. Run ./launch.sh (macOS, Linux, FreeBSD) or ./launch.cmd (Windows) to start a bot launcher, which will reload 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. +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 | | About the bot | +| about | [serverlist \| servers] | About the bot | | cb | \ | Run a command in a command block | | cloop | add , remove , list, clear | Manage command loops | | eval | \ | Run JavaScript code (must run through console)| @@ -30,10 +28,12 @@ botvX is a Minecraft bot originally designed for [Kaboom](https://kaboom.pw/) an | logoff | | Disconnect and reconnect the bot from a server | | netmsg | \ | Send a message to all servers the bot is connected to | | refill | | Refill core | +| restart | | Restart bot, closes when launched directly | | say | \ | Sends a message to chat | -| serverinfo | | Get system/bot info, similar to Kaboom's serverinfo command | -| stop | | Restart bot | +| settings | get, set | 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 | -| verify | | Check the hashing system | +| validate | | Check the hashing system |