🤖📦 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) pip check ⏬
- Install pip3 (if not already installed):
Mac/Linux:
sudo apt install python3-pip
Windows:
py -m ensurepip --default-pip
(4) Install package 💻
To install the package use the following command:
pip install -U opendeliverybot
(5) Run! 💻
To run the bot simply use the following command:
python -m opendeliverybot
(6) Arguments & Config 📄
[!IMPORTANT] Not changing some of these settings will result in the bot not working. 🛑
[!WARNING] Do not share your Minecraft info to anyone. 🔒
How to use the arguments
The command line arguments available 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. 🕹--check_timeout
: How often in milliseconds the bot checks if it is still logged into the server. Default is 600000 (10 minutes). ⏱--viewer_port
: 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). 🗺--chest_range
: How close a chest must be to the bot for the bot to pathfind to it. Default is 100 blocks. 📦--init_chest_type
: The type of chest for the bot to get items from. Default is "Chest". 🗄--init_chest_cords
: The coordinates of the initial chest. Default is ["100", "100", "100"] (x=100, y=100, z=100). 📍--init_items_name
: The name of the item(s) to get from the initial chest. Default is "SchulkerBox". 🎒--init_items_count
: The number of items to place in the initial chest. Default is 1. 🔢--recipient_username
: The username for the client the delivery is made to. Default is "OpenDeliveryBot". 👤--quit_on_low_health
: Disconect the bot if the bot is on low health. Default is "True". 👤--low_health_threashold
: How low the health must be for the bot to quit. Default is "10". 👤--armor_equip
: If the bot needs to equip all available armor. Default is "True". 👤
[!NOTE] Setting
init_chest_cords
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.
🚀 GitHub Codespaces (run the bot in the cloud)
[!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
python -m opendeliverybot
- 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
- Add plugin support
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.2.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11ed9ce1f83422d3329326f4f860d067aa9306e35b040e192bd40d4576b89b81 |
|
MD5 | b490eb0ceec4529f750a2742f850a454 |
|
BLAKE2b-256 | 62b05738fa6ac3f44e12b527cdac9ebf3a37583d76f2f44532e2f41907edf4e4 |