Upstream/PlaceholderAPI
1
0
Fork 0
mirror of https://github.com/PlaceholderAPI/PlaceholderAPI.git synced 2024-07-02 01:24:59 +02:00
Code Issues Projects Releases Wiki Activity
04f2c85722
PlaceholderAPI/README.md

51 lines
2.6 KiB
Markdown
Raw Normal View History

Links can be made like that
2019-01-22 16:10:52 +01:00
[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues
[licenseImg]: https://img.shields.io/github/license/PlaceholderAPI/PlaceholderAPI.svg
[license]: https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/LICENSE
[releaseImg]: https://img.shields.io/github/release/PlaceholderAPI/PlaceholderAPI.svg?label=github%20release
[release]: https://github.com/PlaceholderAPI/PlaceholderAPI/releases/latest
[discord]: https://helpch.at/discord
[spigot]: https://www.spigotmc.org/resources/6245/
[Expansions cloud]: https://api.extendedclip.com/home
[placeholder list]: https://helpch.at/placeholders
[statistics]: https://bstats.org/plugin/bukkit/PlaceholderAPI
[ci]: http://ci.extendedclip.com/job/PlaceholderAPI/
[ciImg]: http://ci.extendedclip.com/buildStatus/icon?job=PlaceholderAPI
Update API version badge
2020-08-01 20:51:48 +02:00
[APIversionImg]: https://img.shields.io/nexus/placeholderapi/me.clip/placeholderapi?server=https%3A%2F%2Frepo.extendedclip.com&label=API%20Version
Links can be made like that
2019-01-22 16:10:52 +01:00
[logo]: https://i.imgur.com/Ea4PURv.png
Pull latest changes from master into docs/wiki (#712) * Update Javadoc documentation * More comments... a lot more! * Remove Gson * Implemented working version for 1.8.8 - 1.16.3 * Improve ExpansionsLoadedEvent's docs * 2021 🥳 * Add contributing and expansion section * Fix invalid link tag * Start using new Issue template system * Create bug_report.yml * Rename feature_request.md to feature_request_old.md * Create feature_request.yml * should it use setBracketPlaceholders?? * fix unique name * Update feature_request_old.md * Add Checkboxes * Add checkboxes * disable default issue body * Delete bug_report_old.md * Delete feature_request_old.md * Rename bug_report_new.yml to bug_report.yml * Check if deleting this fixed the PR... * Use description in favour of about * improve feature_request.md * Update bug_report.yml * Assign "Type: Issue (Unconfirmed)" label * Use lists and not comma-separated string * Update feature_request.yml * Use id option for error and dump fields * Add field for logs * Update Copyright ~ Fixed a typo and updated missed files from #543 * Re-add removed code That should actually NOT be here... * Undo renaming of boolean * Remove deprecated issue_body type * Update feature_request.yml * Improve description of bug_report.yml * Build jars on PR (Compile and build validation) * Initial 1.17 Changes * Extracted URLClassLoader out of try-with-resources block * Close URLClassLoader if Expansion class was not found * Build against Java 8, 11 and 16 * adoPt I always make that mistake... * add render * Cleanup build.gradle (cherry picked from commit 7750ba7033dc9fdf40d55fcd9ecc20a94819a7c1) * Remove the @NotNull's because they are overridden by expansion devs anyways, and it turns out people can make them null anyways. This adds a hashcode check and pretty error for it. (cherry picked from commit f5386d4ca55c23b54f3c5f952f08040b0967f4a3) * Fix version checker to compare the individual semver numbers instead of combining it together. (cherry picked from commit ef5cd9d37680cc6cc1321ef2e04af09b44a2c681) * Update src/main/java/me/clip/placeholderapi/updatechecker/UpdateChecker.java Co-authored-by: Andre_601 <11576465+Andre601@users.noreply.github.com> (cherry picked from commit ccf4f5934386b005831757d298e2da9d8f46cb1a) * Re-add NotNull's (cherry picked from commit 2bfd8e7e5efb25f648b8a6de934b1eff675481b1) * Removed nullcheck from hashcode, and moved it up the chain. * POJO to help with checking that expansions have all required methods implemented. * Add method implementation checking and nullchecking for fields. * Appease the Pigman * Revert build.gradle dependencies change * Fixed duplicate files * Sync Dev with master (#659) * Add contributing and expansion section * Start using new Issue template system * Create bug_report.yml * Rename feature_request.md to feature_request_old.md * Create feature_request.yml * fix unique name * Update feature_request_old.md * Add Checkboxes * Add checkboxes * disable default issue body * Delete bug_report_old.md * Delete feature_request_old.md * Rename bug_report_new.yml to bug_report.yml * Check if deleting this fixed the PR... * Use description in favour of about * improve feature_request.md * Update bug_report.yml * Assign "Type: Issue (Unconfirmed)" label * Use lists and not comma-separated string * Update feature_request.yml * Use id option for error and dump fields * Add field for logs * Remove deprecated issue_body type * Update feature_request.yml * Improve description of bug_report.yml * Initial 1.17 Changes * add render * Revert build.gradle dependencies change * Fixed duplicate files Co-authored-by: PiggyPiglet <PiggyPiglet@users.noreply.github.com> Co-authored-by: darbyjack <admin@glaremasters.me> * Initial test on adventure * started moving to pure adventure * finished kyori impl * added 1.17 to nmsversion (what does this even do) * removed dev for release * added dev back * Switch to differen wiki action Co-authored-by: darbyjack <admin@glaremasters.me> Co-authored-by: ElijahRus250 <64851720+ElijahRus250@users.noreply.github.com> Co-authored-by: PiggyPiglet <PiggyPiglet@users.noreply.github.com> Co-authored-by: Huynh Tien <huynhqtienvtag@gmail.com> Co-authored-by: Vaishnav Anil <vaishnavanil7th@gmail.com> Co-authored-by: Starmism <iamstarmism@gmail.com> Co-authored-by: PiggyPiglet <noreply@piggypiglet.me>
2021-09-09 18:31:29 +02:00
[contributing]: https://github.com/PlaceholderAPI/PlaceholderAPI/blob/master/.github/CONTRIBUTING.md
[placeholderexpansion]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/PlaceholderExpansion
Links can be made like that
2019-01-22 16:10:52 +01:00
<!-- The stuff above isn't visible in the readme -->
Updated README (#3) * Updated README.md Added a bit of formatting, some links, and the PAPI logo. Information on contributing and developing expansions still needs to be added, but that could possibly be added into the Wiki? * Updated README.md Added link to the logo image, and moved CI link to the end of the file.
2018-03-23 06:02:49 +01:00
Links can be made like that
2019-01-22 16:10:52 +01:00
[![logo]][spigot]
[![ciImg]][ci] [![releaseImg]][release] ![APIversionImg] [![licenseImg]][license]
Updated README (#3) * Updated README.md Added a bit of formatting, some links, and the PAPI logo. Information on contributing and developing expansions still needs to be added, but that could possibly be added into the Wiki? * Updated README.md Added link to the logo image, and moved CI link to the end of the file.
2018-03-23 06:02:49 +01:00
# Information
[PlaceholderAPI][spigot] is a plugin for Spigot servers that allows server owners to display information from various plugins with a uniform format.
Update README.md Updated stats
2019-06-25 21:01:08 +02:00
Support for specific plugins are provided either by the plugin itself or through expansions. The expansions may be downloaded in-game through the PAPI Expansion Cloud. There are currently over 150+ expansions that support a wide variety of plugins, such as Essentials, Factions, LuckPerms, and Vault.
Updated README (#3) * Updated README.md Added a bit of formatting, some links, and the PAPI logo. Information on contributing and developing expansions still needs to be added, but that could possibly be added into the Wiki? * Updated README.md Added link to the logo image, and moved CI link to the end of the file.
2018-03-23 06:02:49 +01:00
Brag a bit more about this
2021-01-24 17:35:30 +01:00
PlaceholderAPI has been downloaded over 500,000 times and has been used concurrently on over 20,000 servers, which makes it a must-have for a server of any type or scale.
Updated README (#3) * Updated README.md Added a bit of formatting, some links, and the PAPI logo. Information on contributing and developing expansions still needs to be added, but that could possibly be added into the Wiki? * Updated README.md Added link to the logo image, and moved CI link to the end of the file.
2018-03-23 06:02:49 +01:00
Pull latest changes from master into docs/wiki (#712) * Update Javadoc documentation * More comments... a lot more! * Remove Gson * Implemented working version for 1.8.8 - 1.16.3 * Improve ExpansionsLoadedEvent's docs * 2021 🥳 * Add contributing and expansion section * Fix invalid link tag * Start using new Issue template system * Create bug_report.yml * Rename feature_request.md to feature_request_old.md * Create feature_request.yml * should it use setBracketPlaceholders?? * fix unique name * Update feature_request_old.md * Add Checkboxes * Add checkboxes * disable default issue body * Delete bug_report_old.md * Delete feature_request_old.md * Rename bug_report_new.yml to bug_report.yml * Check if deleting this fixed the PR... * Use description in favour of about * improve feature_request.md * Update bug_report.yml * Assign "Type: Issue (Unconfirmed)" label * Use lists and not comma-separated string * Update feature_request.yml * Use id option for error and dump fields * Add field for logs * Update Copyright ~ Fixed a typo and updated missed files from #543 * Re-add removed code That should actually NOT be here... * Undo renaming of boolean * Remove deprecated issue_body type * Update feature_request.yml * Improve description of bug_report.yml * Build jars on PR (Compile and build validation) * Initial 1.17 Changes * Extracted URLClassLoader out of try-with-resources block * Close URLClassLoader if Expansion class was not found * Build against Java 8, 11 and 16 * adoPt I always make that mistake... * add render * Cleanup build.gradle (cherry picked from commit 7750ba7033dc9fdf40d55fcd9ecc20a94819a7c1) * Remove the @NotNull's because they are overridden by expansion devs anyways, and it turns out people can make them null anyways. This adds a hashcode check and pretty error for it. (cherry picked from commit f5386d4ca55c23b54f3c5f952f08040b0967f4a3) * Fix version checker to compare the individual semver numbers instead of combining it together. (cherry picked from commit ef5cd9d37680cc6cc1321ef2e04af09b44a2c681) * Update src/main/java/me/clip/placeholderapi/updatechecker/UpdateChecker.java Co-authored-by: Andre_601 <11576465+Andre601@users.noreply.github.com> (cherry picked from commit ccf4f5934386b005831757d298e2da9d8f46cb1a) * Re-add NotNull's (cherry picked from commit 2bfd8e7e5efb25f648b8a6de934b1eff675481b1) * Removed nullcheck from hashcode, and moved it up the chain. * POJO to help with checking that expansions have all required methods implemented. * Add method implementation checking and nullchecking for fields. * Appease the Pigman * Revert build.gradle dependencies change * Fixed duplicate files * Sync Dev with master (#659) * Add contributing and expansion section * Start using new Issue template system * Create bug_report.yml * Rename feature_request.md to feature_request_old.md * Create feature_request.yml * fix unique name * Update feature_request_old.md * Add Checkboxes * Add checkboxes * disable default issue body * Delete bug_report_old.md * Delete feature_request_old.md * Rename bug_report_new.yml to bug_report.yml * Check if deleting this fixed the PR... * Use description in favour of about * improve feature_request.md * Update bug_report.yml * Assign "Type: Issue (Unconfirmed)" label * Use lists and not comma-separated string * Update feature_request.yml * Use id option for error and dump fields * Add field for logs * Remove deprecated issue_body type * Update feature_request.yml * Improve description of bug_report.yml * Initial 1.17 Changes * add render * Revert build.gradle dependencies change * Fixed duplicate files Co-authored-by: PiggyPiglet <PiggyPiglet@users.noreply.github.com> Co-authored-by: darbyjack <admin@glaremasters.me> * Initial test on adventure * started moving to pure adventure * finished kyori impl * added 1.17 to nmsversion (what does this even do) * removed dev for release * added dev back * Switch to differen wiki action Co-authored-by: darbyjack <admin@glaremasters.me> Co-authored-by: ElijahRus250 <64851720+ElijahRus250@users.noreply.github.com> Co-authored-by: PiggyPiglet <PiggyPiglet@users.noreply.github.com> Co-authored-by: Huynh Tien <huynhqtienvtag@gmail.com> Co-authored-by: Vaishnav Anil <vaishnavanil7th@gmail.com> Co-authored-by: Starmism <iamstarmism@gmail.com> Co-authored-by: PiggyPiglet <noreply@piggypiglet.me>
2021-09-09 18:31:29 +02:00
## Contribute
If you would like to contribute towards PlaceholderAPI should you take a look at our [Contributing file][contributing] for the ins and outs on how you can do that and what you need to keep in mind.
## Create an Expansion
If you would like to create your own Placeholder Expansion for PlaceholderAPI, take a look at our [Wiki][placeholderexpansion] which contains a detailed tutorial on how you can achieve this.
Updated README (#3) * Updated README.md Added a bit of formatting, some links, and the PAPI logo. Information on contributing and developing expansions still needs to be added, but that could possibly be added into the Wiki? * Updated README.md Added link to the logo image, and moved CI link to the end of the file.
2018-03-23 06:02:49 +01:00
## Support
- [Issue Tracker][issues]
- [Discord Support][discord]
## Quick Links
- [CI Server][ci]
Update README
2020-09-28 17:23:25 +02:00
- [Expansions Cloud]
Updating links
2019-01-02 18:08:39 +01:00
- [Placeholder List]
Updated README (#3) * Updated README.md Added a bit of formatting, some links, and the PAPI logo. Information on contributing and developing expansions still needs to be added, but that could possibly be added into the Wiki? * Updated README.md Added link to the logo image, and moved CI link to the end of the file.
2018-03-23 06:02:49 +01:00
- [Spigot Page][spigot]
- [Plugin Statistics][statistics]
Reference in New Issue Copy Permalink