alexprogrammerde/soulfire repository overview

⁠SoulFire

Advanced Minecraft Bot Tool. Deploy automated bots for server testing, automation, and development.

This repository only contains the CLI and server implementation. The official GUI client is in another repository⁠.

---

⁠✨ Are you looking for an advanced administration panel for your server?

EnderDash allows you to manage your existing Minecraft servers using an advanced dashboard by installing a single plugin, batteries included. Run commands (with tab completion), read logs, manage files, invite your whole team, manage players, Ocelot (AI Assistant), works with your existing Infrastructure/Panels and much more.

Check it out: https://enderdash.com⁠

---

⁠🚀 Features

• GUI (Multiple themes) & CLI
• Configurable options for every session like the number of bots, join delay and more
• Load and save profiles for quick access
• Support for online and offline mode servers
• Supports almost every Minecraft version⁠
• Use Microsoft (Credentials & Device Code supported) and Offline accounts for both Java Edition and Bedrock Edition
• Use HTTP, SOCKS4 and SOCKS5 proxies
• Multiple built-in plugins⁠ like AutoRespawn, AutoJump, ClientSettings and more
• Console command support
• A* Pathfinding (Diagonal moves, parkour, mining blocks, placing blocks)

⁠🖥 Installation

Follow the installation guide⁠ to install SoulFire.

The server bundles a headless Vulkan runtime and Mesa lavapipe for CPU rendering. No system Vulkan packages or display server are required. Installed compatible GPU drivers provide hardware acceleration. See native runtime packaging⁠ for supported platforms and build instructions. The Docker image includes lavapipe. On Debian or Ubuntu, install libvulkan1 and mesa-vulkan-drivers when running without a GPU driver. POV captures and inventory images render on demand without a native window. OpenGL is disabled. See renderer validation⁠ for the manual comparison tests.

⁠🍿 Version support

You can find an up-to-date list of supported versions in the documentation⁠.

⁠⌨ Commands

For a list of all available commands, look at the documentation⁠ or run help in the GUI or CLI.

⁠📻 Plugins

You can read about the SoulFire plugins in the documentation⁠.

⁠🗃 Import accounts and proxies

You can read about how to import accounts in the account documentation⁠ and how to import proxies in the proxy documentation⁠.

⁠🤿 Looking for proxies?

There are many websites that offer free proxies, but be careful as many of them are not reliable or secure.

Our recommended proxy providers are LegionProxy⁠ and Proxy-Seller⁠, who sponsor SoulFire.

For a full list of recommended providers, check out our Get Proxies⁠ page.

⁠💻 Command Line Usage

If you want to use the CLI of SoulFire, please refer to the CLI Mode Guide⁠.

⁠🧵 Demo

SoulFire has a built-in GUI for easy usage. Try a SoulFire demo yourself at the demo page⁠.

https://github.com/user-attachments/assets/6244d54c-a1e5-4467-a705-c929b9de2b57⁠

⁠✨ Nightly builds

You can download the latest development version of SoulFire through nightly.link⁠.

⁠🔧 Build from source

1. Install a JDK 25 and clone this repository.
2. Prepare the packaged native runtimes using the native runtime build instructions⁠.
3. Run ./gradlew build in the project directory. For a local build, select the prepared platforms with -PvulkanPlatforms=<platform>.
4. Get the JAR from client-launcher/build/libs or dedicated-launcher/build/libs.

The default build requires all six native runtime platforms. For environment setup, module locations, SDK generation, and tests, read the contribution guide⁠.

⁠👨‍💻 Developer API

SoulFire offers a Developer API to create your own plugins using the plugin API and mixins. SoulFire can include breaking changes. Pin your plugin to a SoulFire version, or update it when SoulFire changes.

To learn more about the Developer API, take a look at the official plugin example⁠.

SoulFire also includes TypeScript and Python SDKs⁠ for connecting over gRPC-Web, streaming bot events, issuing current per-bot actions, and provisioning a local dedicated server.

⁠🌈 Community

Feel free to join our Discord community server:

For setup and usage questions, read the support resources⁠. Report bugs and propose features through the issue forms⁠. Pull requests are welcome. Read the contribution guide⁠ and code of conduct⁠ before you start. Report vulnerabilities privately through the security policy⁠.

⁠🏅 Sponsors

⁠🌟 Star History

⁠