1
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-19 19:25:48 +00:00
Slimefun4/README.md
2020-03-13 02:02:04 +01:00

7.8 KiB

Slimefun 4

Slimefun is a plugin which aims to turn your Bukkit/Spigot Server into a modpack without ever installing a single mod. It offers everything you could possibly imagine. From Backpacks to Jetpacks! Slimefun lets every player decide on their own how much they want to dive into Magic or Tech.
We got everything from magical wands to nuclear reactors.
This project originally started back in 2013 and has grown ever since.
It currently adds over 500 new items and recipes to Minecraft.
Read more...

But it also comes with a lot of Addons too!
Check out our Addons, you may find exactly what you were looking for.

Quick navigation

Download Slimefun 4

Slimefun 4 can be downloaded for free on our builds page.
We currently provide two versions of Slimefun, development builds and "stable" builds.
Here is a full summary of the differences between these two versions of Slimefun.

development builds "stable" builds
frequent updates ✔️
latest content ✔️
"stability" ✔️
extensive testing ✔️
Discord support ✔️
Bug Reports ✔️
Fast patches ✔️
Download 📦 download development build 📦 download "stable" build

We wholeheartedly recommend you to use development builds.
But we can understand the use of "stable" builds if your server's livelihood heavily depends on Slimefun.
We do recommend you to keep on auto-updates to receive automatic patches and fixes for Slimefun.
If you worry about features from Slimefun breaking due to an update (rarely happens), then you may wanna use a "stable" build to be sure, but we will not provide any support for it on discord nor on our issue tracker.

Build Server

Important: "stable" is in quotes because these builds have gone through a testing period before their release, they are safe to use. However due to this testing period, updates will happen very rarely, so any bugs that arise will not be fixed until the next major update. Development builds receive very frequent updates and patches, so these may (ironically) perform better than "stable" builds. We will also provide no support on discord nor the issue tracker for "stable" builds, as "stable" builds can be outdated by weeks or even months due to their infrequent update schedule.

Discord

You can find Slimefun's community on Discord!
Click the badge down below to join the server for suggestions/questions or other discussions about this plugin.
Note that we do not accept bug reports on discord, please use our Issue Tracker to submit bug reports!

Discord Invite

Wiki

Slimefun has a (detailed and well-maintained - cough) Wiki for new players, maybe also consider expanding the wiki to help grow our community and help out new users of this plugin. https://github.com/TheBusyBiscuit/Slimefun4/wiki

Highlighted Articles

Contributing to this project

You are allowed, even encouraged, to contribute to Slimefun 4 by making Pull Requests. This is an open-source community project, so your contributions keep this plugin alive!
These Pull Requests can be fixes, changes or even additions, but please keep in mind that if you add too much content to Slimefun 4, you should maybe consider making an Addon for it instead (Developer Guide).

Over 100 people have already contributed to this amazing project. You guys are awesome.

GitHub contributors

Slimefun 4 is licensed under GNU GPLv3.

Data Collection

Slimefun4 uses various systems that collect or download data.
We do not collect any personal information from you but here is a full list of what services may collect or download other kind of data.

Auto-Updates

Slimefun4 uses an Auto-Updater which connects to https://thebusybiscuit.github.io/builds/ to check for and download updates.
This behaviour is enabled by default but can be turned off under /plugins/Slimefun/config.yml
We highly recommend you to keep this on at any time though, as you could be missing out on important patches.

Metrics and Statistics

Slimefun4 uses bStats to collect anonymous information about the usage of this plugin.
This is solely for statistical purposes, as we are interested in how Servers/Players use this plugin.
All available data is anonymous and aggregated, at no point can we see individual server or player information.
All of the collected data is publicly accessible: https://bstats.org/plugin/bukkit/Slimefun/4574

You can also disable this behaviour under /plugins/bStats/config.yml.
For more info see bStats' Privacy Policy

GitHub Integration

Lastly, Slimefun4 connects to https://api.github.com/ to gather information about this open-source project.
No information about your Minecraft Server is sent to GitHub.

This information includes (but is not limited to)

  • list of contributors, their username and profile link (from the repositories TheBusyBiscuit/Slimefun4, TheBusyBiscuit/Slimefun4-Wiki and TheBusyBiscuit/Slimefun4-Resourcepack)
  • amount of open issues in this repository
  • amount of pending pull requests in this repository
  • amount of stars in this repository
  • amount of forks of this repository
  • amount of code-bytes in this repository
  • date of the last commit to this repository

Additionally the plugin connects to https://mojang.com/ to retrieve the Minecraft skins of our contributors (if possible).
Note that this project is not associated with Mojang AB.