Command reference
Clan
Command words: clan
Permission: Any
This clan is used to both interact with and create or edit clans. Clans can represent organisations, companies, hierarchies, fellowships and many other types of communities.
To see what clans you are a part of (or for admins to see all clans), use the following commands:
clans - shows all clans that you are a member of
clans templates - shows all template clans
clan list - a tabular view of all your clans (or all clans for admins)
The clan list command can accept the following filter arguments:
+<keyword> - show only clans with this text in their name
-<keyword> - show only clans without this text in their name
The following clan sub-commands are used to interact with clans:
clan invite <person> <clan> [<rank path>] - invites a person to a clan
clan castout <person> <clan> - kicks a person out of a clan
clan promote <person> <clan> [<rank>] - promotes a person (1 rank or to the specified rank)
clan demote <person> <clan> [<rank>] - demotes a person (1 rank or to the specified rank)
clan paygrade promote <person> <clan> - promotes a person 1 paygrade rank
clan paygrade demote <person> <clan> - demotes a person 1 paygrade rank
clan appoint <person> <clan> <appointment> - appoints a person to a clan appointment
clan dismiss <person> <clan> <appointment> - dismisses a person from a clan appointment
clan reportdead <clan> <person> - reports a person as dead or long-term missing
clan pay <person> <clan> <how much> - manually adds backpay owing to a person
clan budget <clan> <...> - manages appointment budgets for a clan
clan balance <clan> - reviews a clan balance sheet
clan payroll <clan> [member|rank|appointment <which>] - reviews payroll history
clan maxpay <clan> <max multiple backpay> - sets the maximum backpay permissable for a clan
clan payinterval <clan> "<every x days|weeks|months|years>" - sets the pay interval
clan payinterval <clan> "<every x days|weeks|months|years>" [<date time>] - sets the pay interval and the reference date time
clan view <clan> - views information about a clan
clan members <clan> - views the member list for a clan
clan treasury <clan> [toggle] - sets your current location as a treasury cell for a clan (ADMIN ONLY)
clan treasury <clan> balance|ledger [count] - reviews the clan's virtual treasury
clan treasury <clan> deposit|withdraw <amount> - moves cash into or out of the clan's virtual treasury
clan admin <clan> - sets your current location as an admin cell for a clan (ADMIN ONLY)
clan hall <clan> - sets your current location as a clan hall cell for a clan (ADMIN ONLY)
clan vassal appoint <who> <clan> <position> [<liege clan>] - appoints a person to a clan appointment in a vassal clan
clan vassal dismiss <who> <clan> <position> [<liege clan>] - dismisses a person from a clan appointment in a vassal clan
clan vassal control <clan> <position> <liege appointment|none> [<liege clan>] - sets which liege appointment controls a vassal appointment
clan submit <clan> <position> <new liege> [<liege appointment>] [<max appointees>] - submits a clan appointment to the control of an external clan
clan release <vassal clan> <position> [<liege clan>] - releases a vassal clan from your clan's control
clan transfer <vassal clan> <position> <new liege> [<old liege>] - transfers a vassal clan relationship to a new clan
clan disband <clan> - permanently disbands and deletes a clan - warning, cannot be undone
clan economiczone list - lists all economic zones which your clans control
clan economiczone <which> <...> - interacts with an economic zone your clan has control over
clan properties - shows which real estate properties your clan owns
clan lease <clan> <property> <term> - leases a property on behalf of a clan
clan lease <clan> <property> <term> <bankcode>:<accn> - leases a property on behalf of a clan
clan buy <clan> <property> - buys a property on behalf of the clan
clan buy <clan> <property> <bankcode>:<accn> - buys a property on behalf of the clan
clan divest <clan> <property> <percentage> <target> - divests ownership in a clan property to an individual
clan divest <clan> <property> <percentage> *<other clan> - divests ownership in a clan property to another clan
The following clan sub-commands pertain to elections and voting:
clan elections [<clan>] - views all elections
clan election view <election id> | <clan> <appointment> - views a specific election
clan election history <election id> | <clan> <appointment> - views the history of elections for a particular clan or position
clan nominate <election id> | <clan> <appointment> - nominates yourself as a candidate in an election
clan withdrawnomination <election id> | <clan> <appointment> - withdraws yourself as a candidate from an election
clan vote <election id> | <clan> <appointment> <who> - votes in an election
The command to create a new clan is as follows:
clan create new <alias> <name> - creates an empty clan
clan create template <template> <alias> <name> - creates a clan from a clan template
clan templates - shows a list of clan templates
In order to edit properties, positions, ranks etc of a clan one must:
clan edit <clan>
All of the following commands must happen with an edited clan selected:
clan create rank <name> <abbreviation> before|after <other> - creates a new rank
clan create paygrade <name> <abbreviation> <currency> <amount> - creates a new paygrade
clan create appointment <name> <abbreviation> [under <other>] - creates a new appointment
clan remove rank <rank> - deletes a rank
clan remove appointment <appointment> - deletes an appointment
clan remove paygrade <paygrade> - deletes a paygrade
clan set name <name> - sets the clan's name
clan set alias <alias> - sets the clan's alias
clan set desc - drops you into an editor to set clan's description
clan set rank ... - edits clan ranks. See command for more info.
clan set paygrade ... - edits paygrades. See command for more info.
clan set appointment ... - edits appointments. See command for more info.
clan set sphere <which> - sets the sphere for this clan (admin only)
clan set template - toggles this clan being a template clan (admin only)
clan set notable - toggles this clan appearing in WHO (admin only)
clan set notablemembers - toggles the famous members of this clan appearing in NOTABLES (admin only)
clan set bankaccount <account>|none - sets or clears a bank account for this clan
clan set calendar <which> - changes the calendar that the clan uses
Permission: Any
This clan is used to both interact with and create or edit clans. Clans can represent organisations, companies, hierarchies, fellowships and many other types of communities.
To see what clans you are a part of (or for admins to see all clans), use the following commands:
clans - shows all clans that you are a member of
clans templates - shows all template clans
clan list - a tabular view of all your clans (or all clans for admins)
The clan list command can accept the following filter arguments:
+<keyword> - show only clans with this text in their name
-<keyword> - show only clans without this text in their name
The following clan sub-commands are used to interact with clans:
clan invite <person> <clan> [<rank path>] - invites a person to a clan
clan castout <person> <clan> - kicks a person out of a clan
clan promote <person> <clan> [<rank>] - promotes a person (1 rank or to the specified rank)
clan demote <person> <clan> [<rank>] - demotes a person (1 rank or to the specified rank)
clan paygrade promote <person> <clan> - promotes a person 1 paygrade rank
clan paygrade demote <person> <clan> - demotes a person 1 paygrade rank
clan appoint <person> <clan> <appointment> - appoints a person to a clan appointment
clan dismiss <person> <clan> <appointment> - dismisses a person from a clan appointment
clan reportdead <clan> <person> - reports a person as dead or long-term missing
clan pay <person> <clan> <how much> - manually adds backpay owing to a person
clan budget <clan> <...> - manages appointment budgets for a clan
clan balance <clan> - reviews a clan balance sheet
clan payroll <clan> [member|rank|appointment <which>] - reviews payroll history
clan maxpay <clan> <max multiple backpay> - sets the maximum backpay permissable for a clan
clan payinterval <clan> "<every x days|weeks|months|years>" - sets the pay interval
clan payinterval <clan> "<every x days|weeks|months|years>" [<date time>] - sets the pay interval and the reference date time
clan view <clan> - views information about a clan
clan members <clan> - views the member list for a clan
clan treasury <clan> [toggle] - sets your current location as a treasury cell for a clan (ADMIN ONLY)
clan treasury <clan> balance|ledger [count] - reviews the clan's virtual treasury
clan treasury <clan> deposit|withdraw <amount> - moves cash into or out of the clan's virtual treasury
clan admin <clan> - sets your current location as an admin cell for a clan (ADMIN ONLY)
clan hall <clan> - sets your current location as a clan hall cell for a clan (ADMIN ONLY)
clan vassal appoint <who> <clan> <position> [<liege clan>] - appoints a person to a clan appointment in a vassal clan
clan vassal dismiss <who> <clan> <position> [<liege clan>] - dismisses a person from a clan appointment in a vassal clan
clan vassal control <clan> <position> <liege appointment|none> [<liege clan>] - sets which liege appointment controls a vassal appointment
clan submit <clan> <position> <new liege> [<liege appointment>] [<max appointees>] - submits a clan appointment to the control of an external clan
clan release <vassal clan> <position> [<liege clan>] - releases a vassal clan from your clan's control
clan transfer <vassal clan> <position> <new liege> [<old liege>] - transfers a vassal clan relationship to a new clan
clan disband <clan> - permanently disbands and deletes a clan - warning, cannot be undone
clan economiczone list - lists all economic zones which your clans control
clan economiczone <which> <...> - interacts with an economic zone your clan has control over
clan properties - shows which real estate properties your clan owns
clan lease <clan> <property> <term> - leases a property on behalf of a clan
clan lease <clan> <property> <term> <bankcode>:<accn> - leases a property on behalf of a clan
clan buy <clan> <property> - buys a property on behalf of the clan
clan buy <clan> <property> <bankcode>:<accn> - buys a property on behalf of the clan
clan divest <clan> <property> <percentage> <target> - divests ownership in a clan property to an individual
clan divest <clan> <property> <percentage> *<other clan> - divests ownership in a clan property to another clan
The following clan sub-commands pertain to elections and voting:
clan elections [<clan>] - views all elections
clan election view <election id> | <clan> <appointment> - views a specific election
clan election history <election id> | <clan> <appointment> - views the history of elections for a particular clan or position
clan nominate <election id> | <clan> <appointment> - nominates yourself as a candidate in an election
clan withdrawnomination <election id> | <clan> <appointment> - withdraws yourself as a candidate from an election
clan vote <election id> | <clan> <appointment> <who> - votes in an election
The command to create a new clan is as follows:
clan create new <alias> <name> - creates an empty clan
clan create template <template> <alias> <name> - creates a clan from a clan template
clan templates - shows a list of clan templates
In order to edit properties, positions, ranks etc of a clan one must:
clan edit <clan>
All of the following commands must happen with an edited clan selected:
clan create rank <name> <abbreviation> before|after <other> - creates a new rank
clan create paygrade <name> <abbreviation> <currency> <amount> - creates a new paygrade
clan create appointment <name> <abbreviation> [under <other>] - creates a new appointment
clan remove rank <rank> - deletes a rank
clan remove appointment <appointment> - deletes an appointment
clan remove paygrade <paygrade> - deletes a paygrade
clan set name <name> - sets the clan's name
clan set alias <alias> - sets the clan's alias
clan set desc - drops you into an editor to set clan's description
clan set rank ... - edits clan ranks. See command for more info.
clan set paygrade ... - edits paygrades. See command for more info.
clan set appointment ... - edits appointments. See command for more info.
clan set sphere <which> - sets the sphere for this clan (admin only)
clan set template - toggles this clan being a template clan (admin only)
clan set notable - toggles this clan appearing in WHO (admin only)
clan set notablemembers - toggles the famous members of this clan appearing in NOTABLES (admin only)
clan set bankaccount <account>|none - sets or clears a bank account for this clan
clan set calendar <which> - changes the calendar that the clan uses