Skip to content

Commit f0b4e77

Browse files
Update README
1 parent d1230f2 commit f0b4e77

3 files changed

Lines changed: 52 additions & 7 deletions

File tree

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,4 @@ buildNumber.properties
110110
.flattened-pom.xml
111111

112112
# Common working directory
113-
run/
114-
115-
libs/
113+
run/

README.md

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,60 @@
11
# ParallelUtils
2-
A utility plugin for play.parallel.ga
3-
2+
ParallelUtils is a plugin that enables a large variety of features, intended to be used for the Parallel SMP server at play.parallel.ga.
43

54
# Procedure to Start Development
65

7-
1. Ensure Git and Java are installed
6+
1. Ensure Git, Java and Maven are installed
87
2. Download BuildTools from https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar
98
3. Run `java -jar BuildTools.jar --rev 1.17`
109
4. Clone `https://github.com/PaperMC/Paper.git`. Change directory into the Paper directory.
1110
5. Run `git submodule update --init --recursive`. If the repo has been cloned before and submodules have already been updated, run `git submodule update --recursive`
1211
6. Run `./gradlew applyPatches`
13-
7. Run `./gradlew publishToMavenLocal`
12+
7. Run `./gradlew publishToMavenLocal`
13+
8. Place `FractalForest-1.12.jar`, `FrozenJoin-2.2.0.jar`, and `VotePart-2.26.jar` (or rename the jars in pom.xml) in the `libs` folder of ParallelUtils. These jars must be the ParallelMC versions.
14+
15+
# Current Structure
16+
All folders in `src/main/java/parallelmc.parallelutils/` are part of the base plugin except `modules/`.
17+
18+
The `modules/` folder contains modules for ParallelUtils, which will be separated into separate plugins in the future.
19+
20+
The `commands/` folder contains the ParallelUtils Commands and Permissions APIs to allow easily adding commands, tab completes, and creating a specific set of Permission requirements.
21+
22+
The `util/` folder contains miscellaneous helper classes and methods.
23+
24+
The `versionchecker/` folder contains classes related to the version checker and updater.
25+
26+
The `Constants` class contains constants that are useful for ParallelUtils
27+
28+
The `ParallelModule` interface is used by modules to be recognized by ParallelUtils. See the [New Structure](https://github.com/ParallelMC/ParallelUtils#New_Structure) section.
29+
30+
The `Parallelutils` class is the base Plugin file.
31+
32+
The `Version` class is a class that is used to manipulate plugin versions
33+
34+
# New Structure
35+
36+
Version 2 of ParallelUtils will split the modules into separate plugins. This will allow users to choose which modules to use and will prevent a single module from crashing the entire plugin.
37+
After this change, the API will not change at all from the view of the modules.
38+
39+
# Modules
40+
This is a list of the current modules for ParallelUtils
41+
- CustomMobs
42+
- Allows the creation of mobs with custom metadata, nbt, behaviors, and more
43+
44+
- CustomTrees
45+
- Adds custom trees for an [updated](https://github.com/ParallelMC/FractalForest) version of [FractalForest](https://www.spigotmc.org/resources/fractal-forest.75850/)
46+
47+
- DiscordIntegration
48+
- Adds and special Advancement notified, Join/Quit Suppressor, and more to a Discord bot
49+
50+
- EffectExtender
51+
- Allows for the stacking of potion effect durations up to 2x the original duration
52+
53+
- Gamemode4
54+
- These are plugin adaptations of the [Gamemode4][https://gm4.co/] datapacks
55+
56+
- ParallelFlags
57+
- Adds custom WorldGuard flags
58+
59+
- ParallelItems
60+
- Adds custom items for use on play.parallel.ga

libs/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)