Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Validation

<!-- Record exact commands and results: ./gradlew build test spotlessCheck and plugin load checks on the named SoulFire version. -->
<!-- Record exact commands and results: ./gradlew build test spotlessCheck and plugin load checks on the named Soulfire version. -->
<!-- Include relevant versions, reproduction observations, or screenshots. Remove credentials and private data. -->
<!-- Explain any checks that you could not run. -->

Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 3 additions & 3 deletions SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tasks.named<UpdateDaemonJvm>("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") {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading