|
| 1 | +# Paper Trail |
| 2 | + |
| 3 | +**Paper Trail** is a helper library for |
| 4 | +notifying users of legacy server software |
| 5 | +that a plugin requires Paper. |
| 6 | +The main use case for this library |
| 7 | +is for plugins that utilize the new |
| 8 | +Paper plugin system (`paper-plugin.yml`) |
| 9 | +and do not support the legacy plugin system |
| 10 | +(`plugin.yml`). |
| 11 | + |
| 12 | +Paper Trail offers a simple way to notify users |
| 13 | +that they need to upgrade to Paper by providing |
| 14 | +a stub `JavaPlugin` that prints a helpful message |
| 15 | +on startup and then disables itself. |
| 16 | +An alternate message is used if the server is |
| 17 | +running Paper, but the version is too old to |
| 18 | +support the Paper plugin system. |
| 19 | + |
| 20 | +### How to Use |
| 21 | + |
| 22 | +Add the PaperMC repository (`https://repo.papermc.io/repository/maven-public/`) to your build script |
| 23 | +and shade `io.papermc:paper-trail:0.0.1-SNAPSHOT` |
| 24 | +into your plugin. |
| 25 | +It is recommended to relocate the `io.papermc.papertrail` |
| 26 | +package to avoid conflicts. |
| 27 | + |
| 28 | +To use Paper Trail, add a |
| 29 | +`plugin.yml` to your plugin with |
| 30 | +`io.papermc.papertrail.RequiresPaperPlugins` |
| 31 | +as the "main" class. |
| 32 | +If you relocated the package, be sure to adjust |
| 33 | +the class name in the yaml accordingly. |
| 34 | + |
| 35 | +### License |
| 36 | + |
| 37 | +Paper Trail is licensed under the MIT License. |
| 38 | +See the [LICENSE](LICENSE) file for more information. |
0 commit comments