<img align="right" src="https://github.com/soulfiremc-com/SoulFire/blob/main/mod/src/main/resources/icons/icon.png?raw=true" height="150" width="150">

[![discord](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-singular_vector.svg)](https://discord.gg/vHgRd6YZmH) [![kofi](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/kofi-singular_vector.svg)](https://ko-fi.com/alexprogrammerde)

# 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](https://github.com/soulfiremc-com/SoulFireClient).

> [!WARNING]
> This tool should only be used on servers you own or have explicit permission to test. Ensure your hosting provider
> allows automated bot testing. If you use this software without authorization, you make yourself (or your
> legal guardians) liable; the developers of SoulFire are not responsible for your own actions.

---

<img align="right" src="https://enderdash.com/logo.png" height="150" width="150">

### ✨ 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](https://enderdash.com/?utm_source=github&utm_medium=readme&utm_campaign=soulfire)

---

## 🚀 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](#-version-support)
* 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](#-plugins) like `AutoRespawn`, `AutoJump`, `ClientSettings` and more
* Console command support
* A* Pathfinding (Diagonal moves, parkour, mining blocks, placing blocks)

## 🖥 Installation

> [!TIP]
> Want to check out how SoulFire looks before installing it? Take a look at the official [demo page](https://demo.soulfiremc.com).

For installing SoulFire, please refer to the [installation guide](https://soulfiremc.com/docs/installation).

## 🍿 Version support

You can find an up-to-date list of supported versions in
the [documentation](https://soulfiremc.com/docs/usage/versions).

## ⌨ Commands

For a list of all available commands, look at the [documentation](https://soulfiremc.com/docs/usage/commands)
or run `help` in the GUI or CLI.

## 📻 Plugins

You can read about the SoulFire plugins in the [documentation](https://soulfiremc.com/docs/usage/plugins).

## 🗃 Import accounts and proxies

You can read about how to import accounts in the [account documentation](https://soulfiremc.com/docs/usage/accounts) and
how to import proxies in the [proxy documentation](https://soulfiremc.com/docs/usage/proxies).

## 🤿 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](https://legionproxy.io/?utm_source=github&utm_campaign=soulfire) and
[Proxy-Seller](https://proxy-seller.com/?partner=GRJY71PA3XWPPP&utm_source=get-proxies&utm_campaign=soulfire), who sponsor SoulFire.

For a full list of recommended providers, check out our [Get Proxies](https://soulfiremc.com/get-proxies) page.

## 💻 Command Line Usage

If you want to use the CLI of SoulFire, please refer to the [CLI Mode Guide](https://soulfiremc.com/docs/guides/cli-mode).

## 🧵 Demo

SoulFire has a built-in GUI for easy usage. Try a SoulFire demo yourself at the [demo page](https://demo.soulfiremc.com).

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](https://nightly.link/soulfiremc-com/SoulFire/workflows/build/main).

## 🔧 Build from source

1. Install Java 25+
2. Download the latest source code from GitHub
3. Run `./gradlew build` in the project directory
4. Get the jar file from `client-launcher/build/libs` or `dedicated-launcher/build/libs`

## 👨‍💻 Developer API

SoulFire offers a Developer API to create your own plugins using the plugin API and mixins.
The software may regularly have breaking changes, so you'll have to stick to a version of SoulFire or update your plugin
regularly.

To learn more about the Developer API, take a look at the
official [plugin example](https://github.com/soulfiremc-com/SoulFirePluginExample).

SoulFire also includes [TypeScript and Python SDKs](sdk/README.md) 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:

[![Discord Banner](https://discord.com/api/guilds/739784741124833301/widget.png?style=banner2)](https://discord.gg/vHgRd6YZmH)

This project is in active development, so if you have any feature requests or issues, please submit them here on GitHub.
PRs are welcome, too.

## 🏅 Sponsors

<table>
 <tbody>
  <tr>
   <td align="center"><img alt="[SignPath]" src="https://avatars.githubusercontent.com/u/34448643" height="30"/></td>
   <td>Free code signing on Windows provided by <a href="https://signpath.io/?utm_source=foundation&utm_medium=github&utm_campaign=soulfire">SignPath.io</a>, certificate by <a href="https://signpath.org/?utm_source=foundation&utm_medium=github&utm_campaign=soulfire">SignPath Foundation</a></td>
  </tr>
 </tbody>
</table>

## 🌟 Star History

<a href="https://star-history.com/#soulfiremc-com/SoulFire&Date">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=soulfiremc-com/SoulFire&type=Date&theme=dark" />
    <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=soulfiremc-com/SoulFire&type=Date" />
    <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=soulfiremc-com/SoulFire&type=Date" />
  </picture>
</a>
