🤖 Create Minecraft bots with a powerful, stable, and high level Python API.
Project description
🤖 Create Minecraft bots with a powerful, stable, and high level Python API
About
Lodestone is an incredibly powerful and flexible framework for building Minecraft bots of all kinds. Whether you’re new to Minecraft bot development or a seasoned pro, Lodestone provides all the tools you need to bring your bot ideas to life. Let’s dive into how to get up and running with Lodestone.
Features
- Supports Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19 and 1.20.1.
- Entity knowledge and tracking.
- Block knowledge. You can query the world around you. Milliseconds to find any block.
- Physics and movement - handle all bounding boxes
- Attacking entities and using vehicles.
- Inventory management.
- Crafting, chests, dispensers, enchantment tables.
- Digging and building.
- Miscellaneous stuff such as knowing your health and whether it is raining.
- Activating blocks and using items.
- Chat.
- Plugins for many servers.
Getting Started
[!IMPORTANT] project lodestone is still in development and has some bugs.
All instalation instructons and documentation can be found here but here is the general idea.
Installation and Setup
The first step is to install the Lodestone package using pip. It’s recommended to create a virtual environment first before installing:
python3 -m venv env
source env/bin/activate
pip install lodestone
With Lodestone installed, create a bot.py file to initialize your bot. This is where you’ll configure your bot’s username, authentication method, and other options:
import lodestone
bot = lodestone.createBot(
host='localhost',
port=25565, # set this to your own LAN port
username='MyAwesomeBot',
auth='microsoft'
)
In this example, we’re connecting to a local Minecraft server on localhost and using Microsoft authentication.
Running and Logging In
With your bot created, run it using:
python bot.py
The first time you run your bot, Lodestone will prompt you to log in using the authentication method you configured. Follow the login prompts to authenticate your bot and connect it to the Minecraft server. Lodestone provides multiple authentication options including Microsoft and Offline modes. See the docs for details.
Using the Lodestone CLI
Lodestone also offers an easy to use command line intercace (CLI). This allows you to use the basic functions of lodestone. the CLI offers auto tab complete and has real time chat logs.
To use the CLI run the following command:
python -m lodestone -u USERNAME -h HOST -p PORT -v VERSION
[!IMPORTANT]
username
andhost
are required options.
[!WARNING] Do not share your Minecraft info to anyone.
Command line arguments
The command line arguments available are:
--username
or-u
: The Minecraft username the bot will log into.--host
or-h
: The IP address or hostname of the Minecraft server.--port
or-p
: 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
or-v
: Minecraft version to use when connecting to a server. Default is auto.
Contributors
Name | Helped With | GitHub | Discord |
---|---|---|---|
Katzengott | fishing bot and cactus bot | @Katzengott | edelkatze |
Roadmap
- Add config.json file
- Add click
- Change to use as Pip package for better use
- Add Discord integration
- Add Custom code runner (a way for users to test their own bot code in a nice and simple way)
MineFlayer 🚀
Mineflayer is a complex library that allows you to control Minecraft accounts through a powerful, stable, and high-level JavaScript API
Discord
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
File details
Details for the file lodestone-0.1.11.tar.gz
.
File metadata
- Download URL: lodestone-0.1.11.tar.gz
- Upload date:
- Size: 30.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | becd5d059a74ffb3c0a9ff74587521a24b7ae3e06bdddeaf95016869d67f206b |
|
MD5 | 7d142e484e218b882ad58be3f0acc4ff |
|
BLAKE2b-256 | b3bb83fa8713d6d0d9409e3d2178ae920628a0a4eb1e9820cc3d17a7652b8fdd |
File details
Details for the file lodestone-0.1.11-py3-none-any.whl
.
File metadata
- Download URL: lodestone-0.1.11-py3-none-any.whl
- Upload date:
- Size: 31.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83897a3dbdac313811c6d794a74a5703f2d617fc125b8593a6abed57a8bb5a57 |
|
MD5 | 47ce3590909e01cfa6b3d47802905cd4 |
|
BLAKE2b-256 | a456834b19b35c5e655bd7d6f8ac0dcacde7ca047536fef5bc758f2cc7a77a9c |