Commands

ashita

Command Syntax

Commands implemented within Ashita all follow the below format for their arguments. This helps keep usage unified across all commands. It also makes documentation easier to follow when all commands make use of the same format.

SyntaxDescription
textRequired; entered as shown.
<text>Required argument.
<text...>Required argument. (Multiple arguments accepted.)
(text|text)Required, one of.
[text]Optional argument.
[text...]Optional argument. (Multiple arguments accepted.)

Note: Arguments surrounded with < and > are considered positional, meaning their order matters.

Command: /about

  • /about
    • Toggles displaying the Ashita about/credits information.

Command: /ashita

  • /ashita
    • Toggles displaying the Ashita sidebar.

Command: /aver, /aversion, /ashitaversion

  • /aver
  • /aversion
  • /ashitaversion
    • Prints the current Ashita version information to the chat window.

Category: General

Command: /paste

  • /paste
    • Pastes the current clipboard text to the chat input.

Command: /exit, /terminate

  • /exit
  • /terminate
    • Closes the game client, by force._

This does not gracefully close the game client, it is shut down by force. Settings may be lost while using these commands!

Category: Scripts

Command: /exec

  • /exec <name> [args...]
    • Executes the given script file.

Command: /execstr

  • /execstr <string> [args...]
    • Executes the given script string.

Command: /pause, /sleep, /wait

  • /pause [delay]
  • /sleep [delay]
  • /wait [delay]
    • Suspends a script for an amount of time. (Default is 1 second if no delay is given.)

This command is not intended to be used outside of scripts! It will freeze the game client if you use it elsewhere.

Category: Plugins

Command: /plugins

  • /plugins info <name>
    • Displays detailed information about a given loaded plugin.
  • /plugins link <name>
    • Opens the given plugins link in the systems default browser.
  • /plugins list
    • Opens a UI window displaying a list of plugins. (Not yet implemented.)
  • /plugins silent [0 | 1]
    • Toggles, or sets, if plugin commands should print messages to the chat window.

Command: /load

  • /load <name> [args...]
    • Loads the given plugin.

Command: /unload

  • /unload <name>
    • Unloads the given plugin.

Command: /unloadall

  • /unloadall
    • Unloads all currently loaded plugins.

Command: /list

  • /list
    • Lists all loaded plugins.

Category: Alias & Binds

Command: /alias

  • /alias add <trigger> <command>
  • /alias <trigger> <command>
    • Adds an alias with the given trigger.
  • /alias clear
    • Clears the list of registered aliases.
  • /alias (del | delete) <trigger>
    • Deletes an alias.
  • /alias list
    • Lists the current registered aliases.

Command: /bind

  • /bind block [0 | 1]
    • Toggles, or sets, blocking keybinds while game input is open.
  • /bind list
    • Lists the current registered keybinds.
  • /bind silent [0 | 1]
    • Toggles, or sets, if keybind commands should output messages to the chat window.
  • /bind [!^@#+]<key> [down | up] <command>
    • Binds a key combination to the given command.

Keybinds make use of the !^@#+ characters as modifiers. These characters represent:

  • ! - Modifier symbol for the ALT key.
  • # - Modifier symbol for the APPS key.
  • ^ - Modifier symbol for the CTRL key.
  • + - Modifier symbol for the SHIFT key.
  • @ - Modifier symbol for the WIN key.

Command: /unbind

  • /unbind all
    • Unbinds all registered keybinds.
  • /unbind [!^@#+]<key> [down | up]
    • Unbinds a key combination.

Category: Input Devices

Command: /controller, /gamepad

  • /controller (allowbackground | allowbg | bg) [0 | 1]
  • /gamepad (allowbackground | allowbg | bg) [0 | 1]
    • Toggles, or sets, if the gamepad should be accessible while the game is not in focus.
  • /controller disable [0 | 1]
  • /gamepad disable [0 | 1]
    • Toggles, or sets, if the gamepad should be ignored/disabled.

If you do not use a control while playing, it is recommended to fully disable the gamepad to fix a potential micro-stutter the game will have.
You can use the /gamepad disable command to fix this problem.

Command: /keyboard

  • /keyboard winkey [0 | 1]
    • Toggles, or sets, if the Windows key is enabled.

Command: /mouse

  • /mouse block [0 | 1]
    • Toggles, or sets, if the mouse should be blocked from sending input to the game.
  • /mouse unhook [0 | 1]
    • Toggles, or sets, if the mouse should be unhooked from window snapping.

Category: Direct3D

Command: /ambient

  • /ambient
    • Toggles the ambient lighting feature.
  • /ambient [0 | 1]
    • Sets, or toggles, the ambient lighting feature off or on.
  • /ambient <r> <g> <b>
    • Sets the ambient lighting color.

Command: /fillmode

  • /fillmode
    • Toggles the fillmode setting between solid and wireframe.
  • /fillmode [value]
    • Sets the fillmode to the given value.

Valid fill mode values are:

  • 1 - Point
  • 2 - Wireframe
  • 3 - Solid

Category: Addons

These commands require the Addons plugin to be loaded in order for them to work!

Command: /addon

  • /addon silent [0 | 1]
    • Toggles, or sets, if addon commands should print messages to the chat window.
  • /addon load <name>
    • Loads the given addon.
  • /addon unload <name>
    • Unloads the given addon.
  • /addon unloadall
    • Unloads all currently loaded addons.
  • /addon kill <name>
    • Kills the given addon.
  • /addon reload <name>
    • Reloads the given addon.
  • /addon exec <name> <str>
    • Executes a string of Lua code within the given addons state.
  • /addon list
    • Lists all loaded addons.
  • /addon info <name>
    • Displays detailed information about a given loaded addon.
  • /addon link <name>
    • Opens the given addons link in the systems default browser.