Skip to content

Home

Jump to bottom
xdnw edited this page Nov 25, 2023 · 38 revisions

Command Syntax

  • <arg> - A required parameter
  • [arg] - An optional parameter
  • <arg1|arg2> - Multiple parameters options
  • <arg=value> - Default or suggested value
  • [-f flag] - A optional command argument flag

Using the help commands

Show the description, usage information and permissions for a command

/help command

Locate a command you are looking for. Use keywords for relevant results, or ask a question.

/help find_command

Locate a nation placeholder you are looking for. Use keywords for relevant results, or ask a question.

/help find_nation_placeholder

Show the description, usage information and permissions for a nation placeholder

/help nation_placeholder

For server owners

List available settings

/settings info

Locate a setting you are looking for. Use keywords for relevant results, or ask a question.

/help find_setting

List ALL settings

/settings info listall: true

View a setting

For example, the ALLIANCE_ID settings

/settings info key: ALLIANCE_ID

Overview of this Wiki

initial setup

  • Inviting the bot to your discord server
  • Registering your nation
  • Registering your alliance
  • Creating and registering roles
  • Remove a role alias
  • Setting your API Key

hosting_locutus

  • Table of Contents
    1. Obtaining a Locutus .jar file
    1. Setting up the config yaml
    1. Credentials for Google Sheets

commands

List and description of all commands.

arguments

List and description of all command arguments.

war alerts

  • Prerequisites
  • War Declarations
  • War Status Updates
  • Espionage
  • Target alerts
  • Militarization
  • Login Alerts

auto masking

  • Prerequisites
  • Nicknames
  • Verified roles
  • Manually running the autorole task
  • Alliance Name Roles
  • Applicant / Member roles
  • City Range roles
  • Tax roles
  • Conditional roles
  • Sync roles
  • Bulk role add/remove

embassies

  • Creating embassy category
  • Set the rank required for opening embassies:
  • Open an embassy

deposits

  • Viewing balances
  • Transfer Notes
  • Tax accounts & Including taxes in deposits
  • Manually adding/subtracing balances
  • Shifting balance notes
  • Converting negative deposits
  • Resetting deposits
  • Allow members to withdraw or offshore
  • Resource conversion
  • Alerts
  • Transfer command arguments

bank_flows

  • Balance Flow types
  • Viewing Balance Flow breakdown
  • Adjusting Balance Flows
  • Money Trades

banking

  • Prerequisites
  • Using the public offshore
  • Offshoring funds
  • For my nation
  • Checking alliance/guild balance
  • Using the local alliance
  • Running your own offshore
  • Removing an offshore
  • Enabling member withdrawals
  • Transfer commands
  • Transfer limits
  • Route Withdrawals via Alliance Bank
  • Offshore browser addon

grant_templates

  • Template Types
  • Creating a template
  • Enabling or disabling a template
  • Listing your template
  • Viewing, copying and editing a template
  • Deleting a template
  • Requirements

recruitment

  • Set an INTERNAL_AFFAIRS role
  • Setup a recruitment message
  • Send a test message
  • Other recruitment strategies

do_not_raid

  • Violation Alerts
  • Ignore another alliance's violations
  • Ping milcom for an alliances violations
  • Instruct FA to attempt peace
  • Set DNR to top alliances
  • Check the DNR
  • DNR an alliance and its applicants
  • Remove an alliance from the DNR coalition
  • DNR only members
  • DNR only inactive

coalitions

  • In built coalitions
  • Adding to in-built coalition
  • Listing your current coalitions
  • Removing a coalition
  • Creating a custom coaltion
  • Generating a coalition from treaty web
  • Using guilds in coalitions

war rooms

  • Known limitations
  • Enabling war rooms
  • Using a war server
  • Creating a war room
  • Category sorting
  • Generating from blitz sheet
  • War room pins
  • Manually closing war rooms
  • Creating a sheet of war rooms
  • Force update war rooms

countering

  • Find a member in range of an enemy
  • Create a sheet of uncountered enemies
  • Create a war room
  • Auto find counters and create war rooms
  • General player tips for countering:

tax_automation

  • Prerequisites
  • Viewing tax records for a nation
  • View tax brackets / revenue
  • Setting the tax bracket for a nation
  • Tax bracket accounts
  • Internal tax rates
  • Automated conditional tax brackets
  • Automated conditional internal rates
  • Letting members change their tax bracket

auditing

  • Auditing MMR
  • Auditing Warchest
  • Join Leave Alerts
  • Automatic Attack Audits
  • Create or send audit reports
  • New applicant auditing
  • Econ related auditing
  • Day change
  • Espionage

escrow

  • Viewing escrow
  • Using escrow with transfer commands
  • Withdraw escrow
  • Add escrow
  • Reset escrow
  • Add or set escrow using a sheet
  • Escrow alerts

sending targets

  • Converting spy sheet formats
  • Sheet validation
  • Sending sheets

blockade_tools

  • Set the blockade alert channels
  • Blockade Roles
  • Member unblockade requests
  • Target finder enemies blockading allies

beige cycling

  • Alerts When Enemies Are Beiged
  • Set member beige cycling requirements
  • Alerts when beige cycling violations occur
  • Using Locutus to check if an enemy can be beiged
  • What is Beige
  • How to maximize your attacks during a war
  • What is beige cycling?
  • Example Beige cycling checklist:

loan reporting

  • Loan Reporting Overview
  • Valid loan status
  • Adding, updating and removing a single loan
  • Viewing loans
  • Using Sheets to bulk add, update or replace loans
  • Bulk deleting loans
  • Marking loan information as updated
  • Global Loan and Report alert channel
  • Player bank discord server

reporting

  • Reporting overview
  • What can be reported
  • Creating and editing a report
  • Viewing reports
  • A report of me is false or no longer valid
  • I've been banned from creating reports
  • I would like to help verify reports
  • Administrating reports (Locutus server only)

announcements and opsec

  • Prerequisite settings
  • Bulk mail
  • Reply to messages
  • Mail command results
  • Mail a google spreadsheet
  • Sending unique announcements
  • Sending unique invites
  • Sending unique documents
  • Sending unique polls
  • Converting a screenshot to text
  • Finding a nation from a message or invite
  • Other announcement commands

embeds

  • Embed templates
  • View the commands for an embed
  • Create an embed with title and description
  • Update the title and description
  • Remove a button from an embed
  • Add a button to an embed
  • Add a modal (prompt button) to an embed
  • Multiple commands in one button

custom spreadsheets

  • Premade sheet templates/selections

ai_tools

  • Locutus Chatbot,Work in progress
  • Emojify your discord

Placeholders & Filters

Used in commands to filter a selection, or as placeholders for sheets or messages

Clone this wiki locally