-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
46 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,45 @@ | ||
# B1.7.3-Poseidon-Plugin-Template | ||
This repository is a Maven template for B1.7.3 plugins for RetroMC | ||
# Poseidon-Plugin-Template | ||
|
||
This repository serves as a template to assist with creating plugins for Project Poseidon. | ||
|
||
It includes examples of: | ||
- A configuration file. | ||
- A listener. | ||
- A command. | ||
|
||
## Steps to Use This Template | ||
|
||
1. **Clone the Repository** | ||
- Clone this repository to your local machine. | ||
|
||
2. **Modify `pom.xml`** | ||
- Update the following fields to reflect your plugin: | ||
- `name` | ||
- `version` | ||
- `description` | ||
- **Note:** Removing `-SNAPSHOT` from the version will trigger the `release.yml` GitHub Action to create a GitHub release. | ||
|
||
3. **Refactor Package Structure** | ||
- Refactor the package `org.retromc.templateplugin` to a unique package name for your plugin to avoid conflicts. | ||
|
||
4. **Update `plugin.yml`** | ||
- Update the `plugin.yml` file to match the refactored package name and plugin metadata. | ||
|
||
5. **Modify the Code** | ||
- Customize the code as required for your plugin. | ||
- **Important:** | ||
- Remove the player greeting example in the listener. | ||
- Remove the test command. | ||
|
||
## GitHub Actions | ||
|
||
This repository includes a pre-configured GitHub Action: | ||
|
||
1. **`build-and-test.yml`**: | ||
- Runs tests on every push to ensure code quality. | ||
- Uploads an artifact for each commit, allowing others to download the plugin for testing. | ||
|
||
2. **`release.yml`**: | ||
- Automatically creates a GitHub release if the `-SNAPSHOT` suffix is removed from the version in `pom.xml`. | ||
|
||
With this template, you can kickstart your plugin development for Project Poseidon quickly and efficiently. |