Cheat Commands¶

Overview¶

Client API development servers provide access to a variety of cheat commands.

These allow developers to set up their in-game character for plugin testing purposes.

Commands must be entered into the client console window, which can be opened by pressing the follow key combinations:

Command List¶

Config names used in cheat commands are case-insensitive, so all of these will work:

!give Logs
!give logs
!give LOGS

tele¶

Teleports the player character to a given coordinate or named location.

Teleport to the bank at the top of Lumbridge Castle with either:

!tele 2,50,50,8,19
!tele 2_50_50_8_19

Mapsquare shorthard coordinates are also valid.
Teleport to the centre of mapsquare 50,50 with either:

!tele 0,50,50
!tele 0_50_50

Teleport to the Grand Exchange in Varrock with a named teleport destination:

!tele grandexchange

getcoord¶

Returns the current coordinate of the player character.

Useful to quickly discover tile positions for stationary NPCs, etc.

While standing at the Lumbridge Market:

!getcoord
0,50,50,9,56

!getcoord
0,104,1,40,56
Region source: 0,1,78,48,40

give¶

Adds the named item(s) to a player character's inventory.
Stops when the inventory is full.

The name of the item matches the ObjType and InvType config names, such as:

config.Obj.LOGS
config.Inv.BANK

!give logs
!give coins 200000000 bank

objadd¶

Adds the named item(s) on the ground coordinate at the feet of the player character.

The name of the item matches the ObjType config name, such as:

config.Obj.LOGS
config.Obj.YELLOW_PARTYHAT

!objadd logs
!objadd bronze_arrowheads 20

listinv¶

Prints out the contents of an inventory to the console. Will also print the values of any VarObj variables assigned to each entry in the inventory.

!listinv bank

listlocs¶

Prints out a list of every LocEntity within radius tiles of the player character to the console.

The maximum value of radius is 32.

!listlocs 32

listnpcs¶

Prints out a list of every NPCEntity within radius tiles of the player character to the console.

The maximum value of radius is 32.

!listnpcs 32

listobjs¶

Prints out a list of every ObjType within radius tiles of the player character to the console.

The maximum value of radius is 32.

Filter for a specific ObjType by sending its config name, or send null to return all objects.

!listobjs 32 logs

skillsetlevel¶

Sets the level of the given SkillType to the given level number.

!skillsetlevel attack 98
!skilladdlevel attack 1

!skillsetlevel attack 99

skilladdlevel¶

Adds levels to the given SkillType.

!skilladdlevel magic 3

skillsetxp¶

Sets the XP of the given SkillType to the given XP number.

!skillsetxp attack 4400
!skilladdxp attack 100

!skillsetxp herblore 104273167

skilladdxp¶

Adds XP to the given SkillType.

!skilladdxp dungeoneering 1000

getvar¶

Returns the value of the given VarType.
The variable type must be VarPlayer or a VarBit based on one.

!getvar combatv2_armour_rating

setvar¶

Sets the value of the given VarType.
The variable type must be VarPlayer or a VarBit based on one.

Valid value types can be, depending the variable data type, Integer, Long or String.

!setvar barrows_killed_dharok 1

getvarc¶

Returns the value of the given VarType.

!getvarc tooltip_time

setvarc¶

Sets the value of the given VarType.
The variable type must be VarClient.

Valid value types can be, depending the variable data type, Integer, Long or String.

!setvarc castlewars_red_kills 100

resetsave¶

Flags the player character's account to be reset when they next log out of the server.

This can be aborted by calling !unresetsave before logging out.

!resetsave

unresetsave¶

Aborts any pending player character's account reset flag.

!unresetsave

godmode¶

Enables or disables combat invulnerability for the player character.

!godmode

maxhp¶

Enables or disables whether the health of the player is continually set to its maximum value.

!maxhp

hitall¶

All NPCs with 50 tiles of the player character are dealt 5000 damage.

!hitall

allinone¶

Sets all necessary variables to flag quests, tasks, and so on, as having been completed, and sets all skills to their maximum level.

!allinone

bank¶

Opens the bank interface, without the player having to interact with a bank chest or banker NPC.

!bank

clearworn¶

Wipes the worn inventory of all items.
This is the inventory that stores all currently equipped items.

!clearworn

clearinv¶

Wipes the inv inventory of all items.
This is the backpack inventory.

!clearinv

coordsave¶

Records the player character's current coordinate so it can be teleported to later using the coordtele cheat command.

!coordsave

coordtele¶

Resets the player character's current coordinate to the one stored after using the coordsave cheat command.

!coordtele

setgroupironman¶

Assigns the given state to the player character's group-ironman game status.

Valid values of state are:

• 0 = disabled
• 1 = enabled

!setgroupironman 1

sethardcore¶

Assigns the given state to the player character's hardcore game status.

Valid values of state are:

• 0 = disabled
• 1 = enabled

!sethardcore 1

setironman¶

Assigns the given state to the player character's ironman game status.

Valid values of state are:

• 0 = disabled
• 1 = enabled

!setironman 1

archcompletetutorial¶

Progresses all necessary variables to complete the Archaeology tutorial and provides the relevant items obtained during it.

!archcompletetutorial

archgivemats¶

Adds count of every Archaeology material type to inv.

!archgivemats 500 bank

inventgivemats¶

Sets the necessary variables to provide the player character with the maximum possible amount of all types of Invention material.

!inventgivemats

inventwipemats¶

Sets the necessary variables to remove all types of Invention material from the player character.

!inventwipemats

inventmachinerun¶

Causes constructed Invention machines to be progressed by 1 hour of in-game time.

!inventmachinerun

inventsetperks¶

Updates a valid augmentable object in the player character's inv inventory at the given inventory_slot number.

Valid gizmo_slot values are 1 and 2

Each gizmo can have two perks.
Valid perk_id_# values, and their valid perk_rank_# ranges, can be found in the Invention Perk IDs list.

!inventsetperks 0 7 1 44 2 1

tlihide¶

Hides all top-level interface windows.
Useful for taking screenshots.

!tlihide

tlishow¶

Unhides all top-level interface windows.

!tlishow

pouchadd¶

Adds count of the given currency_id type to the player character's currency pouch.

Valid currency_id values can be found in the Currency IDs list.

Valid values of ignore_overflow are:

• 0 = disabled
• 1 = enabled

If the new total currency would overflow that currency's maximum limit then: If ignore_overflow is:

• ignore_overflow = 1 - The total currency is clamped to the maximmum limit
• ignore_overflow = 0 - No currency is added

!pouchadd 44 100000 1

pouchdel¶

Removes count of the given currency_id type from the player character's currency pouch.

Valid currency_id values can be found in the Currency IDs list.

If the new total currency would be less than 0 then no currency is removed.

!pouchdel 9 12345

pouchdeposit¶

Transfers all of the given currency_id type from the given Inventory inv to the player character's currency pouch.

Valid currency_id values can be found in the Currency IDs list.

!pouchdeposit 11 inv

pouchwithdraw¶

Transfers the given currency_id type from the player's currency pouch into the player character's backpack Inventory inv.
A prompt will be shown to ask how much currency should be moved.

Valid currency_id values can be found in the Currency IDs list.

!pouchwithdraw 11

pouchspace¶

Calculates how much additional currency of type currency_id can be added to the player character's currency pouch.

Valid currency_id values can be found in the Currency IDs list.

!pouchspace 44

pouchtotal¶

Calculates how much currency of type currency_id is in the player character's currency pouch.

Valid currency_id values can be found in the Currency IDs list.

!pouchtotal 44

testpouchadd¶

Performs a test to see whether count of currency_id can fit in the player character's currency pouch.
If the test is successful, count is added. If the test is unsuccessful, nothing is added.

Valid currency_id values can be found in the Currency IDs list.

!testpouchadd 44 100000

testpouchdel¶

Performs a test to see whether count of currency_id can be removed from the player character's currency pouch.
If the test is successful, count is removed. If the test is unsuccessful, nothing is removed.

Valid currency_id values can be found in the Currency IDs list.

!testpouchdel 9 12345

Useful named teleports¶

Here is a list of useful named teleports.
These can be used with the !tele cheat command.

Useful inventory names¶

Here is a list of useful named inventories.
These can be used with the !give and !listinv cheat commands.

Invention Perk IDs¶

Here is a list of available Invention perk IDs.
Use these with the following cheat command:

• inventsetperks

Currency IDs¶

Here is a list of available currency IDs.
Use these with the following cheat commands:

• pouchadd
• pouchdel
• pouchdeposit
• pouchwithdraw
• pouchspace
• pouchtotal
• testpouchadd
• testpouchdel