Commands - shamgamer/ShamPlugin GitHub Wiki

Commands (v26.3.0)

Every ShamPlugin command, its arguments, permission node, and what it does.

Legend

[ ] optional argument ยท < > required argument ยท | one of several choices ยท (default) = the node's default value in plugin.yml.

Quick Reference

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.


Player Commands

/help [page]

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 of config.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 - description per line).

/map

Sends the server's world-map link (with an optional header) to the sender.

  • Aliases: /servermap, /worldmap
  • Permission: shamplugin.map (default: true)
  • Config: map.url and map.header in config.yml. If url is empty, or still set to the placeholder map.changeme.com, an admin-facing warning is shown instead.

/streak

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.

/streaktop

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 every leaderboard_update_interval_minutes.
  • Notes: Usable in the console as well.

/higheststreaktop

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.

Uptime

/sham uptime [period]

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.
  • 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 of config.yml (enabled, flush-interval-seconds, retention-days, merge-gap-ms).

Streak management (staff)

/sham streak

Same as /streak โ€” shows your own login streak status.

  • Permission: shamplugin.streak (default: true)

/sham streak get <player>

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 require shamplugin.admin.
  • Notes: Resolves the target (online or known) and reports if they can't be found.

/sham streak set <player> <value> [true|false]

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 is true. Set to false to leave the player's last-claim time unchanged.
  • Permission: shamplugin.admin (default: op)

/sham streak reward <player> <type>

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 under axrewards.login-streaks.rewards.<type> in config.yml (for example daily, 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>.streak is true, claiming also increments the streak.

Debug (staff)

/sham debug alerts

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 of config.yml (enabled, webhook-url, ping, ping-level, ignore). If enabled: false, it reports that alerts are disabled in config.

/sham debug versionsupport

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.json from 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).

Built-in server command

/version <plugin>

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 sham works 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

Permissions Reference

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.

โš ๏ธ **GitHub.com Fallback** โš ๏ธ