Skip to content

Commit 43916b2

Browse files
committed
add a FAQ for those who are stupid enough to not differentiate between offline and cracked players
1 parent 351c856 commit 43916b2

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

src/topper/faq/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,17 @@ For example, if you want to display the LuckPerms prefix (`%luckperms_prefix%`)
9999
%parseother_unsafe_{topper_jump;top_name;1}_{luckperms_prefix}%
100100
```
101101

102+
## Should I set `online` to `false` in PlaceholderAPI Value Provider?
103+
104+
In most cases, you should **NOT** set `online` to `false` to avoid many issues.
105+
106+
The `online` option behaves as follows:
107+
- `true`: The plugin will **ONLY** update values for the players who are **online (in the server)**. The plugin will **NOT** update values for the players who are **offline (not in the server)**
108+
+ It **DOES NOT** mean the plugin will **remove** the values for the players who are **offline (not in the server)**
109+
- `false`: The plugin will try to update values for **all players**, regardless of whether those players are **online (in the server)** or **offline (not in the server)**
110+
+ It **DOES NOT** mean it is necessary to make it work with **offline-mode / cracked servers**
111+
+ **ONLY** set if you are sure your placeholder **works** for the players who are **offline (not in the server)**
112+
102113
## I am so confused about how to use Topper
103114

104115
Take a deep breath and read the wiki again. You should take it slow and read the wiki carefully as you can miss some

src/topper/provider/placeholder/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ holders:
4040
#
4141
# Setting "online" to true ONLY means the plugin would stop updating values for players who are not in the server.
4242
# It DOES NOT mean the plugin would remove the value if the player is offline.
43-
# It DOES NOT mean that is necessary to make it work with offline-mode / cracked servers.
43+
# It DOES NOT mean that is necessary to set it to false to make it work with offline-mode / cracked servers.
4444
online: <true/false>
4545
```
4646
4747
> [!IMPORTANT]
4848
> Setting `online` to `true` **ONLY** means the plugin would stop updating values for players who are not in the server.
4949
> It **DOES NOT** mean the plugin would remove the value if the player is offline.
50-
> It **DOES NOT** mean that is necessary to make it work with offline-mode / cracked servers.
50+
> It **DOES NOT** mean that is necessary to set it to `false` to make it work with offline-mode / cracked servers.
5151

5252
== FabricMC
5353
> [!NOTE]

0 commit comments

Comments
 (0)