Git Product home page Git Product logo

slimefun4's Introduction

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.
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.
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.
It currently adds over 500 new items and recipes to Minecraft (Read more about the history of this project).

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

(See also: How to install Slimefun)
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 different versions of Slimefun.

development (latest) "stable"
Minecraft version(s) ๐ŸŽฎ 1.13.X - 1.15.X ๐ŸŽฎ 1.13.X - 1.15.X
testing before release โŒ โœ”๏ธ
latest content โœ”๏ธ โŒ
Discord support โœ”๏ธ โŒ
Bug Reports โœ”๏ธ โŒ
frequent updates โœ”๏ธ โŒ
change logs โŒ ๐Ÿ“ change log
Download link ๐Ÿ“ฆ download latest ๐Ÿ“ฆ download "stable"

! We wholeheartedly recommend you to use development builds !

"Stable" builds do not receive frequent updates or fast patches. Therefore they will always contain a lot more bugs than the develoment builds. We will also not accept or review any bug reports from "stable" builds. These are just old development builds that seemed to run without any major issues.
Why use a "stable" build then? While "stable" builds contain more bugs than development builds you can be sure that they will not include game-breaking issues, development builds almost never contain such issues either. But if your server/business heavily depends on a version of Slimefun that you need to rely on, you are forgiven if you choose the "stable" branch.
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.

Whatever version of Slimefun you choose, we also recommend you to keep auto-updates enabled to receive automatic patches and fixes for Slimefun!

Build Server

Discord

You can find Slimefun's community on Discord and connect with over 1800 users of this plugin from all over the world.
Click the badge down below to join the server for suggestions/questions or other discussions about this plugin.
We are also hosting a community event every so often, join us to find out more.
Important: We do not accept bug reports on discord, please use our Issue Tracker to submit bug reports!

Due to the sheer size of this discord server, we need to enforce some important rules.
Not following these rules can lead to a kick or even a ban from the server.

Discord Invite
(Click the badge to join)

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

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

Slimefun 4 is an Open-Source project and licensed under GNU GPLv3.
Over 100 people have already contributed to this amazing project. You guys are awesome.
Please consider helping us maintain this project too, your engagement keeps the project alive <3.

Translations

Slimefun4 has recently added suport for translations, note that translations are still work in progress.
So not everything may be available for translation yet.
Read more...

Pull requests

This is an open-source community project, so your contributions keep this plugin alive!
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).

Code Quality

Slimefun uses Sonarcloud.io to monitor Code Quality.

Overall Maintainability "Code Smells" "Technical Debt" Test Coverage
Maintainability Rating Code Smells Technical Debt Coverage
"Code Smells"

Code Smells are portions of the source code that are confusing, lack documentation or are just done very badly in general. These code smells should be held to a bare minimum.

Please contact us on Discord before working on any code smells. Some design patterns may not be changed abruptly because an addon might depend on them.

"Technical Debt"

Technical Debt is basically an estimate for how long it would take to fix all issues and code smells.

Test Coverage

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. 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/ folder.

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 data.

You can opt-out of the Auto-Updater and stats collection at any time.

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, Slimefun/Slimefun-Wiki and Slimefun/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.

slimefun4's People

Contributors

thebusybiscuit avatar poslovitch avatar sosedik avatar walshydev avatar j3fftw1 avatar john000708 avatar redemption198 avatar ajan-12 avatar dniym avatar sfiguz7 avatar voidangel avatar starwishsama avatar mrcoffee1026 avatar mistererwin avatar dnx5 avatar linoxgh avatar killerxcoder avatar renovate-bot avatar andris155 avatar poma123 avatar alexlander123 avatar vravinite avatar thebusybot avatar sarhatabaot avatar nathanadhitya avatar luu7 avatar mohkamfer avatar justdams avatar brinetaiwan avatar ishi-sama avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.