Commands

From CryptoKingdom Wiki
Jump to: navigation, search

Comprehensive Commands Guide[edit | edit source]

(Original version by Syksy, December 2015) (Multiple updates post-Dec 2015)

Introduction[edit | edit source]

This wiki aims to introduce and to remind of the most important commands available in CK. Each command is illustrated with case examples and a general description of its intended use.

Common information[edit | edit source]

  • Commands are not case sensitive, but some fields may be (for example in item creation).
  • Commands are generally run in the "Command line"-box, available in any item page. Alternatively, it's possible to build post-commands that are posted directly to the CK API, but this requires sophisticated coding and is not advisable for new players.
  • Multiple commands can be run sequentually within a single "Command line"-box run if need be; press shift+enter to add a new line without running the existing sequence of commands or copy-paste a multiline command sequence from a text editor.
  • The commands have been put into three categories (i) Basic commands available for all; (ii) Advanced commands available for all; (iii) Commands available only to (senior) admins, and (iv) for known internal commands that are not available for player usage.
  • If an invalid command or syntax is run, the result-field will report this. Alternatively, if the syntax is correct, it reports the successful outcome of a command.
  • Commands are written here in capital letters, although it's not strictly required by the command line (case insensitive). Additionally, input and output from the command lines are indicated with the "-quotes within this guide.
  • Notice that the character ID #5 (="New") has a special meaning in many of the commands. It is a "void" from where items can be created and given to. For example, a non-admin player can destroy an item using "GIVE myItemID 1 5".
  • The character shortName and character id number can be used interchangeable for most commands. For example, for me, my shortName "Syksy" or character id "138" can be used as a refence in many commands as the recipient or target.
  • The abbreviation "mil" can be used to replace "000000" in many commands.
  • Since December 28th, all commands can be commented by adding "COMMAND par1 par2 par3 [comment here]" syntax, to clarify why certain actions have been taken. This is especially encouraged for admin commands that might be otherwise ambiguous.

Each command is reported with the following fields:

  • COMMANDNAME
  • Description:
  • Syntax:
  • Related commands:
  • Source:
  • Case examples

Description is a high-level description what is the purpose of the command.Syntax gives an example or examples of how the syntax of the command works, possibly with parameter lists for more complicated commands.Related commands lists commands that are closely tied to the command along with hyperlinks for quick inspection.Source gives links to where the information for the command was extracted, typically from the in-game Wiki, BCT Dev or Main thread. Case examples try to illustrate different scenarios where the user may wish to use the said command and what was the outcome.


Basic public commands[edit | edit source]

BUY[edit | edit source]

> Description: BUY is one of the main commands in Agora market. Mainly it is used for either directly buying items, placing buy offers, or to buy lots (and the corresponding buildings) directly.

- Syntax: "BUY item_id max_quantity max_price"

# Related commands: SELL, CANCELBUY, CANCELALL

§ Source:

+ (Sep 7th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12350057#msg12350057

+ (Aug 29th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12272523#msg12272523

* Case examples:

+ "BUY BEER 50 5025" would indicate that the user wishes to buy 50 units of BEER for the price of 5025 M per each. If there is an exact sell order for quantity more than 50 units of price equal or smaller to 5025, the BUY-command will try to match the best available bid; for example, in this case there was a sell order for BEER of 500 units at 5000 M per each, and the above command resulted in: "Bought 50 units of beer at 5000 m/unit, for a total of 250000m.". If there are no buy orders available for the desired price, the BUY-command will instead place a buy offer that will be displayed correspondingly in the "BUY ORDERS"-tab in the corresponding item (in this case "BEER").

+ "BUY" is also used for buying lots/buildings; for example "BUY 2-W-L7 1 32mil" bought the small 100 sqm lot with a 20 sqm house at New City for 32mil. The amount 1 indicates that a single lot is being bought, and is redundant in this respect.

CANCELALL[edit | edit source]

> Description: CANCELALL cancels all the current buy and sell offers for a particular item of the currently active character. It differs from CANCELSELL and CANCELBUY in the sense that these latter two can be used to only cancel either sell or buy offers, respectively.

- Syntax: "CANCELALL item_id"

# Related commands: SELL, BUY, CANCELSELL, CANCELBUY

§ Source: + (Sep 15th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12430503#msg12430503

+ (Sep 14th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12418992#msg12418992

* Case examples: + "CANCELALL BEER" would cancel both all the active sell and buy offers of the currently active character for the item BEER.

CANCELBUY[edit | edit source]

CANCELBID[edit | edit source]

> Description: CANCELBUY and CANCELBID are both synonyms to cancel an existing buy offer for a particular item for the currently active character.

- Syntax: "CANCELBID item_id max_quantity max_price"

# Related commands: BUY, CANCELSELL, CANCELALL

§ Source:

+ (Sep 15th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12430503#msg12430503

+ (Sep 14th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12418992#msg12418992

+ (Sep 7th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12350057#msg12350057

+ (Aug 29th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12272523#msg12272523

* Case examples:

+ Suppose the currently active character has set a buy order for W1617W wine for 10 units for the price of 40,000 each using "BUY W1617W 10 40000", this could be cancelled by using the matching cancel command: "CANCELBUY W1617W 10 40000", which should return "Order removed." if successful.

CANCELSELL[edit | edit source]

CANCELASK[edit | edit source]

> Description: CANCELSELL and CANCELASK are both synonyms to cancel an existing sell offer for a particular item for the currently active character.

- Syntax: "CANCELASK item_id max_quantity min_price"

# Related commands: SELL, CANCELBUY, CANCELALL

§ Source:

+ (Sep 15th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12430503#msg12430503

+ (Sep 14th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12418992#msg12418992

+ (Sep 7th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12350057#msg12350057

+ (Aug 29th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12272523#msg12272523

* Case examples:

+ Suppose the active character has set a sell offer of 10 units of W1617W wine at price of 80,000 each using the command "SELL W1617W 10 80000". This specific order could be cancelled by matching it with "CANCELSELL W1617W 10 80000", which should yield a result "Order removed.".

CONSUME[edit | edit source]

> Description: The main purpose of the CONSUME command is to tackle the health challenge, or to otherwise chill out by e.g. consuming cigars just for kicks. Consumed items are destroyed, and the health challenge can be a difficult task to approach efficiently, so it is advisable to first research the Health Challenge (and the HEALTH command) before conducting too many CONSUME commands for this purpose.

- Syntax: "CONSUME item_id quantity"

# Related commands: HEALTH

§ Source: + (Sep 7th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12350057#msg12350057

+ (Aug 29th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12272523#msg12272523

* Case examples:

+ "CONSUME BEER 50" -> consumes 50 units of BEER, and produces a discretized health challenge related response such as: "The eating/drinking felt Effective. I feel the remaining health challenge to be Severe. I could still eat 50, drink 100 and use 200 units of wisdom this year." indicating a rather good response, although the character still has a severe challenge to tackle.

DUMP[edit | edit source]

> Description: A dutch-auction type sell-command for items, where the sales offer decreases in price hourly until a buy offer is met, offer is bought otherwise, or the final set price is reached.

- "DUMP item_id amount first_price last_price decrease_per_hour"

§ Source: + (Sep 22th, 2016) https://bitcointalk.org/index.php?topic=819073.msg16333052;topicseen#msg16333052

GIVE[edit | edit source]

> Description: The GIVE command is used to transfer ownership of an instance of an item to an another character. The command will automatically give the specified number of specified item from the currently active character to the recipient. Only the admin-level command "TRANSFER" can be used to give items from somebody else to an another.

- Syntax: "GIVE item_id quantity recipient"

# Related commands: TRANSFER

§ Source: "

+ (Sep 7th, 2015): https://bitcointalk.org/index.php?topic=1144860.msg12350057#msg12350057

+ (Aug 29th, 2015): https://bitcointalk.org/index.php?topic=1144860.msg12272523#msg12272523

* Case examples:

+ "GIVE BEER 3 Syksy" or identically "GIVE BEER 3 138" -> This would give three BEERs from the active character to me, Syksy. Skål!

+ "GIVE VOD 2 5" would give two instances of the VOD (vodka) from the active character to the "void", also known as "New (5)". This should be used with caution, as it basically indicates item destruction!

HEALTH[edit | edit source]

> Description: This command is used to give the current weekly health challenge status of the current character.

- Syntax: "HEALTH"

# Related commands: CONSUME

§ Source:

+ Health challenge basics by Roopatra: https://cryptokingdom.me/wiki/CryptoKingdomLive5673ba7fea1af2.47825717

+ Health challenge advanced by Roopatra: https://cryptokingdom.me/wiki/CryptoKingdomLive5673bac972feb7.72067948

+ (Dec 15th, 2015): https://bitcointalk.org/index.php?topic=819073.msg13255352;topicseen#msg13255352

+ (Nov 28th, 2015): https://bitcointalk.org/index.php?topic=819073.msg13090545;topicseen#msg13090545

+ (Nov 24th, 2015): https://bitcointalk.org/index.php?topic=819073.msg13056142#msg13056142

* Case examples:

+ "HEALTH" -> "You may still eat 100 units, drink 150 units and use 100 units of wisdom this year. Your remaining health challenge is Significant. Your overall health is Decent". This would indicate that the character may still eat food items for a total of 100 units this week, and similarly 150 units of drinks and 100 units of wisdom items. Typically a character will aim to get the remaining challenge to "None". The final sentence gives an overall view to the character's health, and after "Ailing" the character will eventually die, if a health hit is taken due to the challenge.

SELL[edit | edit source]

> Description:

- Syntax: "SELL item_id max_quantity min_price"

# Related commands: CONSUME, GIVE

§ Source:

+ (Sep 7th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12350057#msg12350057

+ (Aug 29th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12272523#msg12272523

* Case examples:

+ "SELL CR1610A 2 2mil" would attempt to sell 2 units of the coin CR1610A for 2 mil each. If a buy order exists for 2mil or more, it will directly sell to this order, otherwise it will set a sell order for 2 mil that will be available for purchase. + "SELL CAN 10 1000" would try to sell 1 unit of CAN for 1k. In this particular case, a buy order was set for a quantity higher than 10 for the price of 1003, and the sell order resulted in selling of 10 units of CAN for 1,003 per each. If a sufficient buy order would not have existed, a sell order would have instead been set for the particular quantity of CAN at 1,000 per each.

Advanced public commands[edit | edit source]

DIVIDEND[edit | edit source]

> Description: Dividends are typically used to give money to shareowners of a company, or to divide town's money to gold owners. It is however possible to also pay other items than moneretos (M) as the dividends; for example, the breweries could pay part of their annual production as beer for their shareowners.

- Syntax: "DIVIDEND recipient_item_id dividend_item_id quantity"

# Related commands: GIVE, TAX

§ Source:

+ (Oct 19th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12732046#msg12732046

* Case examples:

+ "DIVIDEND S-GBB M 200000" - this is a command that the Grizzly Bear Brewery would use to give out 200k moneretos to shareholders of its share (item ID "S-GBB"). Notice that each holder will receive 200k per single owned instance of S-GBB; there are 80 S-GBB in existence, thus running this command will cost the company 80*200000 = 16mil moneretos. A person currently owning 20 S-GBB would be given 20*200000=4mil moneretos from the character/company running this command. Output would show something in the lines of: "16000000 units of m is given to 8 players (138, 91, 130, 17, 120, 70, 111, 88)"

MOVE[edit | edit source]

> Description: The move command is used to move stone from a borough to an another borough. It has a cost, so the user may first wish to evaluate if it's better to buy stone for building locally, or to buy from an another borough and then move and pay the moving price. Due to the building module being under development, this command is currently not in wide use.

- Syntax: "MOVE source_borough_id destination_borough_id amount"

# Related commands:

§ Source:

+ (Sep 17th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12445295#msg12445295

+ (Sep 7th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12350057#msg12350057

+ (Aug 29th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12272523#msg12272523

* Case examples: + -


Admin commands[edit | edit source]

CREATE[edit | edit source]

> Description: CREATE is used to create new instances of an existing item. This item is referred to using its unique identification code, and each newly created instance will inherit all the attributes of the model prototype item (created typically using "NEW"-command).

- Syntax: "CREATE item_id quantity recipient"

# Related commands: NEW

§ Source:

+ (Oct 15th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12691702#msg12691702

* Case examples:

+ "CREATE S-GBB 80 GrizzlyBear" was used to create 80 items, in this case shares, of unique identification code "S-GBB" to the user with the shortname "GrizzlyBear". The source of the items is the "void", which is indicated by "New (5)".

+ "CREATE ART-31 1 94" was used to create a single instance of "ART-31" item for the Marquess of the White Cross, also known by the short name Noms. Notice that his character identification code (in this case 94) can also be used instead of the short name.

NEW[edit | edit source]

> Description: NEW is used to create a prototype of an item. Notice that this creates just a model framework of an item, and no actual items are yet created - these instances can be later created using the NEW-command.

- Syntax: "NEW item_id [other parameters may be given in the format "Year=1600 ..."]"

# Related commands: CREATE

+ Note: Following various fields are available as of November 26th, 2015: "year": Year of item creation, typically current game year at the time of item creation (years <1600 are considered ancient and should not be created without special permission)
"level": Level of the item <- is calculated from the price IC (and other parameters/attributes) [numeric attribute]
"name": User specified, the listing name [character string]
"itemType": it_type_code for sorting, mandatory [?]
"ckg": Amount of gold (ckg) contained [numeric attribute]
"cks": Amount of silver (cks) contained [numeric attribute]
"stone": Amount of stone contained [numeric attribute]
"desc": A long description of the item, mandatory [character string]
"history": Stories of the item, perhaps to add flavor and resale value, mandatory [character string]
"specialNote": If the item has encumbrance or other important info [character string]
"adminNotes": reserved [character string]
"material": code (for lookup), mandatory [?]
"colCode": color code (for lookup), mandatory [?]
"repair": Item condition, always start at 1 (100%) [numeric attribute]
+ Note: Following fields are mostly considered "Attributes" and take value of 0...3, where 1=Attribute, 2=Most Attribute, 3=Very Attribute (upping by 1 typically doubles the price):
"ancient": always 0
"elaborate":
"powerful":
"imported": [0/1]
"cultural":
"scientific":
"historical": Currently not in use
"royal": Reserved for King only
"noble": Reserved for admin / nobility only
"blessed": Reserved for church only
"cursed": Reserved for church only
"legendary": General population only (?) [0/1]
"untradable": Will appear in listing but cannot place bids/asks (currently does not work), example: "CUL" [0/1]
+ Note: Not all the item characteristics are fixed at item creation, and they may be adjusted from the admin panel after the "NEW" command. The itemID of a newly created item has to unique, otherwise an error is given.

§ Source:

+ (Oct 15th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12691702#msg12691702

+ (Nov 26th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg13072154#msg13072154

* Case examples:

+ "NEW ART-31[level=7,year=1618,name=Construction_of_the_Phaeton_Carriage_Works,itemType=ART,repair=100]" was used to create a model prototype for the unique art painting ART-31 for Marquess of the White Cross. Later, additional description and note fields were added to the model prototype, which would've been cumbersome to add directly in the NEW-command.

MERGE[edit | edit source]

> Description: As per its description at the source, "the command is used to scale down the number of instances of an item proportionately for all owners". It is not yet in wide use.

- Syntax: "MERGE item_id percentage_remaining"

# Related commands:

§ Source: + (Nov 26th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg13072050#msg13072050

* Case examples: + -

PROMOTE[edit | edit source]

> Description: The promote command currently is mostly used to promote the statuses of NPC characters with a typical chance of 5% for a change. The command is looped through all instances of item_id, and if a positive occurrence happens, then an instance of item_id is sent to New #5 and a new item of promoted_to is created in its place. Each instance of item_id has an independent chance (basicly a d100 roll) of getting the indicated promotion.

- Syntax: "PROMOTE item_id percentage_promoted promoted_to"

# Related commands:

§ Source: + (Nov 26th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg13072050#msg13072050

* Case examples: + "PROMOTE CHEF-2 5 CHEF-3" -> a 5% chance for each CHEF-2 to be promoted to the next level chef (3).

SPOIL[edit | edit source]

> Description: This command is used to spoil/destroy items with a random d100 roll determined to use whether a single instance is destroyed. Such items could be for example food and consumables, for example VEG (vegetables). A spoil run for VEG with 33% chance would approximately destroy one third of all the existing instances of VEG in the whole CK.

- Syntax: "SPOIL item_id_or_item_type_id percentage_spoiled"

# Related commands: CONSUME

§ Source: + (Nov 26th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg13072050#msg13072050

* Case examples: + "SPOIL VEG 33" -> one third of vegetable crops destroyed.

TAX[edit | edit source]

> Description: "TAX" is typically used for land taxing or as import tax for exotic wines and tobacco. Notice that this command may cause a character's balance to go negative. The tax is done in moneretos (M).

- Syntax: "TAX taxed_item_id amount recipient"

# Related commands: DIVIDEND

§ Source: + (Nov 14th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12975763#msg12975763

+ (Dec 29th, 2015) https://cryptokingdom.me/wiki/CryptoKingdom5612d7424456e1.02850315

* Case examples:

+ A recent wine import was taxed using "TAX W1616 10000 Town", resulting in 10k tax per each owned unit of W1616.

TRANSFER[edit | edit source]

> Description: The "TRANSFER" command is the equivalent of "GIVE", but it requires admin powers in order to be conducted. Furthermore, while GIVE always gives items from the the person running the "GIVE" command, "TRANSFER" can be used to transfer items between two people other than the person running the command.

- Syntax: "TRANSFER item_id quantity giver recipient"

# Related commands: GIVE

§ Source: + (Sep 7th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12350057#msg12350057

+ (Aug 29th, 2015) https://bitcointalk.org/index.php?topic=1144860.msg12272523#msg12272523

* Case examples:

+ For example, the hungryMob-character simulates 1,000 NPCs trying to live their life in CryptoKingdom, and they are given annual budget in order to obtain certain goods such as BEER, MEAT, WINEs and such. A command for giving the money is for example: "TRANSFER M 750mil Town hungryMob" -> "750000000 units of M transferred to hungryMob." (Later note: This annual consumption has been adjusted to 700mil.)


Non-accessible commands[edit | edit source]

HEALTH_CHALLENGE_EVALUATOR[edit | edit source]

Description: TBA, inaccessible underlying command

MATCHBID[edit | edit source]

Description: TBA, inaccessible underlying command

MATCHASK[edit | edit source]

Description: TBA, inaccessible underlying command