Repository navigation
Commands
Every ShamPlugin command, its arguments, permission node, and what it does.
[ ]optional argument ·< >required argument ·|one of several choices · (default) = the node's default value inplugin.yml.
| Command | What it does | Permission (default) |
|---|---|---|
/help [page] |
Shows the configured command list with hover + click-to-fill. Alias: /commands. |
shamplugin.help (true)
|
/map |
Sends the server's world-map link. Aliases: /servermap, /worldmap. |
shamplugin.map (true)
|
/streak |
Shows your login streak status. |
shamplugin.streak (true)
|
/streaktop |
Leaderboard of the highest current/active streaks. |
shamplugin.streak (true)
|
/higheststreaktop |
Leaderboard of the all-time highest streaks. |
shamplugin.streak (true)
|
/sham uptime [period] |
Shows server uptime statistics for a period (or all at once). |
shamplugin.uptime (true)
|
/sham streak |
Same as /streak — your own status. |
shamplugin.streak (true)
|
/sham streak get <player> |
Shows another player's streak status. |
shamplugin.streak.get.others (op)
|
/sham streak set <player> <value> [true|false] |
Sets a player's streak to <value>. Admin.
|
shamplugin.admin (op)
|
/sham streak reward <player> <type> |
Grants the configured streak reward for <type>. Admin — meant to be run by AxRewards. |
shamplugin.admin (op)
|
/sham debug alerts |
Tests Discord webhook alerts and shows alert/webhook info. Debug. |
shamplugin.debug (op)
|
/sham debug versionsupport |
Runs the version-support compatibility check (details to console). Debug. |
shamplugin.debug (op)
|
/version shamplugin |
Built-in server command — shows ShamPlugin's info from plugin.yml. Aliases: /ver, /about. |
bukkit.command.version (true)
|
The root command /sham with no arguments prints a usage list filtered to what you're allowed to run. All subcommands support tab completion.
Shows the configured list of commands as clickable, hoverable entries (hover = description, click = places the command in your chat input).
-
Argument:
[page]— page number (1,2, …). Omit to show page 1. -
Alias:
/commands -
Permission:
shamplugin.help(default: true) -
Config: The entries, layout, and hint text come from the
help:section ofconfig.yml(entries,lines-per-page,max-line-chars,max-per-line,force-second-item,show-help-hint,hint-page1-only,help-hint). -
Notes: When there is more than one page, clickable Prev / Next buttons are shown. Console output falls back to plain text (
command - descriptionper line).
Sends the server's world-map link (with an optional header) to the sender.
-
Aliases:
/servermap,/worldmap -
Permission:
shamplugin.map(default: true) -
Config:
map.urlandmap.headerinconfig.yml. Ifurlis empty, or still set to the placeholdermap.changeme.com, an admin-facing warning is shown instead.
Shows your own login streak status: available graces (x/max), time until grace reset, your active streak, and your highest streak.
-
Permission:
shamplugin.streak(default: true) -
Notes: Players only — the console cannot use this (it has no "self"). Equivalent to
/sham streak.
Shows a leaderboard of the highest current/active login streaks.
-
Permission:
shamplugin.streak(default: true) -
Config: Length set by
axrewards.login-streaks.leaderboard_display_length(1–100, default 10). Data refreshes everyleaderboard_update_interval_minutes. - Notes: Usable in the console as well.
Shows a leaderboard of the all-time highest login streaks ever recorded.
-
Permission:
shamplugin.streak(default: true) -
Config: Same keys as
/streaktop. - Notes: Usable in the console as well.
Shows server uptime statistics for a given period, or all periods at once when no argument is given.
-
Argument:
[period]— one of:day,week,month,year,all/alltime,24h,7d,30d,365d.- Short aliases also work, e.g.
d/today,w,m,y,a,1d,past7, etc. - Omit the argument (or use
all) to print every period in one go.
- Short aliases also work, e.g.
-
Permission:
shamplugin.uptime(default: true) -
Output per period:
Uptime - <label>: Up: <up> / Since start: <possible> (<percent>%). -
Config: Uptime tracking is controlled by the
uptime:section ofconfig.yml(enabled,flush-interval-seconds,retention-days,merge-gap-ms).
Same as /streak — shows your own login streak status.
-
Permission:
shamplugin.streak(default: true)
Shows another player's login streak status (graces, grace reset time, active and highest streak).
-
Argument:
<player>— target player name. -
Permission:
shamplugin.streak.get.others(default: op) — note this is a separate node from full admin; it does not requireshamplugin.admin. - Notes: Resolves the target (online or known) and reports if they can't be found.
Sets a player's login streak to <value>.
-
Arguments:
-
<player>— target player name. -
<value>— the new streak (integer, must be≥ 0). -
[true|false](optional) — "modify last claim". Default istrue. Set tofalseto leave the player's last-claim time unchanged.
-
-
Permission:
shamplugin.admin(default: op)
Grants a player their configured login-streak reward for <type>, executing the matching reward commands from config. Meant to be run by AxRewards (e.g. via its %player% placeholder) rather than typed manually.
-
Arguments:
-
<player>— target player name. -
<type>— a reward type defined underaxrewards.login-streaks.rewards.<type>inconfig.yml(for exampledaily,weekly).
-
-
Permission:
shamplugin.admin(default: op) -
How it picks the reward: It finds the highest configured bonus threshold that is ≤ the player's current streak and runs those commands. If
<type>.streakistrue, claiming also increments the streak.
Sends test logs at each level to the console so you can confirm Discord webhook alerts are firing, then displays the current alert settings and webhook info.
-
Permission:
shamplugin.debug(default: op) -
What it shows: whether Discord alerts are enabled, the configured
alert-level, which levels will be sent, plus (when available) the webhook name, channel ID, and server/guild ID. -
Config: Controlled by the
discord alerts:section ofconfig.yml(enabled,webhook-url,ping,ping-level,ignore). Ifenabled: false, it reports that alerts are disabled in config.
Runs the version-support compatibility check and writes detailed results to the console.
-
Permission:
shamplugin.debug(default: op) -
What it does: Fetches the project's
versions.jsonfrom GitHub and reports whether the current Minecraft version is supported, known broken, or untested for this plugin build (and warns when a Minecraft version no longer receives ShamPlugin updates).
A built-in Paper/Purpur command (not registered by ShamPlugin) that reports on any loaded plugin using its plugin.yml. With no argument it shows the server's own version; with a plugin name it shows that plugin's details.
-
Aliases:
/ver,/about -
Usage:
/version [plugin name]— e.g./version shamplugin. Matching is case-insensitive and accepts partial names, so/version shamworks too. -
Permission:
bukkit.command.version(default: true) -
What it shows for ShamPlugin (read from
plugin.yml):- Plugin name + version — e.g.
ShamPlugin version 26.3.0 - Description — this plugin sets it to the build time (
Build Time: …) - Website — the Modrinth project link
- Author(s) —
shamgamer
- Plugin name + version — e.g.
| Node | Default | Grants access to |
|---|---|---|
shamplugin.map |
true | /map |
shamplugin.help |
true | /help |
shamplugin.streak |
true |
/streak, /sham streak, /streaktop, /higheststreaktop
|
shamplugin.uptime |
true | /sham uptime |
shamplugin.streak.get.others |
op | /sham streak get <player> |
shamplugin.debug |
op | /sham debug … |
shamplugin.admin |
op |
/sham streak set, /sham streak reward (and bundles the nodes above) |
For the full plugin permissions check the permissions wiki page.