From 74e2d4d1475e02b9059f1a6ed4dbadbc987cbeb3 Mon Sep 17 00:00:00 2001 From: AlexProgrammerDE <40795980+AlexProgrammerDE@users.noreply.github.com> Date: Thu, 5 Nov 2026 14:02:18 +0100 Subject: [PATCH] feat(branding): use Soulfire in the plugin example Update the example plugin display metadata, publication description, documentation, and contribution forms to Soulfire. Preserve plugin IDs, Java types and packages, artifact coordinates, and repository URLs. --- .github/ISSUE_TEMPLATE/bug-report.yml | 4 ++-- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/pull_request_template.md | 2 +- AGENTS.md | 2 +- CONTRIBUTING.md | 10 +++++----- README.md | 8 ++++---- SUPPORT.md | 6 +++--- build.gradle.kts | 2 +- .../pluginexample/ExampleServerExtension.java | 4 ++-- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index ef697fd..cec2d96 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -18,7 +18,7 @@ body: id: version attributes: label: Versions or revision - description: Example source revision and tested SoulFire version + description: Example source revision and tested Soulfire version validations: required: true - type: textarea @@ -30,7 +30,7 @@ body: Operating system: Java version: Example source revision: - SoulFire version: + Soulfire version: Minecraft and Fabric versions: Failed Gradle task or plugin load step: validations: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7603601..e3be1f7 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -14,4 +14,4 @@ contact_links: about: Report desktop or browser client bugs in the client repository. - name: Server and SDK issues url: https://github.com/soulfiremc-com/SoulFire/issues/new/choose - about: Report backend, bot behavior, protocol, and SDK problems in SoulFire. + about: Report backend, bot behavior, protocol, and SDK problems in Soulfire. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f3f3426..2ffd5d3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,7 +5,7 @@ ## Validation - + diff --git a/AGENTS.md b/AGENTS.md index a619771..1c2329e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,7 +7,7 @@ ## Branding and product language -Before naming features or changing user-facing text and visuals, read the [SoulFire brand guidance](https://github.com/soulfiremc-com/brand). +Before naming features or changing user-facing text and visuals, read the [Soulfire brand guidance](https://github.com/soulfiremc-com/brand). Use its terminology, naming, writing, and visual identity guides. Keep proposed renames separate from accepted guidance. Preserve public identifiers until the owning repository approves a migration. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 752e569..09f5502 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to SoulFirePluginExample -This repository demonstrates a SoulFire plugin and its mixin integration. +This repository demonstrates a Soulfire plugin and its mixin integration. This guide covers local development, validation, and pull requests. ## Before you start @@ -14,7 +14,7 @@ Report vulnerabilities privately through the [security policy](https://github.co ## Prepare and build Install Git and a JDK 25. Use the checked-in Gradle wrapper. -The build needs network access for Minecraft, Fabric, Gradle, and the SoulFire artifacts pinned in `gradle/libs.versions.toml`. +The build needs network access for Minecraft, Fabric, Gradle, and the Soulfire artifacts pinned in `gradle/libs.versions.toml`. Clone this repository or your fork, then run: ```bash @@ -30,14 +30,14 @@ This plugin is not a standalone Minecraft client. The build intentionally remove - `src/main/java/com/soulfiremc/pluginexample/`: plugin registration, server extension, and mixin code. - `src/main/resources/`: Fabric metadata, mixin configuration, and access widener. -- `gradle/libs.versions.toml`: Minecraft, Fabric loader, SoulFire, and Lombok pins. +- `gradle/libs.versions.toml`: Minecraft, Fabric loader, Soulfire, and Lombok pins. - `buildSrc/`: Java, licensing, formatting, and analysis conventions. Keep the example small enough for a new plugin author to understand. Explain new extension points and update README examples with behavior changes. Keep the Fabric entry points, mixin configuration, and access widener aligned with Java changes. Do not assume that the current server release matches the pinned example dependencies. -Include the exact tested SoulFire revision or release in your pull request. +Include the exact tested Soulfire revision or release in your pull request. For dependency upgrades, update related pins together and verify the plugin on that server version. ## Style and validation @@ -49,7 +49,7 @@ Keep license notices consistent with the material you change. Run `./gradlew build test spotlessCheck` before submission. The example currently has no dedicated test suite. The Gradle test task does not replace a plugin load check. -For changed behavior, add focused tests where practical and run the JAR on a local SoulFire instance. +For changed behavior, add focused tests where practical and run the JAR on a local Soulfire instance. Verify that the extension loads, its settings appear, and the changed behavior works on an owned test server. Include startup logs without credentials and describe any manual checks that you could not run. For dependency resolution failures, include the failed artifact coordinate and repository URL. diff --git a/README.md b/README.md index 74150eb..acfe84c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# SoulFirePluginExample +# Soulfire plugin example -Example of how to make a plugin for SoulFire. +Example of how to make a plugin for Soulfire. -This example adds a hack jump boost to SoulFire, which by default gives the bot jump boost with the amplifier 2. +This example adds a hack jump boost to Soulfire, which by default gives the bot jump boost with the amplifier 2. The amplifier and the plugin can be configured in the plugins menu under `Hack Jump Boost` and CLI flags are also registered. -Read the [SoulFire Java API reference](https://jd.soulfiremc.com). Match the API to the SoulFire version pinned in `gradle/libs.versions.toml`. +Read the [Soulfire Java API reference](https://jd.soulfiremc.com). Match the API to the Soulfire version pinned in `gradle/libs.versions.toml`. ## Development diff --git a/SUPPORT.md b/SUPPORT.md index a0d7932..8db7837 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -2,11 +2,11 @@ ## Questions and reports -Start with the [SoulFire documentation](https://soulfiremc.com/docs). +Start with the [Soulfire documentation](https://soulfiremc.com/docs). For setup and usage questions, ask in the [Discord community](https://soulfiremc.com/discord). For contribution setup, builds, and checks, read [CONTRIBUTING.md](CONTRIBUTING.md). -For example plugin reports, include the example revision, SoulFire version, Java version, and the failed build task or plugin load step. +For example plugin reports, include the example revision, Soulfire version, Java version, and the failed build task or plugin load step. Share reproduction steps and relevant text logs. Remove tokens, passwords, account data, proxy credentials, and bypass keys first. Search [open and closed issues](https://github.com/soulfiremc-com/SoulFirePluginExample/issues) before opening a report. @@ -16,7 +16,7 @@ Otherwise, use the [issue chooser](https://github.com/soulfiremc-com/SoulFirePlu ## Find the right project Use this repository for example plugin. -Use [SoulFire](https://github.com/soulfiremc-com/SoulFire/issues) for server, bot, protocol, or SDK problems. +Use [Soulfire](https://github.com/soulfiremc-com/SoulFire/issues) for server, bot, protocol, or SDK problems. Use [SoulFireClient](https://github.com/soulfiremc-com/SoulFireClient/issues) for desktop and browser client problems. Use [soulfiremc.com](https://github.com/soulfiremc-com/soulfiremc.com/issues) for published documentation and website problems. The [organization support directory](https://github.com/soulfiremc-com/.github/blob/main/SUPPORT.md) lists every project. diff --git a/build.gradle.kts b/build.gradle.kts index 394d671..36fd332 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -12,7 +12,7 @@ tasks.named("updateDaemonJvm") { allprojects { group = "com.soulfiremc" version = "1.0.0-SNAPSHOT" - description = "Example of how to make a plugin for SoulFire." + description = "Example of how to make a plugin for Soulfire." repositories { mavenLocal() maven("https://repo.viaversion.com") { diff --git a/src/main/java/com/soulfiremc/pluginexample/ExampleServerExtension.java b/src/main/java/com/soulfiremc/pluginexample/ExampleServerExtension.java index 0041dba..ff60049 100644 --- a/src/main/java/com/soulfiremc/pluginexample/ExampleServerExtension.java +++ b/src/main/java/com/soulfiremc/pluginexample/ExampleServerExtension.java @@ -37,8 +37,8 @@ public class ExampleServerExtension extends ExternalPlugin { protected ExampleServerExtension() { super(new PluginInfo( "soulfire-plugin-example", - "SoulFire Plugin Example", - "An example plugin for SoulFire Server", + "Soulfire Plugin Example", + "An example plugin for Soulfire Server", "AlexProgrammerDE", "1.0.0", "https://soulfiremc.com"