๐ค๐ฆ Deliver anything, anywere! powered by MineFlayer.
Project description
Open Delivery Bot ๐ฆ
๐ค๐ฆ Deliver anything, anywere! powered by MineFlayer.
About โข Key Features โข How To Use โข Install โข Credits โข License
About ๐ฌ
Welcome to the Open Delivery Bot project! This open-source initiative empowers users to deploy a self-hosted delivery bot, offering an array of advanced functionalities. Our command-line interface (CLI) or remote web GUI allows effortless control and management, ensuring a seamless experience. ๐ค
Open Delivery Bot shines with its dynamic features, including pathfinding and optimized elytra flight, accelerating your delivery processes for utmost efficiency. Say goodbye to manual intervention and embrace automation! ๐ฆ
Getting Started ๐
[!IMPORTANT] Some parts of the code are still in development and do not work!
๐ Local Setup
Here are step-by-step instructions on how to install and run the python script:
(1) Install Node.js ๐ข (2 simple steps)
- Download and install Node.js 18 from https://nodejs.org/en/
- Verify installation:
node -v
(2) Install Python ๐ (2 simple steps)
- Download and install Python 3 (if not already installed) from https://www.python.org/downloads/
- Verify installation:
python3 --version
(3) Install pip โฌ (2 simple steps)
- Install pip3 (if not already installed):
Mac/Linux:
sudo apt install python3-pip
Windows:
py -m ensurepip --default-pip
- Verify installation:
pip3 --version
(4) Clone ๐ป (2 simple steps)
- Clone this repository ๐ด
git clone https://github.com/SilkePilon/OpenDeliveryBot.git
- Navigate into the repo directory ๐
cd OpenDeliveryBot
(5) Install packages ๐ฆ (1 simple step)
- Use pip to install needed packages
pip install -r requirements.txt
(6) Config.json ๐ (1 step)
[!IMPORTANT] Not changing these settings will result in the bot not working. ๐
[!WARNING] Do not share this file to anyone as it may contain your Minecraft login details. ๐
How to change to config file
The settings you NEED to edit are:
Username
: The Minecraft Email the bot will log into (use a name and no password for a cracked account). ๐งPassword
: The password for your account (if not using cracked). ๐Host
: The IP address or hostname of the Minecraft server. ๐ฅPort
: The port number the Minecraft server is listening on. Default is 25565. โกAuth
: The authentication method your account requires (mojang/microsoft/cracked). Default is "microsoft". ๐Version
: Minecraft version to use when connecting to a server. Default is auto. ๐นCheckTimeoutInterval
: How often in milliseconds the bot checks if it is still logged into the server. Default is 600000 (10 minutes). โฑViewerPort
: The local port to run the viewer server on so you can visually see what the bot is doing. Default is 8000. ๐Goto
: The x, y, z coordinates for the bot to navigate to. Default is ["100", "100", "100"] (x=100, y=100, z=100). ๐บChestRange
: How close a chest must be to the bot for the bot to pathfind to it. Default is 100 blocks. ๐ฆInitChestType
: The type of chest for the bot to get items from. Default is "Chest". ๐InitChestCords
: The coordinates of the initial chest. Default is ["100", "100", "100"] (x=100, y=100, z=100). ๐InitItemsName
: The name of the item(s) to get from the initial chest. Default is "SchulkerBox". ๐InitItemsCount
: The number of items to place in the initial chest. Default is 1. ๐ขClientUsername
: The username for the client the delivery is made to. Default is "OpenDeliveryBot". ๐ค
[!NOTE] Setting
InitChestCords
to["0", "0", "0"]
will make the bot look for chest with the specified type in a 100 block radius. This can be helpful if the chest is moving a lot. Make sure to use a trapped chest as it's easier to find.
This is how the file looks like in its default state:
{
"Username": "OpenDeliveryBot",
"Password": "<PASSWORD>",
"Host": "127.0.0.1",
"Port": 25565,
"Auth": "microsoft",
"Version": "auto",
"CheckTimeoutInterval": 600000,
"ViewerPort": 8000,
"Goto": ["100", "100", "100"],
"ChestRage": 100,
"InitChestType": "chest",
"InitChestCords": ["100", "100", "100"],
"InitItemsName": "SchulkerBox",
"InitItemsCount": 1,
"ClientUsername": "OpenDeliveryBot"
}
(6) Run the bot ๐ค (1 simple step)
[!IMPORTANT] If the console gets spammed with random data, try changing the version from false to a version you know is supported by the server.
- Run the bot
python3 main.py
Enjoy automated deliveries! ๐
๐ GitHub Codespaces
[!IMPORTANT] If the console gets spammed with random data, try changing the version from false to a version you know is supported by the server.
- Copy this code to you clipboard and run it once the terminal is available
./codespaces.sh
- Open GitHub CodeSpaces below
Roadmap
- Add config.json file
- Add click
- Change to use as Pip package for better use
- Add Discord integration to remote control the bot in a channel
MineFlayer ๐
Mineflayer is a complex library that allows you to control Minecraft accounts through a powerful, stable, and high-level JavaScript API
Discord
SOON!
Credits
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for opendeliverybot-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e21761cde903fb2f607b1d948a5102b0a718e84a10d50440587164e71016cb6 |
|
MD5 | f15f7ba195718664d5658a5b5310a995 |
|
BLAKE2b-256 | 7188db7396a2b48aa84644681512a618c5fff01a7804b486d8f327c42dc3a671 |