{"id":13705541,"url":"https://github.com/the-lodestone-project/Lodestone","last_synced_at":"2025-05-05T16:33:12.854Z","repository":{"id":189019339,"uuid":"679886207","full_name":"the-lodestone-project/Lodestone","owner":"the-lodestone-project","description":"Create Minecraft bots with a powerful, stable, and high level Python API.","archived":false,"fork":false,"pushed_at":"2024-10-10T05:24:47.000Z","size":17041,"stargazers_count":53,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-04T20:59:54.619Z","etag":null,"topics":["api","bot","minecraft","mineflayer","mineflayer-bot","open-source"],"latest_commit_sha":null,"homepage":"https://lodestone-documentation.vercel.app/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/the-lodestone-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["SilkePilon","HellishBro"],"custom":"https://www.paypal.com/donate/?hosted_button_id=ZQJUTYLK7DSS2","patreon":"README_js"}},"created_at":"2023-08-17T20:59:40.000Z","updated_at":"2025-04-17T20:20:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"ae822905-c456-4a70-92ba-32afa83f9de7","html_url":"https://github.com/the-lodestone-project/Lodestone","commit_stats":null,"previous_names":["silkepilon/opendeliverybot","silkepilon/mineflayer.py","project-lodestone/lodestone","the-lodestone-project/lodestone","silkepilon/lodestone"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the-lodestone-project%2FLodestone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the-lodestone-project%2FLodestone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the-lodestone-project%2FLodestone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/the-lodestone-project%2FLodestone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/the-lodestone-project","download_url":"https://codeload.github.com/the-lodestone-project/Lodestone/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252534066,"owners_count":21763714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bot","minecraft","mineflayer","mineflayer-bot","open-source"],"created_at":"2024-08-02T22:00:43.206Z","updated_at":"2025-05-05T16:33:12.258Z","avatar_url":"https://github.com/the-lodestone-project.png","language":"Python","funding_links":["https://github.com/sponsors/SilkePilon","https://github.com/sponsors/HellishBro","https://www.paypal.com/donate/?hosted_button_id=ZQJUTYLK7DSS2","https://patreon.com/README_js"],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"\u003cfile-attachment-contents filename=\"README.md\"\u003e\n\n\u003ch1 align=\"center\"\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://github.com/SilkePilon/lodestone/\"\u003e\u003cimg src=\"assets/165C35D6-E412-4173-A37E-22EAB9108EAC.png\" alt=\"Lodestone\" width=\"250\"\u003e\u003c/a\u003e\n  \u003cbr\u003e\n\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003e🤖 Create Minecraft bots with a powerful, stable, and high level Python API \u003cimg src=\"https://minecraft.wiki/images/Invicon_Recovery_Compass.gif?c2f29\"\u003e\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"Node version\" src=\"https://img.shields.io/static/v1?label=node\u0026message=%20%3E=18.0.0\u0026logo=node.js\u0026color=2334D058\" /\u003e\n      \u003ca href=\"https://python.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Python-FFD43B?logo=python\u0026logoColor=blue\" alt=\"Python\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/reworkd/AgentGPT/blob/master/docs/README.zh-HANS.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/JavaScript-323330?logo=minecraft\u0026logoColor=F7DF1E\" alt=\"javascript\"\u003e\u003c/a\u003e\n  \u003ca href=\"soon!\"\u003e\u003cimg src=\"https://img.shields.io/badge/Discord-5865F2?logo=discord\u0026logoColor=white\" alt=\"Hungarian\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c!-- ![screenshot](https://raw.githubusercontent.com/SilkePilon/youdotcom/main/assets/images/YouDotCom.jpg) --\u003e\n\n## About \u003cimg src=\"/assets/items/upscaled/writable_book.png\" width=\"25\" height=\"25\"\u003e\n\nLodestone is an incredibly powerful and flexible framework for building Minecraft bots of all kinds.\nWhether 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.\nLet’s dive into how to get up and running with Lodestone.\n\n\n## Features\n\n* \u003cimg src=\"https://minecraft.wiki/images/ItemSprite_compass.png?2364d\"\u003e 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.\n* \u003cimg src=\"https://minecraft.wiki/images/EntitySprite_tamed-wolf.png?e90cb\"\u003e Entity knowledge and tracking.\n* \u003cimg src=\"https://minecraft.wiki/images/EnvSprite_non-renewable-resource.png?44294\"\u003e Block knowledge. You can query the world around you. Milliseconds to find any block.\n* \u003cimg src=\"https://minecraft.wiki/images/EnvSprite_sprint.png?e9341\"\u003e Physics and movement - handle all bounding boxes\n* \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_strength-revision-1.png?8da27\"\u003e Attacking entities and using vehicles.\n* \u003cimg src=\"https://minecraft.wiki/images/EnvSprite_two-by-two.png?56fdc\"\u003e Inventory management.\n* \u003cimg src=\"https://minecraft.wiki/images/BlockSprite_crafting-table.png?1ea45\"\u003e Crafting, chests, dispensers, enchantment tables.\n* \u003cimg src=\"https://minecraft.wiki/images/EnvSprite_item.png?89d23\"\u003e Digging and building.\n* \u003cimg src=\"https://minecraft.wiki/images/BlockSprite_brewing-stand.png?918de\"\u003e Miscellaneous stuff such as knowing your health and whether it is raining.\n* \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_strength-revision-1.png?8da27\"\u003e Activating blocks and using items.\n* \u003cimg src=\"https://minecraft.wiki/images/ItemSprite_oak-sign.png?e1d26\"\u003e Chat.\n* \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_particle-speed.png?0ed64\"\u003e Plugins for many servers.\n\n## Getting Started \u003cimg src=\"/assets/items/upscaled/iron_sword.png\" width=\"20\" height=\"20\"\u003e\n\n\u003e [!IMPORTANT]\n\u003e project lodestone is still in development and has some bugs.\n\nAll instalation instructons and documentation can be found [here](https://lodestone-documentation.vercel.app/ \"docs\") \u003cimg src=\"/assets/items/upscaled/arrow.png\" width=\"25\" height=\"25\"\u003e but here is the general idea.\n\n#### Installation and Setup\nThe first step is to install the Lodestone package using pip. It’s recommended to create a virtual environment first before installing:\n```bash\npython3 -m venv env\nsource env/bin/activate\npip install lodestone\n```\nWith 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:\n```python\nimport lodestone\nbot = lodestone.createBot(\n  host='localhost',\n  port=25565,  # set this to your own LAN port\n  username='MyAwesomeBot',\n  auth='microsoft' \n)\n```\nIn this example, we’re connecting to a local Minecraft server on localhost and using Microsoft authentication.\n\n##### Running and Logging In\nWith your bot created, run it using:\n```bash\npython bot.py\n```\nThe 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.\nLodestone provides multiple authentication options including Microsoft and Offline modes. See the docs for details.\n\n\n\n### Using the Lodestone CLI\n\nLodestone also offers an easy to use command line intercace (CLI). This allows you to use the basic functions of lodestone.\nthe CLI offers auto tab complete and has real time chat logs.\n\nTo use the CLI run the following command:\n```bash\npython -m lodestone -u USERNAME -h HOST -p PORT -v VERSION\n```\n\n\u003e [!IMPORTANT]\n\u003e `username` and `host` are required options. \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_particle-speed.png?0ed64\"\u003e\n\n\u003e [!WARNING]\n\u003e Do not share your Minecraft info to anyone. \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_strength-revision-1.png?8da27\"\u003e\n\n\u003cdetails open\u003e\n\u003csummary\u003eCommand line arguments\u003c/summary\u003e\n\u003cbr\u003e\n\nThe command line arguments available are:\n\n* `--username` or `-u`: The Minecraft username the bot will log into. \u003cimg src=\"https://minecraft.wiki/images/EnvSprite_emote.png?37574\"\u003e\n* `--host` or `-h`: The IP address or hostname of the Minecraft server. \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_strength-revision-1.png?8da27\"\u003e\n* `--port` or `-p`: The port number the Minecraft server is listening on. Default is 25565. \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_strength-revision-1.png?8da27\"\u003e\n* `--auth`: The authentication method your account requires (mojang/microsoft/cracked). Default is \"microsoft\". \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_strength-revision-1.png?8da27\"\u003e\n* `--version` or `-v` : Minecraft version to use when connecting to a server. Default is auto. \u003cimg src=\"https://minecraft.wiki/images/EffectSprite_strength-revision-1.png?8da27\"\u003e\n\n\u003c/details\u003e\n\n## Contributors \u003cimg src=\"https://minecraft.wiki/images/EnvSprite_heart.png?8a428\"\u003e\n| Name                | Helped With                               | GitHub   | Discord   |\n| --------------------- | ----------------------------------------- | ----------- | ----------- |\n| **Katzengott**            | fishing bot and cactus bot | [@Katzengott](https://github.com/Katzengott) | edelkatze |\n\n\n\n## Roadmap\n\n- [ ] Add config.json file\n- [X] Add [click](https://github.com/pallets/click)\n- [X] Change to use as Pip package for better use\n- [X] Add Discord integration\n- [ ] Add Custom code runner (a way for users to test their own bot code in a nice and simple way)\n\n## MineFlayer 🚀\n\nMineflayer is a complex library that allows you to control Minecraft accounts through a powerful, stable, and high-level JavaScript API\n\n## Discord\n\nhttps://discord.com/invite/TcuuDR5P4j\n\n## Credits\n\n\u003ca href=\"https://github.com/PrismarineJS/mineflayer\" target=\"_blank\"\u003eMineFlayer\u003c/a\u003e\n\n---\n\nScreenshots:\n[Dashboard](https://imgur.com/a/Hceiwhp)\n[Settings](https://imgur.com/a/9p1YbtE)\n\n\u003c/file-attachment-contents\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-lodestone-project%2FLodestone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-lodestone-project%2FLodestone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-lodestone-project%2FLodestone/lists"}