Skip to content
This repository has been archived by the owner on Apr 9, 2024. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Andre601 committed Sep 12, 2023
1 parent deec676 commit 91ea80f
Show file tree
Hide file tree
Showing 8 changed files with 78 additions and 36 deletions.
7 changes: 7 additions & 0 deletions docs/.overrides/api-doc.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
{% extends "base.html" %}
{% import "api-objects/info-template.html" as info %}

{% if config.extra.github_repository %}
{% block announce %}
The documenation has been moved and can now be found at <a href="https://asl.andre601.ch" target="_blank" rel="noreferral nofollow noopener"><strong>asl.andre601.ch</strong></a>.<br>
This page in particular can be found at <a href="https://asl.andre601.ch/{{ page.url }}" target="_blank" rel="noreferral nofollow noopener"><strong>asl.andre601.ch/{{ page.url }}</strong></a>.
{% endblock %}
{% endif %}

{% block content %}
{% include "partials/content.html" %}
{% if page.meta %}
Expand Down
4 changes: 2 additions & 2 deletions docs/.overrides/main.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{% extends "base.html" %}

{% if config.extra.github_repository %}
{% if config.extra.github_repository and (config.extra.github_repository != "False") %}
{% block announce %}
The documenation has been moved towards <a href="https://asl.andre601.ch" target="_blank" rel="noreferral nofollow noopener"><strong>asl.andre601.ch</strong></a>.<br>
The documenation has been moved and can now be found at <a href="https://asl.andre601.ch" target="_blank" rel="noreferral nofollow noopener"><strong>asl.andre601.ch</strong></a>.<br>
This page in particular can be found at <a href="https://asl.andre601.ch/{{ page.url }}" target="_blank" rel="noreferral nofollow noopener"><strong>asl.andre601.ch/{{ page.url }}</strong></a>.
{% endblock %}
{% endif %}
7 changes: 3 additions & 4 deletions docs/.pages.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
nav:
- Home:
- index.md
- commands.md
- Home: index.md
- commands
- profiles
- examples
- migration
- api
- placeholderapi
- PlaceholderAPI: placeholderapi
File renamed without changes.
59 changes: 40 additions & 19 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,52 @@ Welcome to the Wiki of AdvancedServerList!
On this site can you find the latest documentation for the plugin, including some useful examples.
If you're new to the plugin is it recommended to check out the [Profiles page](profiles/index.md) for a quick start on how to use this plugin.

## Downloads

[![modrinth-img]{ width="260" loading="lazy" }][modrinth-download]{ target="_blank" rel="noreferrer nofollow noopener" }
[![hangar-img]{ width="260" loading="lazy" }][hangar-download]{ target="_blank" rel="noreferrer nofollow noopener" }

[modrinth-img]: https://cdn.jsdelivr.net/gh/Andre601/devins-badges@13e0142/assets/compact/available/modrinth_vector.svg "Available on Modrinth"
[hangar-img]: https://cdn.jsdelivr.net/gh/Andre601/devins-badges@13e0142/assets/compact/available/hangar_vector.svg "Available on Hangar"

[modrinth-download]: https://modrinth.com/plugin/advancedserverlist
[hangar-download]: https://hangar.papermc.io/Andre_601/AdvancedServerList

## Platforms

AdvancedServerList supports the following platforms:

[![spigot-img](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/spigot_vector.svg "Tested on Spigot"){ width=64 }][spigot]
[![paper-img](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/paper_vector.svg "Tested on Paper"){ width=64 }][paper]
[![bungeecord-img](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/bungeecord_vector.svg "Tested on BungeeCord"){ width=64 }][spigot]
[![waterfall](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/waterfall_vector.svg "Tested on Waterfall"){ width=64 }][paper]
[![velocity](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/velocity_vector.svg "Tested on Velocity"){ width=64 }][velocity]
[![spigot-img]{ width="64" loading="lazy" }][spigot]
[![paper-img]{ width="64" loading="lazy" }][paper]
[![bungeecord-img]{ width="64" loading="lazy" }][spigot]
[![waterfall-img]{ width="64" loading="lazy" }][paper]
[![velocity-img]{ width="64" loading="lazy" }][velocity]

[spigot-img]: https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/spigot_vector.svg "Tested on Spigot"
[paper-img]: https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/paper_vector.svg "Tested on Paper"
[bungeecord-img]: https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/bungeecord_vector.svg "Tested on BungeeCord"
[waterfall-img]: https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/waterfall_vector.svg "Tested on Waterfall"
[velocity-img]: https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact-minimal/supported/velocity_vector.svg "Tested on Velocity"

[spigot]: https://www.spigotmc.org
[paper]: https://papermc.io
[velocity]: https://velocitypowered.com

## Dependencies

| Dependency | Platforms | Required? |
|------------------|---------------|-----------|
| [ProtocolLib] | Spigot | Yes |
| [PlaceholderAPI] | Spigot, Paper | No |
| [ViaVersion] | Spigot, Paper | No |
| Dependency | Platforms | Required? |
|-------------------------------------------------------------------------|----------------------|-----------|
| [ProtocolLib]{ target="_blank" rel="noreferrer nofollow noopener" } | Spigot | Yes |
| [PlaceholderAPI]{ target="_blank" rel="noreferrer nofollow noopener" } | Spigot, Paper | No |
| [ViaVersion]{ target="_blank" rel="noreferrer nofollow noopener" } | Spigot, Paper | No |
| [PAPIProxyBridge]{ target="_blank" rel="noreferrer nofollow noopener" } | BungeeCord, Velocity | No |
| [Maintenance]{ target="_blank" rel="noreferrer nofollow noopener" } | All | No |

[protocollib]: https://www.spigotmc.org/resources/1997/
[placeholderapi]: https://www.spigotmc.org/resources/6245/
[viaversion]: https://www.spigotmc.org/resources/19254/
[papiproxybridge]: https://hangar.papermc.io/William278/PAPIProxyBridge
[maintenance]: https://hangar.papermc.io/kennytv/Maintenance

## Pages

Expand All @@ -39,12 +68,4 @@ AdvancedServerList supports the following platforms:
- [Migration](migration/index.md)
- [v1.5.3 to v1.6.0](migration/v1_5_3-to-v1_6_0.md)
- [v1.9.0 to v1.10.0](migration/v1_9_0-to-v1_10_0.md)
- [PlaceholderAPI](placeholderapi/index.md)

[spigot]: https://www.spigotmc.org
[paper]: https://papermc.io
[velocity]: https://velocitypowered.com

[protocollib]: https://www.spigotmc.org/resources/1997/
[placeholderapi]: https://www.spigotmc.org/resources/6245/
[viaversion]: https://www.spigotmc.org/resources/19254/
- [PlaceholderAPI](placeholderapi/index.md)
26 changes: 20 additions & 6 deletions docs/placeholderapi/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,19 @@
icon: material/percent
---

# PlaceholderAPI Placeholders
# PlaceholderAPI Placeholder support

The Spigot and Paper version of AdvancedServerList provide their own set of placeholders to use through [PlaceholderAPI].
AdvancedServerList provides support for [PlaceholderAPI] placeholders to be used, while also providing its own set of placeholders.

## Placeholders
[placeholderapi]: https://www.spigotmc.org/resources/6245/

!!! note
AdvancedServerList will try to find a matching Profile for the player similar to when they ping the server when using any of the below placeholders.
## Own placeholders

The following list of placeholders is available for use through PlaceholderAPI.
Please note that they are only available through the Bukkit version of AdvancedServerList.

Also note, that AdvancedServerList will try to find and use a [Server List profile](../profiles/index.md) that has maching conditions for the player, before returning any placeholder values.
This means that the output of a placeholder depends on what profile (if any) matches for the player.

| Placeholder | Description |
|---------------------------|-------------------------------------------------------------------------------|
Expand All @@ -19,4 +24,13 @@ The Spigot and Paper version of AdvancedServerList provide their own set of plac
| `%asl_playercount_hover%` | Gives the value of `playerCount.hover` from a matching Profile. |
| `%asl_playercount_text%` | Gives the value of `playerCount.text` from a matching Profile. |

[placeholderapi]: https://www.spigotmc.org/resources/6245/
## Using Placeholders in Server List profiles

You can use any PlaceholderAPI placeholder in a server list profile, if the following conditions are met:

- The placeholder does not require the player to be online.
- [PAPIProxyBridge] is installed alongside AdvancedServerList, if used on a Proxy.

To use a placeholder, simply use its default `%identifier_parameters%` format.

[papiproxybridge]: https://hangar.papermc.io/William278/PAPIProxyBridge
5 changes: 1 addition & 4 deletions docs/profiles/placeholders.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,7 @@ These placeholders use values given by the server/proxy AdvancedServerList runs

## PlaceholderAPI

The Spigot and Paper version of AdvancedServerList allow the usage of *any* placeholders provided by PlaceholderAPI by using the `%<identifier>_<values>%` placeholder format.
Depending on the placeholder used is a cached player required (i.e. `%player_name%`). AdvancedServerList will try to get a OfflinePlayer instance based on the cached UUID from the server to manage this.

!!! warning "PlaceholderAPI placeholders can NOT be used in Conditions!"
Please visit the [PlaceholderAPI page](../placeholderapi/index.md) for how AdvancedServerList works with PlaceholderAPI.

## Custom Placeholders

Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,14 @@ extra_javascript:
- assets/js/repo-stats.js

extra:
github_repository: !ENV [GITHUB_REPO_INSTANCE, false]
github_repository: !ENV [GITHUB_REPO_INSTANCE, False]
social:
- icon: 'simple/codeberg'
link: 'https://codeberg.org/Andre601/AdvancedServerList'
- icon: 'simple/modrinth'
link: 'https://modrinth.com/plugin/advancedserverlist'
- icon: 'fontawesome/solid/paper-plane'
link: 'https://hangar.papermc.io/Andre_601/AdvancedServerList'

plugins:
- search
Expand Down

0 comments on commit 91ea80f

Please sign in to comment.