Skip to content

war_rooms

xdnw edited this page Mar 24, 2024 · 8 revisions
  • War channels are for coordinating wars against a target or attacking enemy.
  • One room is generated automatically by the bot per enemy (not per war).
  • Sort into categories based on enemy city count (warcat-c1-10)
  • Create rooms manually for a counter, or from a blitz sheet
  • Messages mentioning the bot are shared with war rooms in allies' servers.
  • War rooms close automatically when the war ends

Known limitations

War rooms are only for registered alliances

Users must be registered with the bot: /register nation:

Guilds are limited to 500 channels

War rooms are only created if both attacker and defender are active members

Enabling war rooms

Please ensure the can manage channels and create categories.

If you would like to restrict bot permissions, you may manually create the warroom categories, and give the bot permission to manage only those categories.

/settings_war_room enable_war_rooms enabled: true

Using a war server

Have war rooms in another server you are admin in (e.g. a milcom or coalition server)

Multiple servers can share the same war server

  1. Disable war rooms in your main server: /settings_war_room enable_war_rooms enabled: false

  2. Copy the guild id of the war server (How To Obtain Guild Id)

  3. In your main server, set the war server:

📚 The guild to defer war rooms to
/settings_war_room war_server

The guild to defer war rooms to

Arguments:

<guild> - [Guild](arguments#guild)
A discord guild id. See:


  1. Enable war rooms in the war server: /settings_war_room enable_war_rooms enabled: true

Set the ALLIES coalition in your war server: Locutus/Wiki/coalitions

Creating a war room

It is recommended to create a test war room to ensure it is setup properly

📚 Create a war room...
/war room create

Create a war room
Add -p to ping users that are added
Add -a to skip adding users
Add -f to force create channels (if checks fail)
Add -m to send standard counter messages

Arguments:

<enemy> - [DBNation](arguments#dbnation)
nation id, name or url
<attackers> - [Set](arguments#setdbnation)
Nations to counter with
Default: This guild's alliance nations
(A comma separated list of nations, alliances and filters)
[max=3] - [int](arguments#int)
Max number of nations to counter with
(A whole number)
[-f force] - [boolean](arguments#boolean)
[-w excludeWeakAttackers] - [boolean](arguments#boolean)
Remove countering nations weaker than the enemy
[-d requireDiscord] - [boolean](arguments#boolean)
Remove countering nations NOT registered with Locutus
[-o allowAttackersWithMaxOffensives] - [boolean](arguments#boolean)
Show counters from nations at max offensive wars
i.e. They can counter when they finish a war
[-p pingMembers] - [boolean](arguments#boolean)
Ping the countering nations on discord
[-a skipAddMembers] - [boolean](arguments#boolean)
Do not add countering nations to a war room for the enemy
[-m sendMail] - [boolean](arguments#boolean)
Send counter message ingame to the nations countering


e.g.

/war room create enemy: Borg attackers: @User pingmembers: True sendmail: True

See: Locutus/Wiki/counters for finding, or auto assigning counters

Category sorting

All categories must start with warcat and then optionally have a city range (e.g. warcat-c1-10)

Overlapping ranges are not supported

Categories are assigned based on enemy city count

/war room sort

To manually set the category:

📚 Run this command in a war room to assign it to a category...
/war room setcategory

Run this command in a war room to assign it to a category
/war room setcategory category:raid

Arguments:

<category> - [Category](arguments#category)
The category to move this channel to
(A discord category name or mention)


Generating from blitz sheet

You must have a blitz sheet with columns nation (the target) and the attackers att1, att2, att3

See: Locutus/Wiki/blitzes

📚 Create war rooms from a blitz sheet
/war room from_sheet

Create war rooms from a blitz sheet

Arguments:

<blitzSheet> - [SpreadSheet](arguments#spreadsheet)
A google spreadsheet id or url
For shorthand, use a comma when specifying the sheet tab e.g. sheet:ID,TAB_NAMEFor a url, append #gid=1234 or #tab=tabName to specify the id of the tab to use
[customMessage] - [String](arguments#string)
Custom message to send in each created war room
(A single line of text)
[-c addCounterMessage] - [boolean](arguments#boolean)
If the default counter message should be sent
[-p ping] - [boolean](arguments#boolean)
If the added member should be pinged in the channel
[-m addMember] - [boolean](arguments#boolean)
If the member should be added to the war room
[-a allowedNations] - [Set](arguments#setdbnation)
The nations from the blitz sheet to create war rooms for
Defaults to everyone
(A comma separated list of nations, alliances and filters)
[-h headerRow] - [Integer](arguments#integer)
The row the blitz sheet header is one
Defaults to first row
(A whole number)
[-l useLeader] - [boolean](arguments#boolean)
Parse nation leader instead of nation name
[-f force] - [boolean](arguments#boolean)


War room pins

War rooms have an updating pin of the current war info

Use the war pin command to update the current one

📚 Update the pin in the current war room channel
/war room pin

Update the pin in the current war room channel

This command has no arguments


Or use the war info command

📚 Show war info for a nation
/war info

Show war info for a nation

Arguments:

<nation> - [DBNation](arguments#dbnation)
nation id, name or url


Manually closing war rooms

War rooms are automatically closed if all attackers, or the enemy is inactive, or if those wars are concluded

Manually close a rooom by deleting it, or using the command

📚 Close a war room, interview or embassy discord channel
/channel close current

Close a war room, interview or embassy discord channel

Arguments:

[-f forceDelete] - [boolean](arguments#boolean)


Note: The channel close command can only close war rooms and interviews

Creating a sheet of war rooms

/war counter sheet includeallenemies: True

📚 Generate a sheet with a list of nations attacking allies...
/war counter sheet

Generate a sheet with a list of nations attacking allies
(Defaults to those attacking allies)
Please still check the war history in case it is not valid to counter (and add a note to the note column indicating such)
Add -a to filter out applicants
Add -i to filter out inactive members
Add -e to include enemies not attacking

Arguments:

[enemyFilter] - [Set](arguments#setdbnation)
Only include these attackers
(A comma separated list of nations, alliances and filters)
[allies] - [Set](arguments#setdballiance)
Show attackers against these alliances
(A comma separated list of alliances)
[-a excludeApplicants] - [boolean](arguments#boolean)
Exclude applicants
[-i excludeInactives] - [boolean](arguments#boolean)
Exclude inactive nations (3.4 days)
[-e includeAllEnemies] - [boolean](arguments#boolean)
Include enemies not attacking
[-s sheetUrl] - [String](arguments#string)
A single line of text


Force update war rooms

📚 Sync and debug war rooms
/admin sync warrooms

Sync and debug war rooms

Arguments:

[-f force] - [boolean](arguments#boolean)


Clone this wiki locally