forked from PaperMC/paperweight-test-plugin
-
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
1 parent
85eff7d
commit 7984cde
Showing
1 changed file
with
16 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,19 @@ | ||
# Template Paper Plugin | ||
|
||
> A template repository for easily developing Minecraft Paper plugins. | ||
## Usage | ||
|
||
### Using This Template | ||
|
||
1. Create a new repository by clicking on the "Use this template" button on GitHub. | ||
2. Clone the new repository and open it in your code editor of choice. | ||
3. Run the command `./gradlew renameProject -Pnew-name="New Plugin Name" -Pnew-author-name="New Author Name" -Pnew-top-level-domain="New Top Level Domain"` to update the project details. | ||
|
||
### Running a Testing Server With The Plugin Installed | ||
|
||
Follow [the steps above](#using-this-template) and run `./gradlew runServer` | ||
|
||
### Building | ||
|
||
Follow [the steps above](#using-this-template) and run `./gradlew build`. The jar file will be in the `build/libs` directory. |