Guild Config - Mugging Module¶
The Mugging Module is a module designed to target a large number of high profile players, and players with bazaars open that are worth tracking.
Using the data collected it is able to generate the following alerts:
- Bazaar Sales
- Buy Mug
- Flying Sales
- Property Lease
- Property Sales
- Russian Roulette Players
- Bazaar Cheap Items
For detailed usage, commands, and examples, see the Mugging Module Overview.
Settings at a glance¶
| Setting | Default | Summary |
|---|---|---|
| Alert Channels | N/A |
Leads to a sub-menu to configure text channels for mug alerts |
| Alert Roles | N/A |
Leads to a sub-menu to configure ping roles for mug alerts |
| Player Exclusions | N/A |
Leads to a sub-menu to configure player exclusions for mug alerts |
| Faction Exclusions | N/A |
Leads to a sub-menu to configure faction exclusions for mug alerts |
| Minimum Bazaar Sale | 10000000 |
The minimum value of bazaar sales to be alerted |
| Minimum Buy Mug Profit | 10000000 |
The minimum profit value of suggested buy mugs to be alerted |
| Exclude Clothing Stores | False |
A toggle to control visibility of alerts for clothing store employees |
Alert Channels¶
Purpose
The alert channels are text channels where mug-bot alerts are sent, see table below:
| Channel Name | Default | Summary |
|---|---|---|
| Bazaar Sales Channel | null |
The text channel where bazaar sale alerts are sent |
| Flying Sales Channel | null |
The text channel where flying sale alerts are sent |
| Buy Mug Channel | null |
The text channel where suggested buy mug alerts are sent |
| Russian Roulette Channel | null |
The text channel where russian roulette player alerts are sent |
| Property Lease Channel | null |
The text channel where private island lease alerts are sent |
| Property Sale Channel | null |
The text channel where private island sale alerts are sent |
| Cheap Items Channel | null |
The text channel where cheap item alerts are sent |
Accepts
Text Channel
Default
null
Note
- Not all channels are required for the alerts to begin being sent
- Channels are monitored for non-faction members, and are often limited to a specific number of slots
- External bots are not permitted in the channels
Alert Roles¶
Purpose
The alert roles are roles which are pinged when the respective alerts are sent, see table below:
| Role Name | Default | Summary |
|---|---|---|
| Bazaar Sales Role | null |
The role pinged when bazaar sale alerts are sent |
| Flying Sales Role | null |
The role pinged when flying sale alerts are sent |
| Buy Mug Role | null |
The role pinged when suggested buy mug alerts are sent |
| Russian Roulette Role | null |
The role pinged when russian roulette player alerts are sent |
| Property Lease Role | null |
The role pinged when private island lease alerts are sent |
| Property Sale Role | null |
The role pinged when private island sale alerts are sent |
| Cheap Items Role | null |
The role pinged when cheap item alerts are sent |
Accepts
Role
Default
null
Player Exclusions¶
Purpose
Player exclusions is a sub-menu in which individual torn players can be excluded from mug-bot alerts.
No individual players are excluded by default.
Accepts
Player ID
Default
null
Faction Exclusions¶
Purpose
Faction exclusions is a sub-menu in which entire torn factions can be excluded from mug-bot alerts.
No factions are excluded by default.
Accepts
Faction ID
Default
null
Minimum Bazaar Sale¶
Purpose
Minimum bazaar sale is an integer (a whole number) which specifies the minimum value of a bazaar sale for an alert are sent.
Accepts
Integer
Default
10000000
Info
This setting only accepts whole numbers, do not include special characters such as dollar signs or commas.
Minimum Buy Mug Profit¶
Purpose
The minimum buy mug profit is an integer (a whole number) which specifies the minimum profit a buy mug must have for an alert to be sent.
Accepts
Integer
Default
10000000
Info
This setting only accepts whole numbers, do not include special characters such as dollar signs or commas.
Exclude Clothing Stores¶
Purpose
Exclude clothing stores is a toggle which controls alert visibility for clothing store employees, see table below:
| State | Behaviour |
|---|---|
| Enabled | No alerts will be sent for employees of Clothing Stores which provide mug protection |
| Disabled | Alerts will be sent for anyone, regardless of their job |
Accepts
Enabled | Disabled
Default
Disabled