Skip to content

Armoury Module

The Armoury Module tracks every interaction with your faction's armoury and lets you set minimum stock alerts per item - this allows leaders to be aware of what's being used and by who, and what needs restocking.

Faction Module

This module requires a registered faction and a Faction API Key.

Overview

The Armoury Module logs all armoury activity, including items used, deposited, loaned, withdrawn, and unboxed. This data is stored and displayed through the /armoury view command, which provides multiple display modes and powerful filters to help you understand consumption patterns over any time period.

In addition to usage tracking, the module monitors current stock levels for any item you configure. When a stock level drops below your defined minimum, the bot sends an alert to your configured channel - with an optional role ping - and will not re-alert for the same item for 24 hours.

Key Features

  • Logs all armoury events: used, deposited, loaned, withdrawn, unboxed, and more
  • Multiple display modes: Usage Overview, Item Usage List, Raw Logs, Leaderboard
  • Flexible filters: lookback duration, date range, specific faction member, specific item
  • Per-item minimum stock alerts with optional role pings
  • Mute individual item alerts without removing their minimums

Commands

Command Description Permission Required
/armoury view View armoury usage with modes and filters Faction Member
/armoury items Configure minimum stock level alerts per item Manage Armoury Item Alerts

For full details on each command and its menus, see:

Prerequisites

Configuration

This module is configured via the Faction Config - Armoury Module page.

Setting Default Summary
Alert Channel null The text channel where armoury low stock alerts are sent
Ping Role null The role pinged when an armoury stock alert fires