Skip to content

Commands

test edited this page May 17, 2024 · 63 revisions

This page lists all the settings that can be set on a guild. To view a setting:

📚 Configure any alliance or guild settings
/settings info

Configure any alliance or guild settings

Arguments:

[key] - [GuildSetting](arguments#guildsetting)
The setting to change or view
(Bot guild settings)
[value] - [String[TextArea]](arguments#stringtextarea)
The value to set the setting to
(A single line of text)
[-a listAll] - [boolean](arguments#boolean)


To delete a setting

📚 Delete an alliance or guild setting
/settings delete

Delete an alliance or guild setting

Arguments:

[key] - [GuildSetting](arguments#guildsetting)
Bot guild settings


Settings## ALLIANCE_ID

type: Set<Integer> category: DEFAULT Desc: Your alliance id commands:

  • /settings_default registeralliance

API_KEY

type: List<String> category: DEFAULT Desc:

Be sure to enable all access you wish the bot to have, and have a sufficient position in-game (e.g. leader)
Needed for alliance functions and information access, such as calculating resource dispersal, sending mail
![Api Key Example](https://cdn.discordapp.com/attachments/672310912090243092/1143703860481904691/AAAetVInX_AQsRH_PbhSwx7dANRzZ31ykmtLfBdS0-paNiZN1xt36VWmClVeuhc4FwlpP7gaeNGk_jrfV24mgYUyz3AxTPY6ljLZZKGn1YkE_6vbRztKs512.png)```
commands:
- `/settings_default registerapikey`

## `DELEGATE_SERVER`
type: `Map<Integer, Long>`
category: `DEFAULT`
Desc:
```The guild to delegate unset settings to```
commands:
- `/settings_default delegate_server`

## `ALLIANCE_CREATE_ALERTS`
type: `MessageChannel`
category: `FOREIGN_AFFAIRS`
Desc:
```The #channel to receive alerts for alliance creation```
commands:
- `/settings_foreign_affairs alliance_create_alerts`

## `DO_NOT_RAID_TOP_X`
type: `Integer`
category: `FOREIGN_AFFAIRS`
Desc:
```The number of top alliances to include in the Do Not Raid (DNR) list
Members are not permitted to declare on members of these alliances or their direct allies
Results in the DNR will be excluded from commands, and will alert Foreign Affairs if violated
Defaults to `0````
commands:
- `/settings_foreign_affairs do_not_raid_top_x`

## `EMBASSY_CATEGORY`
type: `Category`
category: `FOREIGN_AFFAIRS`
Desc:
```The name or id of the CATEGORY you would like embassy channels created in (for </embassy:1015170851873763338>)```
commands:
- `/settings_foreign_affairs embassy_category`

## `FA_SERVER`
type: `GuildDB`
category: `FOREIGN_AFFAIRS`
Desc:
```The guild to defer coalitions to```
commands:
- `/settings_foreign_affairs fa_server`

## `TREATY_ALERTS`
type: `MessageChannel`
category: `FOREIGN_AFFAIRS`
Desc:
```The #channel to receive alerts for treaty changes```
commands:
- `/settings_foreign_affairs treaty_alerts`

## `BLOCKADED_ALERTS`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The #channel to receive alerts for blockades```
commands:
- `/settings_war_alerts blockaded_alerts`

## `DEFENSE_WAR_CHANNEL`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The #channel to receive alerts for defensive wars
Members and `MILCOM` are pinged for defensive wars
To set the `MILCOM` role, see: `/role setalias locutusrole: MILCOM discordrole: ````
commands:
- `/settings_war_alerts defense_war_channel`

## `ENEMY_MMR_CHANGE_ALERTS`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The #channel to receive alerts when a member in `enemies` coalitions changes MMR```
commands:
- `/settings_war_alerts enemy_mmr_change_alerts`

## `ESPIONAGE_ALERT_CHANNEL`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The channel to get alerts when a member has their units spied successfully```
commands:
- `/settings_war_alerts espionage_alert_channel`

## `HIDE_APPLICANT_WARS`
type: `Boolean`
category: `WAR_ALERTS`
Desc:
```Whether to hide war alerts for applicants```
commands:
- `/settings_war_alerts hide_applicant_wars`

## `LOST_WAR_CHANNEL`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The #channel to post wars when our side loses a war```
commands:
- `/settings_war_alerts lost_war_channel`

## `MENTION_MILCOM_FILTER`
type: `NationFilter`
category: `WAR_ALERTS`
Desc:
```A nation filter to apply to limit what wars milcom gets pinged for. ```
commands:
- `/settings_war_alerts mention_milcom_filter`

## `OFFENSIVE_WAR_CHANNEL`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The #channel to receive alerts for offensive wars
Members and `FOREIGN_AFFAIRS` role are pinged for Do Not Raid (DNR) violations
To set the `FOREIGN_AFFAIRS` role, see: `/role setalias locutusrole: FOREIGN_AFFAIRS discordrole: `
Wars against inactive nones do not create alerts```
commands:
- `/settings_war_alerts offensive_war_channel`

## `SHOW_ALLY_DEFENSIVE_WARS`
type: `Boolean`
category: `WAR_ALERTS`
Desc:
```Whether to show defensive war alerts for allies (true/false)```
commands:
- `/settings_war_alerts show_ally_defensive_wars`

## `SHOW_ALLY_OFFENSIVE_WARS`
type: `Boolean`
category: `WAR_ALERTS`
Desc:
```Whether to show offensive war alerts for allies (true/false)```
commands:
- `/settings_war_alerts show_ally_offensive_wars`

## `UNBLOCKADED_ALERTS`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The #channel to receive alerts for unblockades```
commands:
- `/settings_war_alerts unblockaded_alerts`

## `UNBLOCKADE_REQUESTS`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The #channel to receive alerts for unblockade requests```
commands:
- `/settings_war_alerts unblockade_requests`

## `WAR_ALERT_FOR_OFFSHORES`
type: `Boolean`
category: `WAR_ALERTS`
Desc:
```Whether to do war alerts for offshore alliances```
commands:
- `/settings_war_alerts war_alert_for_offshores`

## `WAR_PEACE_ALERTS`
type: `MessageChannel`
category: `WAR_ALERTS`
Desc:
```The #channel to receive alerts for changes to any war peace offers```
commands:
- `/settings_war_alerts war_peace_alerts`

## `WAR_ROOM_FILTER`
type: `NationFilter`
category: `WAR_ALERTS`
Desc:
```A an additional filter to limit which nations are allowed for a war room.
War rooms are only created and maintained when attacker and defender match this filter

commands:

  • /settings_war_alerts war_room_filter

WON_WAR_CHANNEL

type: MessageChannel category: WAR_ALERTS Desc: The #channel to post wars when our side wins a war (only includes actives) commands:

  • /settings_war_alerts won_war_channel

ALLOWED_BEIGE_REASONS

type: Map<CityRanges, Set<BeigeReason>> category: BEIGE_ALERTS Desc:

In the form:

c1-9:* c10+:INACTIVE,VACATION_MODE,APPLICANT

 Options:
- VACATION_MODE: You can beige enemies in Vacation Mode
- NOT_AN_ENEMY: Non enemies are not subject to beige/cycle orders
- INACTIVE: Nations who are inactive (2 days)
- APPLICANT: Applicants aren't subject to beige/cycle orders
- UNDER_C10_SLOG: If the enemy has less than 10 cities
- OFFENSIVE_WAR: War is offensive
- ALREADY_BEIGE_STACKED: Enemies already with enough beige to rebuild (6 days)
- NO_ENEMY_OFFENSIVE_WARS: Enemies not declaring any offensive wars
- MISSILE_TURRET: Enemies with high number of missiles
- NUKE_TURRET: Enemies with high numbers of nukes
- NO_RECENT_WARS: Enemy is has not declared a war in the past 20 days
- NO_RECENT_3_CONSECUTIVE_LOGINS: Enemy has not had 3 consecutive logins in the past 120 days
- NO_RECENT_5_CONSECUTIVE_LOGINS: Enemy has not had 5 consecutive logins in the past 120 days
- INCORRECT_ENEMY_MMR: Enemy does not have 5 barracks/factories
- USELESS: Enemy has no recent wars and no recent consecutive logins OR incorrect MMR
- BEIGE_CYCLE: If the enemy does not have beige, and two other strong nations can sit them whilst beige. DO NOT BEIGE DEFENSIVE WARS
- BEIGE_CYCLE_4D: If the enemy does not have beige, and one other strong nation can sit them whilst beige for 4d. DO NOT BEIGE DEFENSIVE WARS
- BEIGE_CYCLE_1: If the enemy does not have beige, and one other strong nation can sit them whilst beige for 2d. DO NOT BEIGE DEFENSIVE WARS
- BLOCKADED: If you are being sat on/blockaded and need to restock on warchest
- LOW_RESISTANCE: Low resistance, at risk of getting beiged (use your best judgement)
- LOW_RESISTANCE_OFFENSIVE: Low resistance, at risk of getting beiged (use your best judgement)
- DO_NOT_RAID: Try to peace nations that are on the Do Not Raid list
- NO_REASON: 

Also set: </coalition create:1015168434906071114> with ENEMIES: `Enemies````
commands:
- `/settings_beige_alerts addbeigereasons`
- `/settings_beige_alerts setbeigereasons`

## `BEIGE_ALERT_CHANNEL`
type: `MessageChannel`
category: `BEIGE_ALERTS`
Desc:
```The #channel to receive alerts when a raid target leaves beige.
`/role setalias locutusrole: BEIGE_ALERT` must also be set and have members in range```
commands:
- `/settings_beige_alerts beige_alert_channel`

## `BEIGE_VIOLATION_MAIL`
type: `Boolean`
category: `BEIGE_ALERTS`
Desc:
```Whether to send a mail to the nation when a beige violation occurs
Default: False```
commands:
- `/settings_beige_alerts beige_violation_mail`

## `ENEMY_ALERT_CHANNEL`
type: `MessageChannel`
category: `BEIGE_ALERTS`
Desc:
```The #channel to receive alerts when an enemy nation leaves beige```
commands:
- `/settings_beige_alerts enemy_alert_channel`

## `ENEMY_ALERT_CHANNEL_MODE`
type: `EnemyAlertChannelMode`
category: `BEIGE_ALERTS`
Desc:
```The mode for the enemy alert channel to determine what alerts are posted and who is pinged
Options:
- PING_USERS_IN_RANGE
- PING_ROLE_IN_RANGE
- PING_ROLE_ALL```
commands:
- `/settings_beige_alerts enemy_alert_channel_mode`

## `ENEMY_ALERT_FILTER`
type: `NationFilter`
category: `BEIGE_ALERTS`
Desc:
```A filter for enemies to alert on when they leave beige
Defaults to `#active_m<7200` (active in the past 5 days)```
commands:
- `/settings_beige_alerts enemy_alert_filter`

## `ENEMY_BEIGED_ALERT`
type: `MessageChannel`
category: `BEIGE_ALERTS`
Desc:
```The #channel to receive alerts when an enemy gets beiged```
commands:
- `/settings_beige_alerts enemy_beiged_alert`

## `ENEMY_BEIGED_ALERT_VIOLATIONS`
type: `MessageChannel`
category: `BEIGE_ALERTS`
Desc:
```The #channel to receive alerts when an enemy gets beiged (without reason)```
commands:
- `/settings_beige_alerts enemy_beiged_alert_violations`

## `AA_GROUND_TOP_X`
type: `Integer`
category: `ORBIS_ALERTS`
Desc:
```Only do alliance ground unit alerts for the top X alliances (by active member score)```
commands:
- `/settings_orbis_alerts aa_ground_top_x`

## `AA_GROUND_UNIT_ALERTS`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The channel to send alerts when alliance ground units increase by more than 2.5%
See also setting `AA_GROUND_TOP_X` and coalition: `GROUND_ALERTS` and role alias: `GROUND_MILITARIZE_ALERT````
commands:
- `/settings_orbis_alerts aa_ground_unit_alerts`

## `ACTIVITY_ALERTS`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The #channel to receive alerts for activity (e.g. pre blitz)```
commands:
- `/settings_orbis_alerts activity_alerts`

## `ALLIANCE_EXODUS_TOP_X`
type: `Integer`
category: `ORBIS_ALERTS`
Desc:
```The rank threshold to post exodus alerts for```
commands:
- `/settings_orbis_alerts alliance_exodus_top_x`

## `BAN_ALERT_CHANNEL`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The channel to receive alerts when any nation in the game is banned)```
commands:
- `/settings_orbis_alerts ban_alert_channel`
requirements:
- function:Guild owner must be registered to an active nation, or registered to an alliance with an active nation in a leader/heir position

## `DELETION_ALERT_CHANNEL`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The channel to receive alerts when any nation in the game deletes```
commands:
- `/settings_orbis_alerts deletion_alert_channel`
requirements:
- function:Please use the public channels for this <https://discord.gg/cUuskPDrB7> (this is to reduce unnecessary discord calls)
- function:Guild owner must be registered to an active nation, or registered to an alliance with an active nation in a leader/heir position

## `ESCALATION_ALERTS`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The #channel to receive alerts for war escalation alerts in orbis```
commands:
- `/settings_orbis_alerts escalation_alerts`

## `ORBIS_ALLIANCE_EXODUS_ALERTS`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The #channel to receive alerts when multiple 5+ members leave an alliance
See also: </settings_orbis_alerts alliance_exodus_top_x:1104571317719670894>```
commands:
- `/settings_orbis_alerts orbis_alliance_exodus_alerts`

## `ORBIS_LEADER_CHANGE_ALERT`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The #channel to receive alerts when a nation is promoted to leader in an alliance (top 80)```
commands:
- `/settings_orbis_alerts orbis_leader_change_alert`

## `ORBIS_OFFICER_LEAVE_ALERTS`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The #channel to receive alerts when officers leave an alliance  (top 50)```
commands:
- `/settings_orbis_alerts orbis_officer_leave_alerts`

## `ORBIS_OFFICER_MMR_CHANGE_ALERTS`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The #channel to receive alerts when gov members increase MMR (top 80)```
commands:
- `/settings_orbis_alerts orbis_officer_mmr_change_alerts`

## `REPORT_ALERT_CHANNEL`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The channel to receive alerts when any nation or user is reported to the bot
See </report add:1141362798606176256>```
commands:
- `/settings_orbis_alerts report_alert_channel`
requirements:
- function:Guild owner must be registered to an active nation, or registered to an alliance with an active nation in a leader/heir position

## `REROLL_ALERT_CHANNEL`
type: `MessageChannel`
category: `ORBIS_ALERTS`
Desc:
```The #channel to receive alerts for nation rerolls```
commands:
- `/settings_orbis_alerts reroll_alert_channel`
requirements:
- function:Please use the public channels for this <https://discord.gg/cUuskPDrB7> (this is to reduce unnecessary discord calls)
- function:Guild owner must be registered to an active nation, or registered to an alliance with an active nation in a leader/heir position

## `ENABLE_WAR_ROOMS`
type: `Boolean`
category: `WAR_ROOM`
Desc:
```If war rooms should be enabled (i.e. auto generate a channel for wars against active nations)
Note: Defensive war channels must be enabled to have auto war room creation```
commands:
- `/settings_war_room enable_war_rooms`

## `WAR_SERVER`
type: `Guild`
category: `WAR_ROOM`
Desc:
```The guild to defer war rooms to```
commands:
- `/settings_war_room war_server`

## `ALLOW_UNVERIFIED_BANKING`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```Allow unregistered nations to withdraw via a web banking portal```
commands:
- `/settings_bank_access allow_unverified_banking`
requirements:
- function:No valid alliance is setup (see: `/settings info`)
- function:No bank is setup (see: `/offshore add`)

## `BANKER_WITHDRAW_LIMIT`
type: `Long`
category: `BANK_ACCESS`
Desc:
```The daily withdraw limit (from the offshore) of non admins```
commands:
- `/settings_bank_access banker_withdraw_limit`

## `BANKER_WITHDRAW_LIMIT_INTERVAL`
type: `Long`
category: `BANK_ACCESS`
Desc:
```The time period the withdraw limit applies to (defaults to 1 day)```
commands:
- `/settings_bank_access banker_withdraw_limit_interval`

## `DEFAULT_OFFSHORE_ACCOUNT`
type: `NationOrAllianceOrGuild`
category: `BANK_ACCESS`
Desc:
```The default account to offshore into via </offshore send:1015168434847363132>```
commands:
- `/settings_bank_access default_offshore_account`
requirements:
- function:No valid alliance is setup (see: `/settings info`)
- function:No bank is setup (see: `/offshore add`)

## `GRANT_LIMIT_DELAY`
type: `Long`
category: `BANK_ACCESS`
Desc:
```The timeframe the GRANT_TEMPLATE_LIMITS is for, which restricts max funds that a user can grant using templates over this timeframe.```
commands:
- `/settings_bank_access grant_limit_delay`

## `GRANT_TEMPLATE_BLACKLIST`
type: `Set<Integer>`
category: `BANK_ACCESS`
Desc:
```The id of the member you want to add to the blacklist```
commands:
- `/settings_bank_access togglegrants`

## `GRANT_TEMPLATE_LIMITS`
type: `Map<Long, Double>`
category: `BANK_ACCESS`
Desc:
```The global grant template send limits for each role, limiting how much each granter can send per interval.
This applies in addition to any limits set in the individual template.
The ECON role overrides grant template limits. See: </role setalias:1015168434847363134>
The highest value for each resource will be usedFormat: `role_id:resource1,resource2,resource3````
commands:
- `/settings_bank_access addgranttemplatelimit`

## `MEMBER_CAN_ESCROW`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```Whether members can use </escrow withdraw:1138347817786671145> to withdraw their escrowed funds```
commands:
- `/settings_bank_access member_can_escrow`

## `MEMBER_CAN_OFFSHORE`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```Whether members can use </offshore send:1015168434847363132> (true/false)```
commands:
- `/settings_bank_access member_can_offshore`

## `MEMBER_CAN_WITHDRAW`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```Whether members can use </transfer resources:1015168434776051740> or !grant` to access their own funds (true/false)```
commands:
- `/settings_bank_access member_can_withdraw`

## `MEMBER_CAN_WITHDRAW_IGNORES_GRANTS`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```Whether members's withdraw limit ignores their expiring grants (true/false)```
commands:
- `/settings_bank_access withdraw_ignores_expire`

## `MEMBER_CAN_WITHDRAW_WARTIME`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```Whether members can withdraw during wartime (true/false)```
commands:
- `/settings_bank_access member_can_withdraw_wartime`

## `NON_AA_MEMBERS_CAN_BANK`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```Whether nations which are not a member of the alliance ingame can use any configured banking functions, such as withdrawals```
commands:
- `/settings_bank_access non_aa_members_can_bank`

## `PUBLIC_OFFSHORING`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```Public offshores allow other alliances to see and register to use this alliance as an offshore without approval```
commands:
- `/settings_bank_access public_offshoring`

## `RESOURCE_CONVERSION`
type: `Boolean`
category: `BANK_ACCESS`
Desc:
```If members can convert resources to cash.
This is done virtually in </deposits check:1015168434776051741>Resources are converted using market average
Use `#cash` as the note when depositing or transferring funds```
commands:
- `/settings_bank_access resource_conversion`

## `RESOURCE_REQUEST_CHANNEL`
type: `Map<Long, MessageChannel>`
category: `BANK_ACCESS`
Desc:
```The #channel for users to request resources in.
For multiple alliances, use the form:

#defaultChannel alliance1:#channel

commands:

  • /settings_bank_access addresourcechannel

ROUTE_ALLIANCE_BANK

type: Boolean category: BANK_ACCESS Desc: If true, all transfers from the offshore will send via the alliance bank commands:

  • /settings_bank_access route_alliance_bank requirements:
  • function:No valid alliance is setup (see: /settings info)
  • function:No bank is setup (see: /offshore add)

ADDBALANCE_ALERT_CHANNEL

type: MessageChannel category: BANK_INFO Desc: The #channel to receive alerts when there is a large tranfer in the game or a nation VMs with resources commands:

  • /settings_bank_info addbalance_alert_channel

BANK_ALERT_CHANNEL

type: MessageChannel category: BANK_INFO Desc: The #channel to receive alerts for transfers when a nation goes into VM commands:

  • /settings_bank_info bank_alert_channel

DEPOSIT_ALERT_CHANNEL

type: MessageChannel category: BANK_INFO Desc: The #channel to receive alerts when a nation makes a deposit (this will no longer reliably alert) commands:

  • /settings_bank_info deposit_alert_channel

DISPLAY_CONDENSED_DEPOSITS

type: Boolean category: BANK_INFO Desc: Display deposits in a condensed format commands:

  • /settings_bank_info display_condensed_deposits

DISPLAY_ITEMIZED_DEPOSITS

type: Boolean category: BANK_INFO Desc: Whether members's deposits are displayed by default with a breakdown of each category (true/false) commands:

  • /settings_bank_info display_itemized_deposits

GRANT_REQUEST_CHANNEL

type: MessageChannel category: BANK_INFO Desc: The #channel for users to request grants in. No additional functionality is added, you can setup a ticket bot or an embed there commands:

  • /settings_bank_info grant_request_channel

LARGE_TRANSFERS_CHANNEL

type: MessageChannel category: BANK_INFO Desc: ```The #channel to receive alerts e.g. for custom `!BankAlerts```` commands:

  • /settings_bank_info large_transfers_channel

WITHDRAW_ALERT_CHANNEL

type: MessageChannel category: BANK_INFO Desc: The #channel to receive alerts when a nation requests a transfer commands:

  • /settings_bank_info withdraw_alert_channel

MEMBER_CAN_SET_BRACKET

type: Boolean category: TAX Desc: Whether members can use </nation set taxbracket:1015168434776051733> commands:

  • /settings_tax member_can_set_bracket

REQUIRED_INTERNAL_TAXRATE

type: Map<NationFilter, TaxRate> category: TAX Desc:

To list nations current rates: </tax listbracketauto:1015168434906071119>
To bulk move nations: </nation set taxinternalauto:1015168434776051733>
Tax rate is in the form: `money/rss`
In the form: 

#cities<10:100/100 #cities>=10:25/25

All nation filters are supported (e.g. roles)
Priority is first to last (so put defaults at the bottom)```
commands:
- `/settings_tax required_internal_taxrate`
- `/settings_tax addrequiredinternaltaxrate`

## `REQUIRED_TAX_BRACKET`
type: `Map<NationFilter, Integer>`
category: `TAX`
Desc:
```This setting maps nation filters to tax bracket for bulk automation.
To list nations current rates: </tax listbracketauto:1015168434906071119>
To bulk move nations: </nation set taxbracketauto:1015168434776051733>
In the form: 

#cities<10:1234 #cities>=10:2345

All nation filters are supported (e.g. roles)
Priority is first to last (so put defaults at the bottom)```
commands:
- `/settings_tax addrequiredbracket`
- `/settings_tax required_tax_bracket`

## `TAX_BASE`
type: `TaxRate`
category: `TAX`
Desc:
```The internal tax amount ($/rss) in the format e.g. `25/25` to be excluded in deposits.
Defaults to `100/100` (i.e. no taxes are included in depos).
Setting is retroactive. See also: </nation set taxinternal:1015168434776051733>```
commands:
- `/settings_tax tax_base`

## `DISABLED_MEMBER_AUDITS`
type: `AutoAuditType`
category: `AUDIT`
Desc:
```A comma separated list of audit types to ignore:
{ GRAY,HIGH_INFRA,UNPROFITABLE_FARMS,UNEVEN_INFRA,WIND_POWER,WAR_TYPE_NOT_RAID,WAR_POLICY,INACTIVE }```
commands:
- `/settings_audit disabled_member_audits`

## `MEMBER_AUDIT_ALERTS`
type: `MessageChannel`
category: `AUDIT`
Desc:
```The #channel to ping members about audits```
commands:
- `/settings_audit member_audit_alerts`

## `MEMBER_LEAVE_ALERT_CHANNEL`
type: `MessageChannel`
category: `AUDIT`
Desc:
```The channel to receive alerts when a member leaves```
commands:
- `/settings_audit member_leave_alert_channel`

## `MEMBER_REBUY_INFRA_ALERT`
type: `MessageChannel`
category: `AUDIT`
Desc:
```The channel to receive alerts when a member buys infra```
commands:
- `/settings_audit member_rebuy_infra_alert`

## `REQUIRED_MMR`
type: `Map<NationFilter, MMRMatcher>`
category: `AUDIT`
Desc:
```Set the required MMR based on nation criteria
See: <https://github.com/xdnw/locutus/wiki/nation_placeholders>
Accepts a list of filters to the required MMR.
In the form:

#cities<10:505X #cities>=10:0250

Use `*` as the filter to match all nations.```
commands:
- `/settings_audit required_mmr`
- `/settings_audit addrequiredmmr`

## `WARCHEST_PER_CITY`
type: `Map<ResourceType, Double>`
category: `AUDIT`
Desc:
```Amount of warchest to recommend per city in form `{steel=1234,aluminum=5678,gasoline=69,munitions=420}````
commands:
- `/settings_audit warchest_per_city`

## `ASSIGNABLE_ROLES`
type: `Map<Role, Set<Role>>`
category: `ROLE`
Desc:
```Map roles that can be assigned (or removed). See </self create:1015168434847363135> </role removeassignablerole:1015168434847363134> </self add:1015168434847363135> </self remove:1015168434847363135>```
commands:
- `/settings_role assignable_roles`
- `/settings_role addassignablerole`

## `AUTONICK`
type: `AutoNickOption`
category: `ROLE`
Desc:
```Options: { FALSE,LEADER,NATION,DISCORD,NICKNAME }
See also: </role clearnicks:1015168434847363134>```
commands:
- `/settings_role autonick`

## `AUTOROLE_ALLIANCES`
type: `AutoRoleOption`
category: `ROLE`
Desc:
```Options: { FALSE,ALL,ALLIES }
See also:
- `/coalition create coalitionname: MASKEDALLIANCES`
- </role clearallianceroles:1015168434847363134>
- </settings_role autorole_alliance_rank:1104571317719670888>
- </settings_role autorole_member_apps:1104571317719670888>
- </settings_role autorole_top_x:1104571317719670888>```
commands:
- `/settings_role autorole_alliances`

## `AUTOROLE_ALLIANCE_RANK`
type: `Rank`
category: `ROLE`
Desc:
```The ingame rank required to get an alliance role.
Default: member
Options: { LEADER,HEIR,OFFICER,MEMBER,APPLICANT,REMOVE,BAN,UNBAN,INVITE,UNINVITE }```
commands:
- `/settings_role autorole_alliance_rank`

## `AUTOROLE_ALLY_GOV`
type: `Boolean`
category: `ROLE`
Desc:
```Whether to give gov/member roles to allies (this is intended for coalition servers), `true` or `false````
commands:
- `/settings_role autorole_ally_gov`

## `AUTOROLE_ALLY_ROLES`
type: `Roles`
category: `ROLE`
Desc:
```List of roles to autorole from ally servers
(this is intended for coalition servers to give gov roles to allies)```
commands:
- `/settings_role autorole_ally_roles`

## `AUTOROLE_MEMBER_APPS`
type: `Boolean`
category: `ROLE`
Desc:
```Whether member and applicant roles are automatically added or removed.
Note: Set `WAR_ALERT_FOR_OFFSHORES` to false to not give member roles to offshore nations
Cannot be used in conjuction with `AUTOROLE_ALLY_GOV````
commands:
- `/settings_role autorole_member_apps`

## `AUTOROLE_TOP_X`
type: `Integer`
category: `ROLE`
Desc:
```The number of top alliances to provide roles for, defaults to `0`
Alliances added to `MASKEDALLIANCES: `Additional alliances to mask with `/role autoassign` (if alliance masking is enabled)`` are still included outside this range```
commands:
- `/settings_role autorole_top_x`

## `CONDITIONAL_ROLES`
type: `Map<NationFilter, Role>`
category: `ROLE`
Desc:
```Auto assign roles based on conditions
See: <https://github.com/xdnw/locutus/wiki/nation_placeholders>
Accepts a list of filters to a role.
In the form:

#cities<10:@someRole #cities>=10:@otherRole

Use `*` as the filter to match all nations.
Only alliance members can be given roles
Use </role autoassign:1015168434847363134> to auto assign```
commands:
- `/settings_role conditional_roles`
- `/settings_role addconditionalrole`

## `REWARD_MENTOR`
type: `Map<ResourceType, Double>`
category: `REWARD`
Desc:
```The reward (resources) for mentoring a nation in the form `{food=1,money=3.2}````
commands:
- `/settings_reward reward_mentor`

## `REWARD_REFERRAL`
type: `Map<ResourceType, Double>`
category: `REWARD`
Desc:
```The reward (resources) for referring a nation in the form `{food=1,money=3.2}````
commands:
- `/settings_reward reward_referral`

## `RECRUIT_MESSAGE_CONTENT`
type: `String`
category: `RECRUIT`
Desc:
```The recruit message body
Must also set </settings_recruit recruit_message_output:1104571317719670892>```
commands:
- `/settings_recruit recruit_message_content`

## `RECRUIT_MESSAGE_DELAY`
type: `Long`
category: `RECRUIT`
Desc:
```The amount of time to delay recruitment messages by```
commands:
- `/settings_recruit recruit_message_delay`

## `RECRUIT_MESSAGE_OUTPUT`
type: `MessageChannel`
category: `RECRUIT`
Desc:
```The #channel to receive recruitment message output```
commands:
- `/settings_recruit recruit_message_output`

## `RECRUIT_MESSAGE_SUBJECT`
type: `String`
category: `RECRUIT`
Desc:
```The recruit message subject
Must also set </settings_recruit recruit_message_content:1104571317719670892>```
commands:
- `/settings_recruit recruit_message_subject`

## `TIMED_MESSAGES`
type: `List[CustomConditionMessage]`
category: `RECRUIT`
Desc:
```Add a timed message to be sent to new members after a delay
- CREATION
 - When a nation is created
 - Messages will not send to nations that are inactive, or created before the message was created
- MEMBER_DEPARTURE
 - When an applicant or member (but not officer) leaves an alliance
 - Messages will not send if another message has been sent recently, if the nation is inactive, or it was created recently
- GRAVEYARD_ACTIVE
 - When a nation not part of a functioning alliance becomes active
 - Nations must be inactive for at least the time specified to be sent the custom messageMessages will not send if another message has been sent recently

Note: If multiple messages qualify, only the last one will be sent. This task runs every 5 minutes```
commands:
- `/settings_recruit add_timed_message`

## `ARCHIVE_CATEGORY`
type: `Category`
category: `INTERVIEW`
Desc:
```The name or id of the CATEGORY you would like </channel close current:1015168434847363133> to move channels to```
commands:
- `/settings_interview archive_category`

## `INTERVIEW_INFO_SPAM`
type: `MessageChannel`
category: `INTERVIEW`
Desc:
```The channel to receive info spam about expired interview channels```
commands:
- `/settings_interview interview_info_spam`

## `INTERVIEW_PENDING_ALERTS`
type: `MessageChannel`
category: `INTERVIEW`
Desc:
```The channel to receive alerts when a member requests an interview```
commands:
- `/settings_interview interview_pending_alerts`

## `BOUNTY_ALERT_CHANNEL`
type: `MessageChannel`
category: `BOUNTY`
Desc:
```The channel to receive alerts when a bounty is placed```
commands:
- `/settings_bounty bounty_alert_channel`

## `TREASURE_ALERT_CHANNEL`
type: `MessageChannel`
category: `BOUNTY`
Desc:
```The channel to receive alerts when a treasure moves to another nation or is about to reset```
commands:
- `/settings_bounty treasure_alert_channel`

## `TRADE_ALERT_CHANNEL`
type: `MessageChannel`
category: `TRADE`
Desc:
```The #channel to receive alerts for trades```
commands:
- `/settings_trade trade_alert_channel`

## `ENABLE_GITHUB_COPILOT`
type: `Boolean`
category: `ARTIFICIAL_INTELLIGENCE`
Desc:
```Enable GitHub Copilot for generating AI text responses
See: <https://github.com/features/copilot>
This is an alternative to an open ai key```
commands:
- `/settings_artificial_intelligence enable_github_copilot`
requirements:
- function:No valid alliance is setup (see: `/settings info`)

## `GPT_USAGE_LIMITS`
type: `int[]`
category: `ARTIFICIAL_INTELLIGENCE`
Desc:
```gpt user and guild usage limits, by turn and day
Used to limit costs incurred from excessive usageUsage is only tracked per session, and is reset each time the bot restarts```
commands:
- `/settings_artificial_intelligence gpt_usage_limits`

## `OPENAI_KEY`
type: `String`
category: `ARTIFICIAL_INTELLIGENCE`
Desc:
```OpenAI API key
Used for chat responses and completion
Get a key from: <https://platform.openai.com/account/api-keys>```
commands:
- `/settings_artificial_intelligence register_openai_key`

## `OPENAI_MODEL`
type: `ModelType`
category: `ARTIFICIAL_INTELLIGENCE`
Desc:
```OpenAI model type
Used for chat responses and completion
Valid values: GPT_4, GPT_4_32K, GPT_3_5_TURBO, GPT_3_5_TURBO_16K, TEXT_DAVINCI_003, TEXT_DAVINCI_002, TEXT_DAVINCI_001, TEXT_CURIE_001, TEXT_BABBAGE_001, TEXT_ADA_001, DAVINCI, CURIE, BABBAGE, ADA, CODE_DAVINCI_002, CODE_DAVINCI_001, CODE_CUSHMAN_002, CODE_CUSHMAN_001, DAVINCI_CODEX, CUSHMAN_CODEX, TEXT_DAVINCI_EDIT_001, CODE_DAVINCI_EDIT_001, TEXT_EMBEDDING_ADA_002, TEXT_SIMILARITY_DAVINCI_001, TEXT_SIMILARITY_CURIE_001, TEXT_SIMILARITY_BABBAGE_001, TEXT_SIMILARITY_ADA_001, TEXT_SEARCH_DAVINCI_DOC_001, TEXT_SEARCH_CURIE_DOC_001, TEXT_SEARCH_BABBAGE_DOC_001, TEXT_SEARCH_ADA_DOC_001, CODE_SEARCH_BABBAGE_CODE_001, CODE_SEARCH_ADA_CODE_001```
commands:
- `/settings info key: OPENAI_MODEL value: <value>`
Clone this wiki locally