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
This RC brings a lot of breaking changes to the API. For more info on why we did this and what happened [please refer to our PSA](https://github.com/Slimefun5/Slimefun5/pull/3139)
332
332
333
333
* Category has been renamed to ItemGroup.
334
-
* All Category / ItemGroup variants have been relocated to `io.github.thebusybiscuit.slimefun4.api.items.groups`
335
-
* The SlimefunItem class has been relocated to `io.github.thebusybiscuit.slimefun4.api.items`
336
-
* The SlimefunItemStack class has been relocated to `io.github.thebusybiscuit.slimefun4.api.items`
337
-
* The ItemHandler class has been relocated to `io.github.thebusybiscuit.slimefun4.api.items`
338
-
* The RecipeType class has been relocated to `io.github.thebusybiscuit.slimefun4.api.recipes`
339
-
* Research classes have been moved from `io.github.thebusybiscuit.slimefun4.core.researching` to `io.github.thebusybiscuit.slimefun4.api.researches`
334
+
* All Category / ItemGroup variants have been relocated to `io.github.thebusybiscuit.slimefun5.api.items.groups`
335
+
* The SlimefunItem class has been relocated to `io.github.thebusybiscuit.slimefun5.api.items`
336
+
* The SlimefunItemStack class has been relocated to `io.github.thebusybiscuit.slimefun5.api.items`
337
+
* The ItemHandler class has been relocated to `io.github.thebusybiscuit.slimefun5.api.items`
338
+
* The RecipeType class has been relocated to `io.github.thebusybiscuit.slimefun5.api.recipes`
339
+
* Research classes have been moved from `io.github.thebusybiscuit.slimefun5.core.researching` to `io.github.thebusybiscuit.slimefun5.api.researches`
340
340
* The main class `SlimefunPlugin` was renamed to `Slimefun`
341
341
* CS-CoreLib2 was removed and replaced by dough
342
342
@@ -373,7 +373,7 @@ This RC brings a lot of breaking changes to the API. For more info on why we did
373
373
* Fixed Ender Lumps showing an incorrect recipe in the guide
Slimefun uses [sonarcloud.io](https://sonarcloud.io/dashboard?id=Slimefun_Slimefun4) to monitor Code Quality.
61
+
Slimefun uses [sonarcloud.io](https://sonarcloud.io/dashboard?id=Slimefun_Slimefun5) to monitor Code Quality.
62
62
63
-
We always welcome quality improvements to the code and the "Code Smells" section on [sonarcloud.io](https://sonarcloud.io/dashboard?id=Slimefun_Slimefun4) is a great place to start.
63
+
We always welcome quality improvements to the code and the "Code Smells" section on [sonarcloud.io](https://sonarcloud.io/dashboard?id=Slimefun_Slimefun5) is a great place to start.
64
64
But please keep in mind that some design patterns may not be changed too abruptly if an addon depends on them.
65
65
To prevent any accidents from happening, please contact us on our [Discord Server](https://discord.gg/slimefun) before-hand and state your intended changes.
66
66
@@ -70,16 +70,16 @@ Code documentation is also a great way to improve the maintainability of the pro
70
70
2. Classes should also include an `@author` tag to indicate who worked on that class.
71
71
3. Methods and parameters should be annotated with `@Nullable` or `@Nonnull` to indicate whether or not null values are accepted.
72
72
73
-
Feel free to visit our [Javadocs](https://slimefun.github.io/javadocs/Slimefun4/docs/overview-summary.html)
73
+
Feel free to visit our [Javadocs](https://slimefun.github.io/javadocs/Slimefun5/docs/overview-summary.html)
74
74
75
75
#### Unit Tests
76
76
Unit Tests help us test the project to work as intended in an automated manner.<br>
77
-
More or better Unit Tests are always good to have, so feel free to submit a Test and place it in our [src/test/java](https://github.com/Slimefun5/Slimefun5/tree/master/src/test/java/io/github/thebusybiscuit/slimefun4/testing) directory
77
+
More or better Unit Tests are always good to have, so feel free to submit a Test and place it in our [src/test/java](https://github.com/Slimefun5/Slimefun5/tree/master/src/test/java/io/github/thebusybiscuit/slimefun5/testing) directory
78
78
79
79
We are using [Junit 5 - Jupiter](https://github.com/junit-team/junit5/) and [MockBukkit](https://github.com/seeseemelk/MockBukkit) as our testing environment.<br>
80
80
Every new Unit Test should have a `@DisplayName` annotation with a plain text description on what the Unit Test tests.
81
81
82
-
## :toolbox: How to compile Slimefun4
82
+
## :toolbox: How to compile Slimefun5
83
83
Slimefun is written in Java and uses [Maven](https://maven.apache.org/) for compilation.<br>
84
84
To compile Slimefun yourself, follow these steps:
85
85
@@ -144,7 +144,7 @@ But do try to follow our code style as best as you can.*
144
144
* Constants (`static final` fields) should be in *SCREAMING_SNAKE_CASE* (e.g. `MY_CONSTANT_FIELD`)
145
145
* Variables, parameters and fields should be in *camelCase* (e.g. `myVariableOrField`)
146
146
* All methods should be in *camelCase* (e.g. `myMethod`)
147
-
* Packages must be all lowercase, consecutive words should generally be avoided. (e.g. `io.github.thebusybiscuit.slimefun4.core.something`)
147
+
* Packages must be all lowercase, consecutive words should generally be avoided. (e.g. `io.github.thebusybiscuit.slimefun5.core.something`)
148
148
#### 7. Style preferences
149
149
* Use **Spaces**, not Tabs!
150
150
* One class per file! Please don't put multiple classes into one file, this also applies to enums, make a seperate file for new classes or enums.
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Slimefun 5 (Continued Fork)
2
2
3
-
> **This is a community-maintained fork of [Slimefun4](https://github.com/Slimefun/Slimefun4), which was discontinued by its original developers. This fork continues development with support for modern Minecraft versions.**
3
+
> **This is a community-maintained fork of [Slimefun5](https://github.com/Slimefun5/Slimefun5), which was discontinued by its original developers. This fork continues development with support for modern Minecraft versions.**
4
4
5
5
Slimefun is a plugin which aims to turn your Spigot Server into a modpack without ever installing a single mod. From Backpacks to Jetpacks! Slimefun lets every player decide on their own how much they want to dive into Magic or Tech.<br>
6
6
We got everything from magical wands to nuclear reactors.<br>
0 commit comments