You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-25Lines changed: 37 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,6 @@
1
1
# Slimefun 4
2
+
Looking for the download link? [**Click here**](https://github.com/TheBusyBiscuit/Slimefun4/blob/master/README.md#download-slimefun-4)
3
+
2
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.<br>
3
5
We got everything from magical wands to nuclear reactors.<br>
4
6
We feature a magical altar, an electric power grid and even item transport systems.
@@ -18,38 +20,40 @@ Check out our [Addons](https://github.com/TheBusyBiscuit/Slimefun4/wiki/Addons),
**! We wholeheartedly recommend you to use development builds !**
41
+
**:exclamation: We wholeheartedly recommend you to use _development builds_, they are the most recent version of Slimefun and also receive the most frequent updates!**
42
+
<details>
43
+
<summary>Here's why...</summary>
44
+
45
+
"Stable" builds do not receive frequent updates or fast patches. As time goes on, bugs are fixed but it will take some time until these fixes make it into a "stable" build. We will also not accept or review any bug reports from "stable" builds. They are in fact just old development builds that seemed to run fine without any __major__ issues.
38
46
39
-
"Stable" builds do not receive frequent updates or fast patches. As time goes on, bugs are fixed but it will take some time until these fixes make it into a "stable" build. We will also not accept or review any bug reports from "stable" builds. They are in fact just old development builds that seemed to run fine without any __major__ issues.<br>
40
-
**Why use a "stable" build then?** While "stable" builds most definitely contain more bugs than development builds due to their very slow update schedule. you can be sure that they will not include __game-breaking__ issues, but rest assured that development builds almost never contain such issues either. If your server or buesiness however heavily depends on a version of Slimefun that does not change/update a lot, you are forgiven if you choose the "stable" branch. But development builds will hold the best experience in terms of features and bug fixes.<br>
41
-
**What exactly are these "stable" builds then and why do you put them in quotes?** "Stable" builds are literally just outdated development builds that seemed to run fine without any major issues. But they are not exactly bug-free hence why actually calling them stable would be hypocritical. However these builds can only really stay "stable" if there are enough people using development builds to report bugs. Otherwise potential issues may go unnoticed and slip into "stable" builds. Again, we really recommend you to choose the development builds. But since many people really wanted "stable" builds, they are now an option too.
47
+
**Why use a "stable" build then?**<br>
48
+
While "stable" builds most definitely contain more bugs than development builds due to their very slow update schedule. you can be sure that they will not include __game-breaking__ issues, but rest assured that development builds almost never contain such issues either. If your server or business however heavily depends on a version of Slimefun that does not change/update a lot, you are forgiven if you choose the "stable" branch. But development builds will bring you the best experience, both in terms of features and bug fixes.
42
49
43
-
Whatever version of Slimefun you choose, we also recommend you to keep `auto-updates` enabled to receive automatic patches and fixes for Slimefun!
50
+
**What exactly are these "stable" builds then and why do you put them in quotes?**<br>
51
+
"Stable" builds are literally just outdated development builds that seemed to run fine without any __major__ issues. But they are far from bug-free hence why actually calling them stable would be hypocritical. However these builds can only really stay "stable" if there are enough people using development builds and report any bugs they come across. Otherwise potential issues may go unnoticed and slip into a "stable" build. Again, we really recommend you to choose the development builds. But since a few people really wanted "stable" builds, they are now an option too.
You can find Slimefun's community on Discord and connect with **over 1800** users of this plugin from all over the world.<br>
56
+
You can find Slimefun's community on Discord and connect with **over 2000** users of this plugin from all over the world.<br>
53
57
Click the badge down below to join the server for suggestions/questions or other discussions about this plugin.<br>
54
58
We are also hosting a community event every so often, join us to find out more.<br>
55
59
**Important**: We do **not** accept bug reports on discord, please use our [Issue Tracker](https://github.com/TheBusyBiscuit/Slimefun4/issues) to submit bug reports!
@@ -113,33 +117,40 @@ _Please contact us on [Discord](#discord) before working on any code smells. Som
113
117
Technical Debt is basically an estimate for how long it would take to fix all issues and code smells.
114
118
115
119
##### Test Coverage
116
-
Slimefun now also uses Automated Tests to determine whether an update could break something. The coverage shows how much these tests cover. Higher coverage means less breaking changes and in turn better and more reliable builds.
117
-
Due to this being a very huge project though, getting to `100% coverage` is probably impossible. But increasing that number even slightly still helps. So feel free to write Unit Tests for Slimefun and place them in the [/src/test/java/](https://github.com/TheBusyBiscuit/Slimefun4/tree/master/src/test/java) folder.
118
-
120
+
Slimefun now also uses Automated Tests to determine whether an update could break something. The coverage shows how much these tests cover. Higher coverage means less breaking changes and as a result also better and more reliable builds.
121
+
Due to this being a very huge project though, getting to `100% coverage` is probably close to impossible. But increasing that number even slightly still helps. So feel free to write Unit Tests for Slimefun and place them in the [/src/test/java/](https://github.com/TheBusyBiscuit/Slimefun4/tree/master/src/test/java) folder.
119
122
120
123
## Disclaimers
121
124
Slimefun4 uses various systems that collect usage information or download automatic updates as well as the latest information about the project.
122
-
We do not collect any personal information from you but there are some services that may gather or download some data.
125
+
We do not collect any personal information from you but there are some services that may gather or download some form of data.
123
126
124
127
You can opt-out of the Auto-Updater and stats collection at any time.
125
128
126
-
#### Auto-Updates
129
+
<details>
130
+
<summary>Automatic updates</summary>
131
+
127
132
Slimefun4 uses an Auto-Updater which connects to https://thebusybiscuit.github.io/builds/ to check for and download updates.<br>
128
133
This behaviour is enabled by default but can be turned off under `/plugins/Slimefun/config.yml`.<br>
129
134
We highly recommend you to keep this on at any time though, as you could be missing out on important patches.
135
+
</details>
130
136
131
-
#### Metrics and Statistics
137
+
<details>
138
+
<summary>Metrics and Statistics</summary>
139
+
132
140
Slimefun4 uses [bStats](https://bstats.org/plugin/bukkit/Slimefun/4574) to collect anonymous information about the usage of this plugin.<br>
133
141
This is solely for statistical purposes, as we are interested in how Servers/Players use this plugin.<br>
134
142
All available data is anonymous and aggregated, at no point can we see individual server or player information.<br>
135
143
All of the collected data is publicly accessible: https://bstats.org/plugin/bukkit/Slimefun/4574
136
144
137
145
You can also disable this behaviour under `/plugins/bStats/config.yml`.<br>
138
146
For more info see [bStats' Privacy Policy](https://bstats.org/privacy-policy)
147
+
</details>
139
148
140
-
#### GitHub Integration
149
+
<details>
150
+
<summary>GitHub Integration</summary>
151
+
141
152
Lastly, Slimefun4 connects to https://api.github.com/ to gather information about this open-source project.<br>
142
-
No information about your Minecraft Server is sent to GitHub.
153
+
No information about you or your Minecraft Server is sent to GitHub.
143
154
144
155
This information includes (but is not limited to)
145
156
* list of contributors, their username and profile link (from the repositories `TheBusyBiscuit/Slimefun4`, `Slimefun/Slimefun-Wiki` and `Slimefun/Resourcepack`)
@@ -149,6 +160,7 @@ This information includes (but is not limited to)
149
160
* amount of forks of this repository
150
161
* amount of code-bytes in this repository
151
162
* date of the last commit to this repository
163
+
</details>
152
164
153
165
Additionally the plugin connects to https://mojang.com/ to retrieve the Minecraft skins of our contributors (if possible).<br>
154
-
Note that this project is not associated with Mojang AB.
166
+
Note that Slimefun is not associated with `Mojang Studios` or Minecraft.
0 commit comments