Commands & Permissions

This page lists every command and permission provided by the zAuctionHouseStats addon. The addon has its own command, /zahstats, and also adds two sub-commands to the main zAuctionHouse command (/ah stats and /ah price).

Main CommandCopy Anchor Link

The addon command is /zahstats, with one alias:

• /zahs - Short version

Running /zahstats with no argument shows the help (same as /zahstats help). The help only lists the sub-commands you have permission for. A player-only sub-command is hidden when the help is shown in the console.

Sub-CommandsCopy Anchor Link

Tab completion only suggests the sub-commands you have permission for, then the possible values of each argument (metrics, periods, economies, online players, import sources, confirm).

The descriptions shown by /zahstats help and /ah help come from the command-description section of messages.yml (keys help, top, player, items, reload, clearcache, import, purge, ah-stats and ah-price). You can edit them, and /zahstats reload applies the change.

Top Command DetailsCopy Anchor Link

/zahstats top <metric> [period] [economy]

Shows the top 10 players for a metric in chat. To see the full leaderboard, use the paginated leaderboard menu (see Inventories).

Arguments:

• <metric> - The leaderboard to show (required). Accepts a short alias or the full metric name (case-insensitive, - works in place of _)
• [period] - The time window (optional, defaults to all)
• [economy] - The economy name (optional, case-insensitive)

Metrics:

Periods:

Periods are calendar windows in the time zone set in the addon configuration (see Configuration).

If a leaderboard is disabled in the configuration, the command replies with the top-disabled message. An unknown metric, period or economy sends top-metric-unknown, top-period-unknown or economy-unknown.

Examples:

# All-time top sellers in the default economy
/zahstats top sellers

# Top buyers this week
/zahstats top buyers week

# Top sellers by number of sales this month, vault economy only
/zahstats top sellers_count month vault

# Full metric names also work
/zahstats top biggest_sale day

Player Command DetailsCopy Anchor Link

/zahstats player [name]

Shows a player's statistics, one block per economy. The default economy comes first, then the others in alphabetical order. Each block shows:

• Items listed, items sold and the conversion rate (sold / listed)
• Items bought
• Money earned and money spent
• Taxes paid and biggest sale
• First and last sale dates

Arguments:

• [name] - Player name (optional). Without a name, you see your own statistics. From the console, a name is required

The name must be a valid Minecraft name (1 to 16 letters, digits or _). Offline players work too: the addon looks up the name in its database. Tab completion suggests online players, but you can type any name. An invalid or unknown name sends player-not-found, and a player without any statistics sends player-empty.

Examples:

# Your own statistics
/zahstats player

# Another player's statistics
/zahstats player Notch

Items Command DetailsCopy Anchor Link

/zahstats items [economy]

Opens the item price explorer menu (item-prices.yml). Players only.

Arguments:

• [economy] - The economy to show prices in (optional, case-insensitive). If set, this economy is selected when the menu opens. An unknown economy sends economy-unknown

Reload & Clear CacheCopy Anchor Link

• /zahstats reload (alias rl) reloads the configuration, the messages and the menus. If the new configuration is invalid, nothing changes and the current configuration stays active (reload-error). If the configuration loads but some menus fail, the addon sends reload-menus-error.
• /zahstats clearcache (alias cc) clears all statistics caches, including the PlaceholderAPI value cache. It does not empty them: every cached value is marked as expired and recalculated in the background, while the previous value stays displayed until the new one is ready. It also resets the cache of parsed placeholders.

Import Command DetailsCopy Anchor Link

/zahstats import <v1|v4logs> confirm

Imports past sales into the addon. Works in two steps:

1. Run the command without confirm to do a dry run. It shows the estimated number of rows, the estimated time and any warnings.
2. Run it again with confirm to start the import. The import runs in the background, and progress is written to the console.

If the dry run shows a blocking warning (no zah_* table found in the V1 database, or V3 purchases that would be counted twice), the import is refused when you confirm it.

Sources:

The source name is case-insensitive, and v4-logs / v4_logs are also accepted.

Each source can only be imported once per database. On a multi-server setup, an import that is already running on another server is blocked. For the full process, see Migration.

Examples:

# Dry run: preview the V1 import
/zahstats import v1

# Start the V1 import
/zahstats import v1 confirm

Purge Command DetailsCopy Anchor Link

/zahstats purge <days> confirm

Deletes recorded sales, and finished listings, older than the given number of days. Active listings are never deleted. Daily totals and all-time totals are kept, so leaderboards, periods and player totals stay correct. Item prices and the day/week/month "biggest sale" leaderboard are calculated from the sales themselves, so purged sales no longer count there. Works in two steps:

1. Run the command without confirm to see how many rows would be deleted.
2. Run it again with confirm to delete them.

Arguments:

• <days> - Number of days to keep (required). A whole number, at least 1 (otherwise purge-invalid-days). Tab completion suggests 30, 60, 90, 180 and 365

To purge automatically every day, set retention.sales-days in config.yml (see Configuration).

Examples:

# Preview: how many sales are older than 90 days
/zahstats purge 90

# Delete sales older than 90 days
/zahstats purge 90 confirm

zAuctionHouse Sub-CommandsCopy Anchor Link

The addon adds two sub-commands to the main zAuctionHouse command (/zauctionhouse, /ah and its other aliases). They are listed in /ah help. Both are for players only.

Price Command DetailsCopy Anchor Link

/ah price [economy]

Shows all-time price statistics for the item in your main hand: number of sales, average price and median price. Items are matched by material and custom model data.

Arguments:

• [economy] - The economy to use (optional, case-insensitive, defaults to the default zAuctionHouse economy)

You must hold an item, otherwise the addon sends price-error. An unknown economy sends price-economy-unknown. If no sale is recorded for this item, the addon sends the price-no-data message.

Examples:

# Prices of the item in hand, default economy
/ah price

# Prices in a specific economy
/ah price vault

PermissionsCopy Anchor Link

All permissions default to op.

WildcardCopy Anchor Link

zauctionhouse.stats.admin gives every other zauctionhouse.stats.* permission:

zauctionhouse.stats.admin:
  children:
    zauctionhouse.stats.use: true
    zauctionhouse.stats.top: true
    zauctionhouse.stats.player: true
    zauctionhouse.stats.items: true
    zauctionhouse.stats.reload: true
    zauctionhouse.stats.clearcache: true
    zauctionhouse.stats.import: true
    zauctionhouse.stats.purge: true

Menu PermissionsCopy Anchor Link

The default menus check the same permissions with a zMenu open-requirement:

In stats.yml, the button that opens the administration menu is only shown to players with zauctionhouse.stats.admin. See Inventories for more details.

Update NotificationsCopy Anchor Link

This permission is shared with the other GroupeZ plugins and is not part of zauctionhouse.stats.admin. The check only runs when enable-version-checker is true (see Configuration).

Permission ExamplesCopy Anchor Link

LuckPermsCopy Anchor Link

Let all players use the statistics menus and /ah price:

/lp group default permission set zauctionhouse.stats.use true
/lp group default permission set zauctionhouse.stats.top true
/lp group default permission set zauctionhouse.stats.player true
/lp group default permission set zauctionhouse.stats.items true

Give staff full access:

/lp group admin permission set zauctionhouse.stats.admin true

Example Group SetupCopy Anchor Link

# Default Group
permissions:
  - zauctionhouse.stats.use
  - zauctionhouse.stats.top
  - zauctionhouse.stats.player
  - zauctionhouse.stats.items

# Staff Group
permissions:
  - zauctionhouse.stats.admin