Slimefun United

---

---

Warning

This project is still under heavy development and only development/alpha builds are available for now. You should NOT use it on your server! If you decide to use it anyway, make frequent back-ups!

A modern and organised continuation of Slimefun's legacy with full support for community translations and add-ons.

Slimefun is a plugin that aims to provide a modding-like experience. It offers everything you can imagine, from jetpacks to magic altars!

Slimefun allows every player to decide whether to develop in magic or technology. From wands to nuclear reactors, we have it all. In addition, we also have magic altars, energy networks, and even item transportation systems.

This project started in 2013 and is still evolving today. It has grown from a small independent plugin to a community with thousands of participants and hundreds of contributors. Currently, Slimefun has added more than 500 new items/crafting recipes (Learn about the history of Slimefun).

At the same time, Slimefun also has a wide variety of addon plugins to choose from!
Check out the Addon List to find the addons you want!

Download SlimeGlue to ensure compatibility between Slimefun United and other protection plugins

ℹ️ About this project

This project is focused on bringing all the best of every Slimefun fork and the official, discontinued version together, while also offering full localisation support, simple release cycle, frequent updates, bug fixes and much more.

This project treats the following Slimefun forks as its upstreams:

• Slimefun Gugu Project
• Craft233MC's Folia-oriented fork
• SaanPrasanna's fork
• Slimefun Lab's fork - repo not available anymore, but you can check out our archive

Note: Please report issues specific to this project here in the issues tab.

📌 Roadmap

The full development roadmap, including storage migration, localization, and module system plans, is available here:

➡️ ROADMAP.md

🗺️ Navigation

• Download Slimefun United
• Compatibility
• Discord Server
• Bug Reports
• Old Official Wiki
• Old official FAQ

---

💾 Downloading Slimefun United

(See also: How to install Slimefun)

Here are the differences between the two types of versions:

	Development (alpha) builds	Releases
Minecraft Version	🎮 1.19.X - 1.21.11	🎮 1.19.X - 1.21.11
Java Version	💻 Java 17+	💻 Java 17+
Stability	❌ DO NOT USE IN PRODUCTION!	✔️
Auto-Updates	✔️	✔️
Frequent Updates	✔️	✔️
Latest Content	✔️	❌
Bug Reports	✔️	✔️
Branch	dev	master
Download Link	📦 Download dev	📦 Download release

Note: The supported Minecraft versions listed above do not represent the full range of available versions. Older builds may support older versions of Minecraft. You can check that on many download platforms easily, such as Modrinth or Hangar.

⬇️ Download platforms

Platform	Links	Releases	Alpha (dev) builds
Modrinth	📦 Downloads	❌	✔️
Hangar	📦 Downloads	❌	✔️
CurseForge	📦 Downloads	❌	❌
GitHub releases	📦 Downloads	❌	❌

More download platforms may be added in the future. You can also request one.

---

🔌 Compatibility

Slimefun United is designed to support old saves, which previously used official Slimefun builds (master/dev/experimental branches) and Gugu Project's fork of Slimefun.

You can also request compatibility with saves, which used other forks of Slimefun.

🗄️ Compatible server software

Name	Is compatible?
Spigot	❌ (use original Slimefun!)
Paper	✔️
Purpur	✔️
Folia	❌ (planned 👀)
CraftBukkit / Bukkit	❌
Sponge	❌
Hybrid servers (Arclight, Mohist, etc.)	❌
Fabric / Forge / NeoForge	❌ (it's not a mod!)

Most forks of Paper should be compatible with Slimefun United.

---

💻 Development

🖲️ Adding as a Dependency

⚠️ This section still hasn't been updated! Some pieces of information may be outdated or incorrect!

How to add Slimefun United as a dependency?

Dough United can easily be included in Gradle (Groove and Kotlin) and Maven using Maven Central or JitPack.

Adding Slimefun United via Gradle (Groovy)

Simply replace [SF VERSION] with the most up-to-date version of Slimefun United:

JitPack

repositories {
   maven { url 'https://jitpack.io' }
}

dependencies {
   implementation 'com.github.Slimefun-United.Slimefun-United:slimefun-united:[SF VERSION]'
}

Adding Slimefun United via Gradle (Kotlin)

Simply replace [SF VERSION] with the most up-to-date version of Slimefun United:

JitPack

repositories {
   maven("https://jitpack.io")
}

dependencies {
   implementation("com.github.Slimefun-United.Slimefun-United:slimefun-united:[SF VERSION]")
}

Adding Slimefun United via Maven

Simply replace [SF VERSION] with the most up-to-date version of Slimefun United:

JitPack

<repositories>
   <repository>
      <id>jitpack.io</id>
      <url>https://jitpack.io</url>
   </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>com.github.Slimefun-United.Slimefun-United</groupId>
    <artifactId>slimefun-united</artifactId>
    <version>[SF VERSION]</version>
    <scope>compile</scope>
  </dependency>
</dependencies>

🧱 Compiling Slimefun United

How to compile Slimefun United?

To compile Slimefun United, you must first install Git

Open a terminal or command prompt in the location where you want to store the code and run the following command:

git clone https://github.com/Slimefun-United/Slimefun-United.git --depth=1

This will pull Slimefun United's code to your local machine.

Finally, open the Slimefun-United folder, and open a terminal or command prompt in that folder and enter the following command to compile:

• If you are on Windows: .\mvnw.cmd package
• If you are on a Unix-like system: .\mvnw package

After compilation is complete, you can find the compiled plugin file in the Slimefun-United/target folder.

---

🖼️ Screenshots

So, what does Slimefun look like?
We asked some people from our Discord server to send us some screenshots:

Reactors and Energy	Amazing Automation Factory	Magic Laboratory
Screenshot by HamtaBot#0001	Screenshot by Piͭxͪeͤl (mnb)#5049	Screenshot by Kilaruna#4981
Screenshot by GalaxyKat11#3816	Screenshot by TamThan#7987	Screenshot by Kilaruna#4981

---

🎧 Community

Our Discord server

We have our own Discord server related to our project, which you can use to get help, meet new people, share ideas and much more! Note: You should report bugs in the issues tab.

Old Official Discord

Caution

The official Slimefun Discord server does not accept any form of issue reports. Please use the issue tracker to report issues!

You can find Slimefun's community server on Discord and communicate with over 7000 users from around the world. As original Slimefun has been abandoned, the server is going to be archived in some future, so keep that in mind.

Please familiarise yourself with the important rules of the official Discord server before joining. People who do not follow the above rules may be kicked or even banned from the server.

Other community channels

For the international community:

• Slimefun Addon Community Discord sever
• dough Discord server (for developers) Note: These servers can be abandoned fully in the near future.

For the Chinese community (only regarding Gugu Project's Simplified Chinese version):

• KOOK server
• QQ Group: 807302496
• Addon Discussion QQ Group: 205679802 (Slimefun Addon Discussion and translation group plugin update notifications)

---

📖 Wiki

Slimefun has a (detailed and frequently maintained - ahem) wiki for new players, and you can also consider contributing to the wiki.

• Old official Wiki
• Gugu Project's Wiki (in Simplified Chinese)

The Gugu Project's wiki is maintained by @ybw0014. If you find missing articles, please report them on the wiki's issues page.

⭐ Useful Documentation

• What is Slimefun?
• How to install Slimefun
• Slimefun 4 Addon List
• Slimefun 4 Addon Development Guide
• Getting Started
• FAQ
• Common Issues
• Help us expand the Wiki!
• Help us translate Slimefun!

---

🤝 Contributing to the Project

Slimefun United is an open-source project licensed under the GNU GPLv3. Over 100 people have contributed to this and the original Slimefun, and they are amazing. We encourage you to contribute to Slimefun United by submitting PRs. Your contributions keep Slimefun alive <3. You can also propose forks with interesting features to be merged with this project.

---

❗ Disclaimer

Slimefun United uses multiple systems to collect plugin usage data and has auto-update functionality to push new versions to you. The plugin does not collect personal information stored in any form. The types of information collected can be seen below.

Of course, you can disable data telemetry and auto-updates at any time.

Auto-Updates

Slimefun United uses GitHub API to check for and download updates. Auto-updates are enabled by default, but you can choose to disable them in /plugins/Slimefun/config.yml. We strongly recommend keeping auto-updates enabled to ensure you get the latest features/fixes.

The Gugu Project's version uses GitHub API + GuizhanBuild API for updates.

---

Slimefun United also uses its own analytics system to collect anonymous information about the performance of this plugin.
This is solely for statistical purposes, as we are interested in how it's performing for all servers.
All available data is anonymous and aggregated, at no point can we see individual server information.

You can also disable this behaviour under /plugins/Slimefun/config.yml.

Anonymous Server Data

Slimefun United uses bStats to collect anonymous information about the plugin because we are interested in how server players use the plugin. However, all data published on bStats is anonymous, and we absolutely cannot trace back to specific servers or players based on the reported data. All collected data is publicly accessible: https://bstats.org/plugin/bukkit/Slimefun/4574

You can also disable data collection in /plugins/bStats/config.yml. Learn more by checking out bStats Privacy Policy.

GitHub Data

Slimefun United uses the GitHub API to collect usage data about this open-source project. Rest assured, your Minecraft server information will not be sent to GitHub.

This information includes but is not limited to:

• List of collaborators, their usernames and profile links (from repositories Slimefun/Slimefun4, Slimefun/Slimefun-Wiki, and Slimefun/Resourcepack)
• Number of open issues in the repository
• Number of pending pull requests in the repository
• Number of stars in the repository
• Number of forks of the repository
• Code size of the repository
• Date of the last commit in the repository

Additionally, the plugin also uses textures.minecraft.net to obtain collaborators' Minecraft skins. Please note: Slimefun United is not affiliated with Mojang Studios or Minecraft.

---

💚 Credits

• Many thanks to TheBusyBiscuit and countless contributors and an amazing community, which made original Slimefun possible!
• Slimefun Gugu Project for many new features, bug fixes and updates
• neokini for Craft233MC's Folia-oriented fork
• SaanPrasanna for his translation of Gugu Project's Slimefun fork
• TheoDoR for his Slimefun Lab and some bug fixes and updates