From 7a404aa27f426d4e810d31df61551bdc89381321 Mon Sep 17 00:00:00 2001 From: Tom Hicks Date: Sat, 26 Sep 2026 19:58:24 -0700 Subject: [PATCH] Adds modrinth description. --- Modrinth-Description.md | 34 ++++++++++++++++++++++++++++++++++ Modrinth.json | 13 +++++++++++++ README.md | 1 - TODO.md | 2 +- gradle.properties | 2 ++ 5 files changed, 50 insertions(+), 2 deletions(-) create mode 100644 Modrinth-Description.md create mode 100644 Modrinth.json diff --git a/Modrinth-Description.md b/Modrinth-Description.md new file mode 100644 index 0000000..f22c5f4 --- /dev/null +++ b/Modrinth-Description.md @@ -0,0 +1,34 @@ +**MobScores** + +MobScores awards ScoreKeeper points for configured mob kills. Set a score for each supported entity type and let ScoreKeeper track the player's total by UUID. + +## Requirements + +- Paper 1.21.7 or a compatible newer server. +- Java 25 or newer at runtime and for building. +- ScoreKeeper 0.2.2 or a compatible release. + +Install ScoreKeeper and MobScores in the server's `plugins` directory. ScoreKeeper is a required dependency and must be enabled for MobScores to load. + +## Configuration + +MobScores creates `plugins/MobScores/config.yml` from its defaults. Edit `ScoreTable` to configure point values by Bukkit `EntityType` name: + +```yaml +ScoreTable: + ZOMBIE: 25 + CREEPER: 50 + SILVERFISH: 0 +``` + +Set an entity's value to `0` to disable its points and hide it from the join-time score table. Restart the server after changing the configuration. + +## Scoring + +MobScores records credit for configured entity types damaged directly by a player or by a projectile fired by a player. When a credited player remains online when the entity dies, its configured points are added to that player's active ScoreKeeper bucket. Other mob attribution is not currently handled. + +MobScores has no commands of its own. Players see the nonzero score table when they join. + +## Build + +Run `./gradlew test` and `./gradlew build` from the project root. See [CONTRIBUTING.md](CONTRIBUTING.md) for development and local Paper testing instructions. diff --git a/Modrinth.json b/Modrinth.json new file mode 100644 index 0000000..89aac00 --- /dev/null +++ b/Modrinth.json @@ -0,0 +1,13 @@ +{ + "name": "MobScores", + "url": "https://modrinth.com/plugin/mobscores", + "summary": "Award ScoreKeeper points for configured mob kills with a customizable per-entity score table.", + "visibility": "public", + "links": { + "issueTracker": "https://github.com/headhunter45/MobScores/issues", + "sourceCode": "https://github.com/headhunter45/MobScores", + "wikiPage": null, + "discordInvite": null, + "donationLinks": [] + } +} diff --git a/README.md b/README.md index 523d381..f8e70a9 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,3 @@ MobScores has no commands of its own. It records credit for configured entity ty ## Build Run `./gradlew test` and `./gradlew build` from the project root. See [CONTRIBUTING.md](CONTRIBUTING.md) for toolchain, local server, and helper-script details. - diff --git a/TODO.md b/TODO.md index 1aa48ca..ab19fdf 100644 --- a/TODO.md +++ b/TODO.md @@ -8,7 +8,7 @@ | MS-04 | Done | Initialize Gradle in the project root and create a build.gradle file with project metadata, PaperMC API dependency, JUnit, Java toolchain, repository, resource handling, and plugins as needed. | | MS-05 | Done | Remove Maven-specific files (pom.xml, .mvn/ directory, Maven wrapper scripts) and Eclipse-specific files (.classpath, .project, .settings/) if present. | | MS-06 | Done | Update .gitignore to add Gradle-specific ignores and remove Maven/Eclipse-specific ignores. | -| MS-07 | Done |Ensure plugin.yml is present in src/main/resources and update for PaperMC compatibility (api-version, commands, required fields). | +| MS-07 | Done | Ensure plugin.yml is present in src/main/resources and update for PaperMC compatibility (api-version, commands, required fields). | | MS-08 | Done | Refactor all logger usage to use getLogger() from JavaPlugin. | | MS-09 | Done | Refactor all event listeners to use the modern event system (Listener interface, @EventHandler, registerEvents). | MS-10 | Done | Replace use of org.bukkit.util.config.Configuration with the modern configuration API (getConfig(), saveConfig(), etc.). diff --git a/gradle.properties b/gradle.properties index 6c7b086..6b7ae3f 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,3 +1,5 @@ org.gradle.java.installations.auto-download=true org.gradle.java.installations.auto-detect=false org.gradle.java.installations.fromEnv=JAVA_HOME +org.gradle.configuration-cache=true +org.gradle.daemon=true