Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-lodestone-project/Lodestone
Create Minecraft bots with a powerful, stable, and high level Python API.
https://github.com/the-lodestone-project/Lodestone
api bot minecraft mineflayer mineflayer-bot open-source
Last synced: about 2 months ago
JSON representation
Create Minecraft bots with a powerful, stable, and high level Python API.
- Host: GitHub
- URL: https://github.com/the-lodestone-project/Lodestone
- Owner: the-lodestone-project
- License: mit
- Created: 2023-08-17T20:59:40.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-31T05:52:46.000Z (about 2 months ago)
- Last Synced: 2024-08-01T23:29:51.965Z (about 2 months ago)
- Topics: api, bot, minecraft, mineflayer, mineflayer-bot, open-source
- Language: Python
- Homepage: https://lodestone-documentation.vercel.app/
- Size: 16.3 MB
- Stars: 40
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
🤖 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](https://lodestone-documentation.vercel.app/ "docs") 
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:
```bash
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:
```python
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:
```bash
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:
```bash
python -m lodestone -u USERNAME -h HOST -p PORT -v VERSION
```
> [!IMPORTANT]
> `username` and `host` 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](https://github.com/Katzengott) | edelkatze |
## Roadmap
- [ ] Add config.json file
- [X] Add [click](https://github.com/pallets/click)
- [X] Change to use as Pip package for better use
- [X] 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
https://discord.com/invite/TcuuDR5P4j
## Credits
---
Screenshots:
[Dashboard](https://imgur.com/a/Hceiwhp)
[Settings](https://imgur.com/a/9p1YbtE)