mirror/Slimefun4
mirror/Slimefun4
1
Fork 0
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-19 19:25:48 +00:00
Code Releases Activity

[CI skip] Updated README

Browse Source
This commit is contained in:
TheBusyBiscuit 2021-04-26 11:13:37 +02:00 committed by GitHub
parent f048d0276b
commit 658d101706
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,31 +1,30 @@
# Slimefun 4
Looking for the download link? [**Click here**](https://github.com/Slimefun/Slimefun4/blob/master/README.md#download-slimefun-4)
*Looking for the download link? [**Click here**](https://github.com/Slimefun/Slimefun4/blob/master/README.md#download-slimefun-4)*
Slimefun is a plugin which aims to turn your 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>
We got everything from magical wands to nuclear reactors.<br>
We feature a magical altar, an electric power grid and even item transport systems.
This project originally started back in 2013 and has grown ever since.<br>
From one single person working on this plugin back then, we grew to a community of thousands of players and over 100 contributors to this project.<br>
This project originally started back **in 2013** and has grown ever since.<br>
From one single person working on this plugin back then, we grew to a community of thousands of players and hundreds of contributors to this project.<br>
It currently adds over **500 new items and recipes** to Minecraft ([Read more about the history of this project](https://github.com/Slimefun/Slimefun4/wiki/Slimefun-in-a-nutshell)).
But it also comes with a lot of Addons too!<br>
Check out our [Addons](https://github.com/Slimefun/Slimefun4/wiki/Addons), you may find exactly what you were looking for.
### :compass: Quick navigation
* **[Download Slimefun4](#download-slimefun-4)**
* **[Screenshots](#screenshots)**
* **[Discord Support Server](#discord)**
* **[Bug Tracker](https://github.com/Slimefun/Slimefun4/issues)**
* **[Wiki](https://github.com/Slimefun/Slimefun4/wiki)**
* **[FAQ](https://github.com/Slimefun/Slimefun4/wiki/FAQ)**
* **[How to contribute](https://github.com/Slimefun/Slimefun4/blob/master/CONTRIBUTING.md)**
* **[:floppy_disk: Download Slimefun4](#floppy_disk-download-slimefun-4)**
* **[:framed_picture: Screenshots](#framed_picture-screenshots)**
* **[:headphones: Discord Support Server](#headphones-discord)**
* **[:beetle: Bug Tracker](https://github.com/Slimefun/Slimefun4/issues)**
* **[:open_book: Wiki](https://github.com/Slimefun/Slimefun4/wiki)**
* **[:interrobang: FAQ](https://github.com/Slimefun/Slimefun4/wiki/FAQ)**
* **[:handshake: How to contribute](https://github.com/Slimefun/Slimefun4/blob/master/CONTRIBUTING.md)**
## Download Slimefun 4
## :floppy_disk: Download Slimefun 4
Slimefun requires your Minecraft Server to be running on [Spigot](https://spigotmc.org/), [Paper](https://papermc.io/) or on any fork of these.<br>
(See also: [How to install Slimefun](https://github.com/Slimefun/Slimefun4/wiki/Installing-Slimefun))
**Due to [Spigot's abandonce of the Bukkit API](https://www.spigotmc.org/threads/spigot-bungeecord-1-16-1.447405/#post-3852349), Slimefun is no longer able to work on CraftBukkit, please switch over to Spigot or Paper if you haven't already.**
Slimefun 4 can be downloaded **for free** on our builds page.<br>
We currently provide two distinct versions of Slimefun, development builds and "stable" builds.<br>
Here is a full summary of the differences between the two different versions of Slimefun.
@ -42,21 +41,21 @@ Here is a full summary of the differences between the two different versions of
| **change logs** | :x: | :memo: **[change log](https://github.com/Slimefun/Slimefun4/blob/master/CHANGELOG.md)** |
| **Download link** | :floppy_disk: **[download latest](https://thebusybiscuit.github.io/builds/TheBusyBiscuit/Slimefun4/master/)** | :floppy_disk: **[download "stable"](https://thebusybiscuit.github.io/builds/TheBusyBiscuit/Slimefun4/stable/)** |
**:exclamation: We wholeheartedly recommend you to use _development builds_, they are the most recent version of Slimefun and also receive the most frequent updates!**
**:exclamation: We wholeheartedly recommend you to use _development builds_, they are the most recent version of Slimefun and also receive the most frequent updates! In fact, "stable" builds are so outdated that we won't accept bug reports from them at all.**
<details>
<summary>Here's why...</summary>
"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.
**Why use a "stable" build then?**<br>
**:question: Why use a "stable" build then?**<br>
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.
**What exactly are these "stable" builds then and why do you put them in quotes?**<br>
**:question: What exactly are these "stable" builds then and why do you put them in quotes?**<br>
"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.
</details>
## Screenshots
## :framed_picture: Screenshots
So what does Slimefun look like?<br>
Well, we asked some users on our [Discord server](#discord) to send us some screenshots, so see for yourself:
| Reactors and electricity | Awesome factories | Magic and Altars |
@ -66,11 +65,11 @@ Well, we asked some users on our [Discord server](#discord) to send us some scre
| ![](https://raw.githubusercontent.com/Slimefun/Slimefun-Wiki/master/images/showcase4.png) | ![](https://raw.githubusercontent.com/Slimefun/Slimefun-Wiki/master/images/showcase3.png) | ![](https://raw.githubusercontent.com/Slimefun/Slimefun-Wiki/master/images/showcase2.png) |
| *Screenshot provided by GalaxyKat11#3816* | *Screenshot provided by TamThan#7987* | *Screenshot provided by Kilaruna#4981* |
## Discord
## :headphones: Discord
You can find Slimefun's community on Discord and connect with **over 5000** users of this plugin from all over the world.<br>
Click the badge down below to join the server for suggestions/questions or other discussions about this plugin.<br>
We are also hosting a community event every so often, join us to find out more.<br>
**Important**: We do **not** accept bug reports on discord, please use our [Issue Tracker](https://github.com/Slimefun/Slimefun4/issues) to submit bug reports!
**Important: We don't accept bug reports on discord, please use our [Issue Tracker](https://github.com/Slimefun/Slimefun4/issues) to submit bug reports!**
Due to the sheer size of this discord server, we need to enforce some [important rules](https://github.com/Slimefun/Slimefun4/wiki/Discord-Rules).<br>
Not following these rules can lead to a kick or even a ban from the server.
@ -81,12 +80,12 @@ Not following these rules can lead to a kick or even a ban from the server.
</a>
</p>
## Wiki
## :open_book: 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/Slimefun/Slimefun4/wiki
##### Highlighted Articles
##### :star: Highlighted Articles
* [What is Slimefun?](https://github.com/Slimefun/Slimefun4/wiki/Slimefun-in-a-nutshell)
* [How to install Slimefun](https://github.com/Slimefun/Slimefun4/wiki/Installing-Slimefun)
* [Addons for Slimefun 4](https://github.com/Slimefun/Slimefun4/wiki/Addons)
@ -99,15 +98,15 @@ https://github.com/Slimefun/Slimefun4/wiki
The wiki is entirely community-run, so if you find an article missing, feel free to write one and share it with others.
## Contributing to this project
## :handshake: Contributing to this project
Slimefun 4 is an Open-Source project and licensed under
[GNU GPLv3](https://github.com/Slimefun/Slimefun4/blob/master/LICENSE).<br>
Over 150+ people have already contributed to this amazing project. You guys are awesome.<br>
**Over 200 people have already contributed to this amazing project. You guys are awesome.**<br>
Please consider helping us maintain this project too, your engagement keeps the project alive <3.
You can find more info on how to contribute to this project in our [CONTRIBUTING.md](https://github.com/Slimefun/Slimefun4/blob/master/CONTRIBUTING.md).
## Disclaimers
## :exclamation: Disclaimers
Slimefun4 uses various systems that collect usage information or download automatic updates as well as the latest information about the project.
We do not collect any personal information from you but there are some services that may gather or download some form of data.