botvX_mjs/README.md

botvX

What is it?

botvX is a Minecraft bot originally designed for Kaboom 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

This is a fork from commit 4efbf43edb with support for using ECMAScript modules (import/export) rather than CommonJS modules (require/module.exports). All plugins have been converted to be ECMAScript modules, but the v11 API has not been finalized, and there will be API breaks before this version is released. Due to differences in how Node.js operates in these two modes, this version is not compatible with plugins, commands, etc. from version 10 without modifying them in some way, and as such, this branch has major version number 11.

This codebase will most likely not be used unless Node.js deprecates CommonJS.

How to install?

1. Install Node.js 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/.
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.

Command list

Name	Usage	Description
about		About the bot
cb	<command>	Run a command in a command block
cloop	add , remove , 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
say	<message>	Sends a message to chat
serverinfo		Get system/bot info, similar to Kaboom's serverinfo command
stop		Restart bot
template		Used in development, does nothing
tpr		Teleport to a random location
verify		Check the hashing system