trueog/AdvancedServerList-OG
2
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Andre601 committed 2024-02-16 11:13:50 +01:00
1 parent 27c3972ab0
commit c577264e1d
5 files changed
+55 -30
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/addons/advancedban.md
+25
View File
@@ -0,0 +1,25 @@
# AdvancedBan Addon
The AdvancedBan Addon is a plugin for BungeeCord that allows you to use placeholders for the Punishment status of a player, such as if they got punished, the reason and duration.
## Placeholders
| Placeholder | Description |
|-------------------------------|------------------------------------------------------------------------------------------------------|
| `${advancedban isMuted}` | Whether the player is muted or not. |
| `${advancedban isBanned}` | Whether the player is banned or not. |
| `${advancedban muteReason}` | The reason for the mute. |
| `${advancedban banReason}` | The reason for the ban. |
| `${advancedban muteDuration}` | The duration of the mute. `true` can be added to the placeholder to get the duration from the start. |
| `${advancedban banDuration}` | The duration of the ban. `true` can be added to the placeholder to get the duration from the start. |
## Example
```yaml title="banned.yml"
priority: 1
condition: '${advancedban isBanned}'
motd:
- '<red>You are <bold>BANNED'
- '<red>Reason: ${advancedban banReason}'
```
docs/addons/index.md
+28
View File
@@ -0,0 +1,28 @@
---
icon: octicons/plus-circle-24
---
# Addons
This section contains a curated list of add-ons for AdvancedServerList which can be used to enhance the plugin in different ways.
Do you have a plugin that hooks into AdvancedServerList that is not listed here? Contact Andre601 on Discord and it will be added!
## First-party Addons
These Addons are made by Andre601 and available together with the plugin downloads.
<div class="grid cards" markdown>
- [**AdvancedBan**](advancedban.md)
----
Addon to add placeholders for the BungeeCord version of [AdvancedBan](https://www.spigotmc.org/resources/8695/){ target="_blank" rel="nofollow" } into AdvancedServerList.
</div>
## Third-party
Third-party addons made by other people not working on AdvancedServerList.
*Currently no entries*
docs/getting-started/index.md
+1 -1
View File
@@ -408,7 +408,7 @@ Inside the file, add a priority and at least one setting, similar to the above s
This would already be enough to have a valid profile, but depending on the priority and file name may the file not be used, or used over other profiles.
If you want to only show this file under specific situations can you use the [`condition`](../profiles/index.md#condition) option to apply conditions that need to be met to show the profile.
The condition option would have a single String containing one or muliple [Expressions](../profiles/expressions). Only if the condition would return true, would the profile be displayed, granted that it has a higher priority than any other valid file with a true condition output.
The condition option would have a single String containing one or muliple [Expressions](../profiles/expressions.md). Only if the condition would return true, would the profile be displayed, granted that it has a higher priority than any other valid file with a true condition output.
/// info | Note
Profiles which do not have any conditions, or have an empty condition, will always considered to have a true condition, meaning that a profile with higher priority and no condition will be selected over a profile with lower priority and a condition, even if said condition returns true.
docs/profiles/expressions.md
+1 -2
View File
@@ -132,5 +132,4 @@ Parenthesis can be used to prevent ambiguities.
## Credits
This page, including examples used, was adobted from the BungeeTabListPlus wiki.
The original wiki page can be found here: https://github.com/CodeCrafter47/BungeeTabListPlus/wiki/Expressions{ target="_blank" rel="nofollow" }
This page, including some examples used, was adobted from [:octicons-book-24: CodeCrafter47/BungeeTabListPlus/wiki](https://github.com/CodeCrafter47/BungeeTabListPlus/wiki/Expressions){ target="_blank" rel="nofollow" }.
docs/profiles/index.md
-27
View File
@@ -40,33 +40,6 @@ Not setting this option, or setting it to an empty String (`condition: ''`), wil
The condition option can hold one or multiple expressions. The Expression system is explained on the [Expressions page](expressions.md).
## Conditions :octicons-trash-24:{ style="color: #FF5252;" title="Deprecated" }
<!-- admo:deprecated Deprecated in favour of the new condition option. Will be removed in a future version. -->
The `conditions` option - not to be confused with the new [`condition`](#condition) option - allows you to define one or multiple conditions/expressions that all need to return `true` in order for the profile to be used.
Not setting this option, or setting it to an empty list (`conditions: []`), will result in `true` being returned.
Each condition can use [placeholders](placeholders.md) to further customize it. PlaceholderAPI placeholders are **not** supported!
### Operands
<!-- admo:warning Each condition can only hold one operand -->
Each condition can use operands to compare values with each other.
Note that if Operands are used that compare sizes (i.e. `>`) while the values are Text and not numbers will the text length be used as number.
| Operand | What it does |
|---------|----------------------------------------------------------------------------|
| `<` | Returns true if the left value is less than the right value. |
| `<=` | Returns true if the left value is less than, or equal to, the right value. |
| `>` | Returns true if the left value is more than the right value. |
| `>=` | Returns true if the left value is less than, or equal to, the right value. |
| `=` | Returns true if both values are equal (Case sensitive). |
| `!=` | Returns true if both values are not equal (Case sensitive). |
| `~=` | Returns true if both values are equal (Not case sensitive). |
| `!~` | Returns true if both values are not equal (Not case sensitive). |
## Profiles
The `profile` option allows you to define a list of all other options, with the exception of [`priority`](#priority), [`condition`](#condition) or itself.