Skip to content

Commit

Permalink
Add more details to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
EsotericEnderman committed Oct 11, 2024
1 parent 85eff7d commit 7984cde
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
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.

0 comments on commit 7984cde

Please sign in to comment.