-
Notifications
You must be signed in to change notification settings - Fork 5
escrow
Escrowed funds are not transferred in-game, but are added to a nation's escrow account.
When escrowing via a transfer command, this can deduct from member balance based on the note used e.g. #deposit.
Escrowing does not deduct from the alliance/guild's offshore when no funds are sent in-game.
Overview:
- Escrowed funds can be withdrawn by the receiver when their blockade ends
- Escrow can be set to expire
- Bulk set, add, reset or view escrow for multiple nations
- Modify escrow based on deposits, cities, stockpile, or current military units
| 📚 Displays the account balance for a nation, alliance or guild... |
|---|
/deposits check
Displays the account balance for a nation, alliance or guild
Balance info includes deposits, loans, grants, taxes and escrow
Arguments:
<nationOrAllianceOrGuild> - [NationOrAllianceOrGuildOrTaxid](arguments#nationorallianceorguildortaxid)
Account to check holdings for
(A nation or alliance name, url or id, or a guild id, or a tax id or url)
[-a offshores] - [Set](arguments#setdballiance)
The alliances to check transfers from
Otherwise the guild configured ones will be used
(A comma separated list of alliances)
[-c timeCutoff] - [Long[Timestamp]](arguments#longtimestamp)
Only include transfers after this time
(A unix timestamp, a DMY date or a time difference that will resolve to a timestamp from the current date)
[-b includeBaseTaxes] - [boolean](arguments#boolean)
Include all taxes in account balance
[-o ignoreInternalOffsets] - [boolean](arguments#boolean)
Do NOT include manual offsets in account balance
[-t showCategories] - [Boolean](arguments#boolean)
Show separate sections for taxes and deposits
[-d replyInDMs] - [boolean](arguments#boolean)
[-e includeExpired] - [boolean](arguments#boolean)
Include expired transfers
[-i includeIgnored] - [boolean](arguments#boolean)
Include transfers marked as ignore
[-z allowCheckDeleted] - [boolean](arguments#boolean)
[-h hideEscrowed] - [boolean](arguments#boolean)
Hide the escrow balance
| 📚 Create a google sheet of escrowed resources amounts for a set of nations |
|---|
/escrow view_sheet
Create a google sheet of escrowed resources amounts for a set of nations
Arguments:
[nations] - [Set](arguments#setdbnation)
A comma separated list of nations, alliances and filters
[-p includePastDepositors] - [Set](arguments#setinteger)
[-s sheet] - [SpreadSheet](arguments#spreadsheet)
A google spreadsheet id or url
For shorthand, use a comma when specifying the sheet tab e.g. `sheet:ID,TAB_NAME`For a url, append `#gid=1234` or `#tab=tabName` to specify the id of the tab to use
| 📚 Get a sheet with member nations and their deposits... |
|---|
/deposits sheet
Get a sheet with member nations and their deposits
Each nation's safekeep should match the total balance given by deposits commandAdd -b to
Add -o to not include any manual deposit offsets
Add -d to not include deposits
Add -t to not include taxes
Add -l to not include loans
Add -g to not include grants
Add -p to include past depositors
Add -f to force an update
Arguments:
[nations] - [Set](arguments#setdbnation)
A comma separated list of nations, alliances and filters
[offshores] - [Set](arguments#setdballiance)
The alliances to track transfers from
(A comma separated list of alliances)
[-b ignoreTaxBase] - [boolean](arguments#boolean)
use 0/0 as the tax base
[-o ignoreOffsets] - [boolean](arguments#boolean)
Do NOT include any manual deposit offsets
[-t noTaxes] - [boolean](arguments#boolean)
Do NOT include taxes
[-l noLoans] - [boolean](arguments#boolean)
Do NOT include loans
[-g noGrants] - [boolean](arguments#boolean)
Do NOT include grants
[-d noDeposits] - [boolean](arguments#boolean)
Do NOT include deposits
[-p includePastDepositors] - [Set](arguments#setinteger)
Include past depositors
[-e noEscrowSheet] - [boolean](arguments#boolean)
Do NOT include escrow sheet
[-n useFlowNote] - [DepositType](arguments#deposittype)
Only show the flow for this note
i.e. To only see funds marked as #TRADE
This is for transfer flow breakdown internal, withdrawal, and deposit
(A note to use for a bank transfer)
[-f force] - [boolean](arguments#boolean)
Control whether a transfer is escrowed when
- NEVER
- WHEN_BLOCKADED
- ALWAYS
Use the escrowMode argument for the transfer commands, e.g.
/transfer self transfer: food=10 escrow_mode: WHEN_BLOCKADED
| 📚 Send multiple transfers to nations/alliances according to a sheet... |
|---|
/transfer bulk
Send multiple transfers to nations/alliances according to a sheet
The transfer sheet columns must be nations (which has the nations or alliance name/id/url)
and then there must be a column named for each resource type you wish to transfer
OR use a column called resources which has a resource list (e.g. a json object of the resources)
Arguments:
<sheet> - [TransferSheet](arguments#transfersheet)
A google spreadsheet id or url. Must have a `nation` or `leader` column as well as the names of each resource
<depositType> - [DepositTypeInfo](arguments#deposittypeinfo)
A DepositType optionally with a value and a city tag
[-n depositsAccount] - [DBNation](arguments#dbnation)
The nation account to deduct from
(nation id, name or url)
[-a useAllianceBank] - [DBAlliance](arguments#dballiance)
The alliance bank to send from
Defaults to the offshore
(An alliance name id or url)
[-o useOffshoreAccount] - [DBAlliance](arguments#dballiance)
The alliance account to deduct from
Alliance must be registered to this guild
Defaults to all the alliances of this guild
(An alliance name id or url)
[-t taxAccount] - [TaxBracket](arguments#taxbracket)
The tax account to deduct from
(A tax id or url)
[-ta existingTaxAccount] - [boolean](arguments#boolean)
Deduct from the receiver's tax bracket account
[-e expire] - [Long[Timediff]](arguments#longtimediff)
Have the transfer ignored from nation holdings after a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-d decay] - [Long[Timediff]](arguments#longtimediff)
Have the transfer decrease linearly over a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-m convertToMoney] - [boolean](arguments#boolean)
[-em escrow_mode] - [EscrowMode](arguments#escrowmode)
The mode for escrowing funds (e.g. if the receiver is blockaded)
Defaults to never
(The mode for escrowing funds for a transfer, such as when a receiver is blockaded)
[-b bypassChecks] - [boolean](arguments#boolean)
[-f force] - [boolean](arguments#boolean)
[-k key] - [UUID](arguments#uuid)
Universally Unique IDentifier
| 📚 Transfer from the alliance bank (alliance deposits) |
|---|
/transfer resources
Transfer from the alliance bank (alliance deposits)
Arguments:
<receiver> - [NationOrAlliance](arguments#nationoralliance)
A nation or alliance name, url or id. Prefix with `AA:` or `nation:` to avoid ambiguity if there exists both by the same name or id
<transfer> - [Map[AllianceDepositLimit]](arguments#mapresourcetype-doublealliancedepositlimit)
A comma separated list of resources and their amounts, which will be restricted by an alliance's account balance
<depositType> - [DepositTypeInfo](arguments#deposittypeinfo)
A DepositType optionally with a value and a city tag
[-n nationAccount] - [DBNation](arguments#dbnation)
The nation account to deduct from
(nation id, name or url)
[-a senderAlliance] - [DBAlliance](arguments#dballiance)
The alliance bank to send from
Defaults to the offshore
(An alliance name id or url)
[-o allianceAccount] - [DBAlliance](arguments#dballiance)
The alliance account to deduct from
Alliance must be registered to this guild
Defaults to all the alliances of this guild
(An alliance name id or url)
[-t taxAccount] - [TaxBracket](arguments#taxbracket)
The tax account to deduct from
(A tax id or url)
[-ta existingTaxAccount] - [boolean](arguments#boolean)
Deduct from the receiver's tax bracket account
[-m onlyMissingFunds] - [boolean](arguments#boolean)
Only send funds the receiver is lacking from the amount
[-e expire] - [Long[Timediff]](arguments#longtimediff)
Have the transfer ignored from nation holdings after a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-d decay] - [Long[Timediff]](arguments#longtimediff)
Have the transfer decrease linearly to zero for balances over a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-g token] - [UUID](arguments#uuid)
Universally Unique IDentifier
[-c convertCash] - [boolean](arguments#boolean)
Transfer valued at cash equivalent in nation holdings
[-em escrow_mode] - [EscrowMode](arguments#escrowmode)
The mode for escrowing funds (e.g. if the receiver is blockaded)
Defaults to never
(The mode for escrowing funds for a transfer, such as when a receiver is blockaded)
[-b bypassChecks] - [boolean](arguments#boolean)
[-f force] - [boolean](arguments#boolean)
| 📚 Disburse raw resources needed to operate cities |
|---|
/transfer raws
Disburse raw resources needed to operate cities
Arguments:
<nationList> - [NationList](arguments#nationlist)
A comma separated list of nations, alliances and filters
<daysDefault> - [double](arguments#double)
Days of operation to send
(A decimal number)
[depositType=#tax] - [DepositTypeInfo](arguments#deposittypeinfo)
The transfer note
Use `#IGNORE` to not deduct from deposits
(A DepositType optionally with a value and a city tag)
[-dc noDailyCash] - [boolean](arguments#boolean)
Do not send money below the daily login bonus
[-c noCash] - [boolean](arguments#boolean)
Do not send ANY money
[-n depositsAccount] - [DBNation](arguments#dbnation)
The nation account to deduct from
(nation id, name or url)
[-a useAllianceBank] - [DBAlliance](arguments#dballiance)
The alliance bank to send from
Defaults to the offshore
(An alliance name id or url)
[-o useOffshoreAccount] - [DBAlliance](arguments#dballiance)
The alliance account to deduct from
Alliance must be registered to this guild
Defaults to all the alliances of this guild
(An alliance name id or url)
[-t taxAccount] - [TaxBracket](arguments#taxbracket)
The tax account to deduct from
(A tax id or url)
[-ta existingTaxAccount] - [boolean](arguments#boolean)
Deduct from the receiver's tax bracket account
[-e expire] - [Long[Timediff]](arguments#longtimediff)
Have the transfer ignored from nation holdings after a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-d decay] - [Long[Timediff]](arguments#longtimediff)
Have the transfer decrease linearly from balances over a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-m convertToMoney] - [boolean](arguments#boolean)
Have the transfer valued as cash in nation holdings
[-em escrow_mode] - [EscrowMode](arguments#escrowmode)
The mode for escrowing funds (e.g. if the receiver is blockaded)
Defaults to never
(The mode for escrowing funds for a transfer, such as when a receiver is blockaded)
[-b bypassChecks] - [boolean](arguments#boolean)
[-f force] - [boolean](arguments#boolean)
| 📚 Withdraw from the alliance bank (your deposits) |
|---|
/transfer self
Withdraw from the alliance bank (your deposits)
Arguments:
<transfer> - [Map[NationDepositLimit]](arguments#mapresourcetype-doublenationdepositlimit)
A comma separated list of resources and their amounts, which will be restricted by an nations's account balance
[depositType=#deposit] - [DepositTypeInfo](arguments#deposittypeinfo)
A DepositType optionally with a value and a city tag
[-n depositsAccount] - [DBNation](arguments#dbnation)
The nation account to deduct from
(nation id, name or url)
[-a useAllianceBank] - [DBAlliance](arguments#dballiance)
The alliance bank to send from
Defaults to the offshore
(An alliance name id or url)
[-o useOffshoreAccount] - [DBAlliance](arguments#dballiance)
The alliance account to deduct from
Alliance must be registered to this guild
Defaults to all the alliances of this guild
(An alliance name id or url)
[-t taxAccount] - [TaxBracket](arguments#taxbracket)
The tax account to deduct from
(A tax id or url)
[-ta existingTaxAccount] - [boolean](arguments#boolean)
Deduct from the receiver's tax bracket account
[-m onlyMissingFunds] - [boolean](arguments#boolean)
Only send funds the receiver is lacking from the amount
[-e expire] - [Long[Timediff]](arguments#longtimediff)
Have the transfer ignored from nation holdings after a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-d decay] - [Long[Timediff]](arguments#longtimediff)
Have the transfer decrease linearly from balances over a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-g token] - [UUID](arguments#uuid)
Universally Unique IDentifier
[-c convertCash] - [boolean](arguments#boolean)
Transfer valued at cash equivalent in nation holdings
[-em escrow_mode] - [EscrowMode](arguments#escrowmode)
The mode for escrowing funds (e.g. if the receiver is blockaded)
Defaults to never
(The mode for escrowing funds for a transfer, such as when a receiver is blockaded)
[-b bypassChecks] - [boolean](arguments#boolean)
[-f force] - [boolean](arguments#boolean)
| 📚 Transfer the missing resource amounts per city to a list of nations |
|---|
/transfer warchest
Transfer the missing resource amounts per city to a list of nations
Arguments:
<nations> - [NationList](arguments#nationlist)
A comma separated list of nations, alliances and filters
<resourcesPerCity> - [Map](arguments#mapresourcetype-double)
The resources each nation needs for each city
Only resources they are missing is sent
(A comma separated list of resources and their amounts)
[note] - [DepositTypeInfo](arguments#deposittypeinfo)
The transfer note to use
Defaults to `#WARCHEST`
(A DepositType optionally with a value and a city tag)
[-s skipStockpile] - [boolean](arguments#boolean)
Do not check nation stockpile
Sends the full amount of resources to each nation
[-n depositsAccount] - [DBNation](arguments#dbnation)
The nation account to deduct from
(nation id, name or url)
[-a useAllianceBank] - [DBAlliance](arguments#dballiance)
The alliance bank to send from
Defaults to the offshore
(An alliance name id or url)
[-o useOffshoreAccount] - [DBAlliance](arguments#dballiance)
The alliance account to deduct from
Alliance must be registered to this guild
Defaults to all the alliances of this guild
(An alliance name id or url)
[-t taxAccount] - [TaxBracket](arguments#taxbracket)
The tax account to deduct from
(A tax id or url)
[-ta existingTaxAccount] - [boolean](arguments#boolean)
Deduct from the receiver's tax bracket account
[-e expire] - [Long[Timediff]](arguments#longtimediff)
Have the transfer ignored from nation holdings after a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-d decay] - [Long[Timediff]](arguments#longtimediff)
Have the transfer decay linearly in balances over a timeframe
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-m convertToMoney] - [boolean](arguments#boolean)
Have the transfer valued as cash in nation holdings
[-em escrow_mode] - [EscrowMode](arguments#escrowmode)
The mode for escrowing funds (e.g. if the receiver is blockaded)
Defaults to never
(The mode for escrowing funds for a transfer, such as when a receiver is blockaded)
[-b bypassChecks] - [boolean](arguments#boolean)
[-f force] - [boolean](arguments#boolean)
Add an argument such as escrow:WHEN_BLOCKADED to the legacy ! commands
/escrow withdraw
No description provided
Arguments:
<receiver> - [DBNation](arguments#dbnation)
nation id, name or url
<amount> - [Map](arguments#mapresourcetype-double)
A comma separated list of resources and their amounts
[-f force] - [boolean](arguments#boolean)
Add amounts to nation's existing escrow balance
- Use negative to remove escrow amounts
- See the arguments for handling cities/stockpile/military units
| 📚 Add funds to the escrow account for a set of nations... |
|---|
/escrow add
Add funds to the escrow account for a set of nations
Escrow funds can be withdrawn at a later date by the receiver, such as when a blockade ends
To transfer funds from a nation's deposits into their escrow, see the transfer command
Arguments:
<nations> - [NationList](arguments#nationlist)
A comma separated list of nations, alliances and filters
[-b amountBase] - [Map](arguments#mapresourcetype-double)
The base amount of resources to escrow
If per city is set, the highest value of each resource is chosen
(A comma separated list of resources and their amounts)
[-p amountPerCity] - [Map](arguments#mapresourcetype-double)
Amount of resources to escrow for each city the receiver has
If base is set, the highest value of each resource is chosen
This uses the city count now, not when the funds are withdrawn later
(A comma separated list of resources and their amounts)
[-e amountExtra] - [Map](arguments#mapresourcetype-double)
Additional resources to escrow
If a base or per city are set, this adds to what is calculated for that
(A comma separated list of resources and their amounts)
[-s subtractStockpile] - [boolean](arguments#boolean)
Don't add escrow resources that the nation has in their stockpile
[-m subtractNationsUnits] - [Set](arguments#setmilitaryunit)
When the nation has these units, don't add the resources equivalent to their cost
Useful to only give resources to those missing units
(A comma separated list of military units)
[-d subtractDeposits] - [boolean](arguments#boolean)
Do not add escrow resources that the nation has in their deposits
[expireAfter] - [Long[Timediff]](arguments#longtimediff)
Delete all receiver escrow after a time period
Recommended: 5d
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-f force] - [boolean](arguments#boolean)
Overwrite existing and set nations escrow balance
- See the arguments for handling cities/stockpile/military units
| 📚 Set the escrow account balances for a set of nations... |
|---|
/escrow set
Set the escrow account balances for a set of nations
Escrow funds can be withdrawn at a later date by the receiver, such as when a blockade ends
To transfer funds from a nation's deposits into their escrow, see the transfer command
Arguments:
<nations> - [NationList](arguments#nationlist)
A comma separated list of nations, alliances and filters
[-b amountBase] - [Map](arguments#mapresourcetype-double)
The base amount of resources to escrow
If per city is set, the highest value of each resource is chosen
(A comma separated list of resources and their amounts)
[-p amountPerCity] - [Map](arguments#mapresourcetype-double)
Amount of resources to escrow for each city the receiver has
If base is set, the highest value of each resource is chosen
This uses the city count now, not when the funds are withdrawn later
(A comma separated list of resources and their amounts)
[-e amountExtra] - [Map](arguments#mapresourcetype-double)
Additional resources to escrow
If a base or per city are set, this adds to what is calculated for that
(A comma separated list of resources and their amounts)
[-s subtractStockpile] - [boolean](arguments#boolean)
Don't add escrow resources that the nation has in their stockpile
[-m subtractNationsUnits] - [Set](arguments#setmilitaryunit)
When the nation has these units, don't add the resources equivalent to their cost
Useful to only give resources to those missing units
(A comma separated list of military units)
[-d subtractDeposits] - [boolean](arguments#boolean)
Do not add escrow resources that the nation has in their deposits
[expireAfter] - [Long[Timediff]](arguments#longtimediff)
Delete all receiver escrow after a time period
Recommended: 5d
(A time difference or unix timestamp which will resolve as a difference relative to the current date)
[-f force] - [boolean](arguments#boolean)
/deposits reset nations: ignoregrants: true ignoreloans: true ignoretaxes: true ignorebankdeposits: true ignoreescrow: false
| 📚 Set the escrow account balances for nation to the values in a spreadshet... |
|---|
/escrow set_sheet
Set the escrow account balances for nation to the values in a spreadshet
The sheet must have a nation column, and then a column for each resource type
Escrow funds can be withdrawn at a later date by the receiver, such as when a blockade ends
Use the deposits sheet command to get a spreadsheet of the current escrow balances
Arguments:
<sheet> - [TransferSheet](arguments#transfersheet)
A google spreadsheet id or url. Must have a `nation` or `leader` column as well as the names of each resource
[expireAfter] - [Long[Timediff]](arguments#longtimediff)
A time difference or unix timestamp which will resolve as a difference relative to the current date
[-f force] - [boolean](arguments#boolean)
Setup blockade alerts: Locutus/Wiki/blockade_tools
/role setalias locutusrole: ESCROW_GOV_ALERT discordrole: @escrowGovRole