Mercenary Module¶
The Mercenary Module is a paid contract system that lets your faction or family operate a merc service - members submit hospitalisation or mugging requests, and contracted mercs fulfil them through Discord.
Guild Module
This module is configured per Discord server via Guild Configuration.
Overview¶
When a member runs /h or /m with a target's Torn ID, a request embed is posted to the configured channel and the appropriate ping role is notified. Contracted mercs can claim and complete the request using buttons on the embed. Completion is restricted to members holding the configured merc role.
The module supports separate ping roles for hospitalisations and muggings, allowing you to route requests to the right people. A contract management system handles pricing and limits.
Key Features¶
/hand/mcommands for quick request submission- Separate ping roles for hospitalisation and mugging requests
- Merc-only completion buttons gated behind a configurable role
- Contract management system for pricing tiers and daily limits
- Claim system to prevent duplicate handling by multiple mercs
Commands¶
| Command | Description | Permission Required |
|---|---|---|
/h |
Request a player to be hospitalised at a price | Registered User |
/m |
Request a player to be mugged at a price | Registered User |
/merc contract manage |
View and manage merc contracts | Manage Merc Contracts |
Tip
Provide the target's Torn Player ID (a number) when using /h or /m.
Prerequisites¶
- You must be a registered user (have a paired API key).
- Request Channel must be configured.
Configuration¶
This module is configured via the Guild Config - Mercenary Module page.
| Setting | Default | Summary |
|---|---|---|
| Hosp Request Role | null |
The role pinged for hospitalisation requests |
| Mug Request Role | null |
The role pinged for mugging requests |
| Request Channel | null |
The text channel where all merc requests are posted |
| Merc Request Role | null |
The role required to complete requests via the embed buttons |