Skip to content

Write your own custom, context-aware FFXIV chat commands in lua!

License

Notifications You must be signed in to change notification settings

PrincessRTFM/WoLua

Repository files navigation

WoLua

Warrior of... Lua?

GitHub build status GitHub tag (latest by date) GitHub last commit (branch) GitHub issues

Support me!

About

License

WoLua is a plugin that allows users (like you!) to write custom, context-aware chat commands in lua. These commands can read information from the game through WoLua's API, and are able to do things like printing messages to your local chatlog, send chat (commands and plain text) to the server, and more.

Installation

Type /xlplugins in-game to access the plugin installer and updater. Note that you will need to add my custom plugin repository (full instructions included at that link) in order to find this plugin.

In-game usage

  • Type /wolua to pull up a GUI with basic instructions and the configuration options.
  • Type /wolua reload to rescan all command scripts while playing, in case you add, edit, or remove anything.
  • Type /wolua list to list all loaded command scripts.
  • Type /wolua call <script> [<optional arguments...>] to actually run a command script. Any additional text will be passed to the script for its own use.

Writing scripts

Since WoLua exposes a significant amount of game information (not to mention the interface for doing things) to scripts, the documentation is too extensive for the basic readme page. You can find details on the dedicated API docs instead.

About

Write your own custom, context-aware FFXIV chat commands in lua!

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages