Release/v5.4 (#1822)

Co-authored-by: Ren Binden <ren.binden@gmail.com>
Co-authored-by: Donut <86391164+Chocolate1Donut@users.noreply.github.com>
Co-authored-by: Tems <79542785+Tems-py@users.noreply.github.com>
Co-authored-by: Will <87247824+MestreWilll@users.noreply.github.com>
Co-authored-by: MestreWilll <WillXOkumura@hotmail.com>

Author: 6 people

.github/CODEOWNERS

@@ -1 +1 @@
-* @alyphen @dmccoystephenson
+* @dmccoystephenson

.testcontainer/post-create.sh

@@ -0,0 +1,45 @@
+echo "Running 'post-create.sh' script..."
+if [ -z "$(ls -A /testmcserver)" ]; then
+    echo "Setting up server..."
+    # Copy server JAR
+    cp /testmcserver-build/spigot-1.20.4.jar /testmcserver/spigot-1.20.4.jar
+
+    # Create plugins directory
+    mkdir /testmcserver/plugins
+
+    # Create ops.json file on the fly
+    echo "Creating ops.json file..."
+    echo '[
+      {
+        "uuid": "0a9fa342-3139-49d7-8acb-fcf4d9c1f0ef",
+        "name": "DanTheTechMan",
+        "level": 4,
+        "bypassesPlayerLimit": false
+      }
+    ]' >> /testmcserver/ops.json
+
+    # Accept EULA
+    cd /testmcserver && echo "eula=true" > eula.txt
+else
+    echo "Server is already set up."
+fi
+
+# Always delete lang directory to get the latest translations
+echo "Deleting lang directory..."
+rm -rf /testmcserver/plugins/MedievalFactions/lang
+
+# Always copy the latest plugin JAR
+nameOfJar=$(ls /testmcserver-build/MedievalFactions/build/libs/*-all.jar)
+currentDate=$(date +%s)
+jarDate=$(date -r "$nameOfJar" +%s)
+diff=$((currentDate - jarDate))
+
+if [ $diff -gt 300 ]; then
+    echo "WARNING: The plugin JAR is older than 5 minutes. It may be necessary to rebuild the plugin."
+fi
+
+echo "Copying plugin JAR... (created $diff seconds ago)"
+cp "$nameOfJar" /testmcserver/plugins
+
+echo "Starting server..."
+java -jar /testmcserver/spigot-1.20.4.jar

CONTRIBUTING.md

@@ -1,21 +1,67 @@
-# Contributing To The Project
+# Contributing Document
 ## Thank You
-Thank you so much for being willing to contribute to this project! It wouldn't be where it is today without the help of others. Please feel free to fork the repository and contact me on my [support discord server](https://discord.gg/xXtuAQ2).
+Thank you for being interested in contributing to the project! It wouldn't be where it is today without the help of the community. This document will help you get started with contributing to the project.
 
-## Some Things To Know
-- I use ZenHub to manage repository issues. This is optional for contributors.
-- Our highest priority issues will given the "priority" label. [Check them out here](https://github.com/dmccoystephenson/Medieval-Factions/issues?q=is%3Aissue+is%3Aopen+label%3Apriority)
+## Links
+- [Website](https://dansplugins.com)
+- [Discord](https://discord.gg/xXtuAQ2)
 
-## Process
-- When you fork the repository, make sure you are working on the "develop" branch.
-- When you start working on something, assign it to yourself. If there is no issue, you can optionally create one.
-- When you add new lines to the language files, make sure to add them to all 4 supported translations: en_US, en_GB, de_DE and fr_FR
-- When you add translations, make sure they are all on the same line.
-- When you're finished with something, open a pull request and assign it to yourself. If there is an associated issue, please link it in the PR using #(number).
+## Requirements
+- A GitHub account
+- Git installed on your local machine
+- A text editor or IDE
+- A basic understanding of Java
 
-## Notes
-- If you start working on something, please remember to assign yourself to the related issues so I know what is being worked on.
-- If you edit a class, feel free to add an author annotation with your name. This is optional.
+## Getting Started
+- If you don't already have a GitHub account, you can sign up for one [here](https://github.com/signup).
+- Fork the repository on GitHub by clicking the "Fork" button on the top right of the repository page.
+- Clone your fork of the repository to your local machine using `git clone https://www.github.com/<your-username>/Medieval-Factions.git`
+- Open the project in your preferred text editor or IDE.
+- Try compiling the plugin using the following command:
+  ```bash
+  gradlew build
+  ```
+  If you encounter any errors, please create an issue for it.
 
-## Bugs
-- When you encounter a bug that is in the code of the master branch, create an issue for it and assign it the 'Bug' label.
+## Identifying What To Work On
+### Issues
+Work items are tracked as GitHub issues. You can find a full list of issues [here](https://github.com/Dans-Plugins/Medieval-Factions/issues).
+
+### Milestones
+Work items are organized into milestones, which represent a specific version of the plugin. You can find the milestones [here](https://github.com/Dans-Plugins/Medieval-Factions/milestones).
+
+## Making Changes
+- Before you start working on something, make sure there is an issue for it. If there isn't, create one.
+- Make sure you are working on the "develop" branch. If you are not, switch to it using `git checkout develop`.
+- Create a new branch for your changes using `git checkout -b <branch-name>`. Make sure to name your branch something that is related to the issue you are working on.
+- Make your changes to the code.
+- Test your changes to make sure they work as expected. [More information on testing can be found here](#testing).
+- When you are finished, commit your changes using `git commit -m "Your commit message here"`.
+- Push your changes to your fork using `git push origin <branch-name>`.
+- Open a pull request on the original repository. Make sure to include a description of your changes and link the related issue using #(number). The develop branch should be used as the base branch.
+- Wait for your pull request to be reviewed. If there are any changes that need to be made, make them and push the changes to your fork. Your pull request will be updated automatically.
+- Once your pull request has been reviewed and approved, it will be merged into the develop branch.
+
+### Language Files
+The plugin supports multiple languages. Code changes that require changes to the language files should include the changes to the language files as well. If you are adding a new language, you will need to create a new language file. The language files are located in the `src/main/resources/lang` directory.
+
+## Testing
+At this time, there are no unit tests due to a difficulty mocking Spigot. However, you can test your changes by running the plugin on a Spigot server.
+
+### Running a Spigot server with Docker
+If you don't have Docker installed, you can download it [here](https://www.docker.com/products/docker-desktop).
+
+To run a Spigot server with Docker, you can use the following command:
+```bash
+docker compose up
+```
+
+This will start a Spigot server on your local machine. You can connect to it using the IP `localhost` and the port `25565`.
+
+If you make changes to the code, you can deploy the latest changes by rebuilding the Docker image:
+```bash
+docker compose up --build
+```
+
+## Questions
+If you have any questions about contributing to the project, feel free to ask in the Discord server. You can join the Discord server [here](https://discord.gg/xXtuAQ2). This is the best place to ask questions.

Dockerfile

@@ -7,21 +7,20 @@ RUN apt-get install -y git \
     openjdk-17-jre \
     wget
 
-# Create server directory
-WORKDIR /testmcserver
-
 # Build server
+WORKDIR /testmcserver-build
 RUN wget -O BuildTools.jar https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar
 RUN git config --global --unset core.autocrlf || :
 RUN java -jar BuildTools.jar --rev 1.20.4
-RUN echo "eula=true" > eula.txt
-RUN mkdir plugins
 
-# Build plugin
-COPY . .
-RUN ./gradlew build
-RUN cp build/libs/*-all.jar plugins
+# Copy plugin jar
+COPY ./build/libs /testmcserver-build/MedievalFactions/build/libs
+
+# Copy resources and make post-create.sh executable
+COPY ./.testcontainer /resources
+RUN chmod +x /resources/post-create.sh
 
 # Run server
+WORKDIR /testmcserver
 EXPOSE 25565
-ENTRYPOINT java -jar spigot-1.20.4.jar
+ENTRYPOINT /resources/post-create.sh

Dockerfile.dynmap

@@ -0,0 +1,41 @@
+FROM ubuntu
+
+# Install dependencies
+RUN apt-get update
+RUN apt-get install -y git \
+    openjdk-17-jdk \
+    openjdk-17-jre \
+    wget \
+    git
+
+# Create server directory
+WORKDIR /testmcserver
+
+# Clone & build dynmap (placed here to take advantage of docker caching)
+RUN git clone https://github.com/webbukkit/dynmap
+WORKDIR /testmcserver/dynmap
+RUN /testmcserver/dynmap/gradlew :spigot:build
+WORKDIR /testmcserver
+
+# Build server
+RUN wget -O BuildTools.jar https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar
+RUN git config --global --unset core.autocrlf || :
+RUN java -jar BuildTools.jar --rev 1.20.4
+RUN echo "eula=true" > eula.txt
+RUN mkdir plugins
+
+# Build plugin
+COPY . /testmcserver/MedievalFactions
+WORKDIR /testmcserver/MedievalFactions
+RUN /testmcserver/MedievalFactions/gradlew build
+WORKDIR /testmcserver
+
+# Install plugin
+RUN cp /testmcserver/MedievalFactions/build/libs/*-all.jar /testmcserver/plugins
+
+# Install dynmap
+RUN cp /testmcserver/dynmap/target/Dynmap-*.jar /testmcserver/plugins
+
+# Run server
+EXPOSE 25565
+ENTRYPOINT java -jar spigot-1.20.4.jar

README.md

@@ -5,40 +5,14 @@ Medieval Factions is a system of mechanics that allows for the simulation of sov
 
 A list of features can be found [here](https://github.com/dmccoystephenson/Medieval-Factions/wiki/Features).
 
-### Fifth Major Version - MF 5
-Medieval Factions 5 reimagines and reworks everything about the plugin. The development of the fifth major version of MF was led by [alyphen](https://github.com/alyphen) (creator of [RPKit](https://github.com/RP-Kit/RPKit/wiki)). Huge thanks to her!
-
-#### What's changed
-This is a complete rewrite of Medieval Factions so everything has received a fresh coat of paint since 4.6.x/4.7.x. Commands, permissions, placeholders, etc should mostly be compatible, though some things have changed, such as locks, roles, and force commands.
+The development of the fifth major version of MF was led by [alyphen](https://github.com/alyphen) (creator of [RPKit](https://github.com/RP-Kit/RPKit/wiki)). Huge thanks to her!
 
 ## Installation
 ### First Time Installation
 1) You can download the plugin from [this page](https://www.spigotmc.org/resources/medieval-factions-sovereign-nation-simulator.79941/updates).
 2) Once downloaded, place the jar in the plugins folder of your server files.
 3) Restart your server.
 
-### Upgrading from Medieval Factions 4
-
-1. If you have a Medieval Factions 4 install, replace the Medieval Factions 4 jar with Medieval Factions 5.
-
-2. On the next start, Medieval Factions 5 will detect the Medieval Factions 4 config and make a backup of all of the data in mf4_backup in the data folder. It will then proceed to generate the new config file, and shut down the server.
-
-3. At this point, you should configure your database, if you have one.
-
-If you have MySQL or MariaDB database, this should look something like:
-
-```
-database:
-url: 'jdbc:mysql://127.0.0.1/database'
-dialect: 'MYSQL'
-username: 'username'
-password: 'password'
-```
-
-If you do not have a MySQL database, you can ignore this, as the plugin will create an h2 file-based database in your server's working directory.
-
-4. Start the server one more time, and the configuration and data from the Medieval Factions 4 backup will be migrated to your new Medieval Factions 5 install.
-
 ### Dynmap Integration
 Dynmap has been integrated with this plugin. In order to be able to view claimed land on a dynamic map, download and install the plugin [here](https://www.spigotmc.org/resources/dynmap.274/).
 
@@ -66,6 +40,21 @@ Please fill out a bug report [here](https://github.com/dmccoystephenson/Medieval
 - [Contributing.md](https://github.com/dmccoystephenson/Medieval-Factions/blob/master/CONTRIBUTING.md)
 - [Notes for Developers](https://github.com/dmccoystephenson/Medieval-Factions/wiki/Developer-Notes)
 
+## Testing
+### Unit Tests
+To run the unit tests, you can use the following command:
+
+Linux:
+```bash
+./gradlew clean test
+```
+Windows:
+```cmd
+.\gradlew.bat clean test
+```
+
+If you see BUILD SUCCESSFUL, then the tests have passed.
+
 ### Looking to create an add-on plugin?
 I recommend using [FactionsBridge](https://www.spigotmc.org/resources/factionsbridge.89716/) by [Retrix_Solutions](https://www.spigotmc.org/resources/authors/retrix_solutions.491191/). It would make your add-on plugin usable across a number of factions implementations.
 

build.gradle

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = "com.dansplugins"
-version = "5.3.0"
+version = "5.4.0"
 
 def repoUsername = ""
 def repoPassword = ""
@@ -36,7 +36,7 @@ configurations {
 }
 
 dependencies {
-    implementation 'me.clip:placeholderapi:2.11.2'
+    implementation 'me.clip:placeholderapi:2.11.6'
     implementation 'org.spigotmc:spigot-api:1.19.2-R0.1-SNAPSHOT'
     implementation 'us.dynmap:dynmap-api:2.2'
     implementation 'org.bstats:bstats-bukkit:3.0.0'
@@ -57,9 +57,14 @@ dependencies {
     implementation 'com.rpkit:rpk-lock-lib-bukkit:2.3.2:all'
     implementation 'com.dansplugins:ponder-bukkit:2.0.0'
     implementation 'com.dansplugins:ponder-commands:2.0.0'
-    testImplementation 'org.junit.jupiter:junit-jupiter:5.9.0'
-    testImplementation 'io.mockk:mockk:1.13.2'
     jooqGenerator 'org.jooq:jooq-meta-extensions:3.17.4'
+
+    // Use the Kotlin JUnit 5 integration.
+    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
+    testImplementation("org.mockito:mockito-core:4.0.0")
+    testImplementation("org.mockito:mockito-inline:4.0.0")
+
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
 }
 
 kotlin {
@@ -68,6 +73,13 @@ kotlin {
     }
 }
 
+// Apply a specific Java toolchain to ease working on different environments.
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
+}
+
 tasks.named('check') {
     dependsOn 'installKotlinterPrePushHook'
 }
@@ -166,10 +178,6 @@ artifacts {
     archives shadowJar
 }
 
-tasks.named('test') {
-    useJUnitPlatform()
-}
-
 publishing {
     repositories {
         maven {
@@ -192,3 +200,8 @@ publishing {
         }
     }
 }
+
+tasks.named('test') {
+    // Use JUnit Platform for unit tests.
+    useJUnitPlatform()
+}

compose-dynmap.yml

@@ -0,0 +1,10 @@
+services:
+  testmcserver:
+    build:
+      context: .
+      dockerfile: Dockerfile.dynmap
+    image: mf-test-mc-server-with-dynmap
+    container_name: mf-test-mc-server-with-dynmap
+    ports:
+      - "25565:25565"
+      - "8123:8123"

compose.yml

@@ -5,3 +5,5 @@ services:
     container_name: mf-test-mc-server
     ports:
       - "25565:25565"
+    volumes:
+      - ./testmcserver:/testmcserver

down.sh

@@ -0,0 +1 @@
+docker compose down --remove-orphans