Skip to content

sending_targets

Jump to bottom
test edited this page Aug 14, 2024 · 8 revisions
  • Converting other sheet formats to Locutus
  • Copy part of a spy or war sheet by a nation filter
  • Validate war or spy sheets
  • Send war or spy target sheets to nations
  • Send via ingame mail, discord dms
  • Send only part of a sheet

Converting spy sheet formats

📚 Convert dtc's spy sheet format to the bot's format
/spy sheet convertdtc

Convert dtc's spy sheet format to the bot's format

Arguments:

<input> - 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
[-s output] - SpreadSheet
[-a groupByAttacker] - boolean
If results (left column) are grouped by the attacker instead of the defender
[-f forceUpdate] - boolean

📚 Convert TKR's spy sheet format to the bot's format
/spy sheet converttkr

Convert TKR's spy sheet format to the bot's format

Arguments:

<input> - 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
[-s output] - SpreadSheet
[-a groupByAttacker] - boolean
If results (left column) are grouped by the attacker instead of the defender
[-f force] - boolean

📚 Convert hidude's spy sheet format to the bot's format
/spy sheet converthidude

Convert hidude's spy sheet format to the bot's format

Arguments:

<input> - 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
[-s output] - SpreadSheet
[-a groupByAttacker] - boolean
If results (left column) are grouped by the attacker instead of the defender
[-f forceUpdate] - boolean

Copying or Inverting a sheet

To invert, set groupByAttacker to true

📚 Generate a subset of a spy sheet for only certain attackers or defenders
/spy sheet copyforalliance

Generate a subset of a spy sheet for only certain attackers or defenders

Arguments:

<spySheet> - SpreadSheet
The current spy sheet
(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)
<attackers> - Set
Which attackers to include
(A comma separated list of nations, alliances and filters)
[defenders=*] - Set
Which defenders to include
Default: All
(A comma separated list of nations, alliances and filters)
[-h headerRow] - Integer
The row the header is on
Default: 1st row
(A whole number)
[-s output] - SpreadSheet
Sheet to put the subset in
(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)
[-a groupByAttacker] - boolean
Group the spy operations (left column) by attacker

Sheet validation

📚 Run checks on nations in a blitz sheet...
/war sheet validate

Run checks on nations in a blitz sheet

  • In range of their blitz targets- Still in the alliance- Have no more than the provided number of offensive wars
    Sheet columns: nation, att1, att1, att3

Arguments:

<sheet> - 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
[maxWars=3] - int
Max wars per attacker
(A whole number)
[nationsFilter=*] - Set
Only allow attacking these nations
(A comma separated list of nations, alliances and filters)
[attackerFilter] - Set
A comma separated list of nations, alliances and filters
[-l useLeader] - boolean
Parse nation leader instead of nation name
[-h headerRow] - Integer
Which row of the sheet has the header
Default: 1st row
(A whole number)

📚 Run checks on a spy blitz sheet....
/spy sheet validate

Run checks on a spy blitz sheet.
Checks that all nations are in range of their spy blitz targets and that they have no more than the provided number of offensive operations.
Add true for the day-change argument to double the offensive op limit

Arguments:

[sheet] - 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
[dayChange=false] - boolean
If the sheet is for attacks at day change
[filter=*] - Set
Only allow attacking these nations
(A comma separated list of nations, alliances and filters)
[-l useLeader] - boolean
Parse nation leader instead of nation name

Sending sheets

  • Requires the api key to be set (see: Setting the API Key)
  • Send war blitz sheets, spy sheets, or both at the same time
  • Discord Direct Message (dm) requires mail role on the ROOT Locutus server
  • Set allowedNations to only mail to specific nations (See: Nation Filters)
  • To replace default message, set header and set hideDefaultBlurb: True (HTML formatting. To convert: Markdown | HTML->)
  • Requires the MAIL role to set a custom message (see: Registering Roles)
📚 Send spy or war blitz sheets to individual nations...
/mail targets

Send spy or war blitz sheets to individual nations
Blitz Sheet Columns: nation, attacker 1, attacker 2, attacker 3

Arguments:

[blitzSheet] - SpreadSheet
Url of the war blitz sheet to send
(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)
[spySheet] - SpreadSheet
Url of the spy sheet to send
(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)
[allowedNations=*] - Set
What attacker nations to send to
(A comma separated list of nations, alliances and filters)
[allowedEnemies] - Set
What defender nations to include (default: all)
(A comma separated list of nations, alliances and filters)
[header=] - String
Text to prepend to the target instructions being sent
(A single line of text)
[-g sendFromGuildAccount] - boolean
Send from the api key registered to the guild
[-a apiKey] - String
The api key to use to send the mail
(A single line of text)
[-b hideDefaultBlurb] - boolean
Hide the default blurb from the message
[-f force] - boolean
[-l useLeader] - boolean
Parse nation leader instead of nation name
[-d dm] - boolean
Send instructions as direct message on discord

See also

You can generate war rooms from a war blitz sheet, and ping nations with their targets, and a prewritten instruction

Locutus/Wiki/war_rooms

Clone this wiki locally