Skip to content
This repository has been archived by the owner on Jan 19, 2019. It is now read-only.

Latest commit

 

History

History
173 lines (154 loc) · 6.79 KB

README.md

File metadata and controls

173 lines (154 loc) · 6.79 KB
Raw

Realm Script

An AHK script for Realm of the Mad God, enhancing gameplay with hotkeys for useful text and click macros.

Download and Setup

There are currently two options for using realmscript: running the source script or using a compiled .exe of the script. Running the script from source (recommended!) will allow greater flexibility and full access to realmscript's features, where using the compiled .exe is a faster and easier way to get started and does not require you to install AutoHotKey, but does not support most customization features!

Running from source:

  • Download the project's files here.
  • Extract the archive to a folder of your choice
  • Install Autohotkey for Windows
  • Open options.ahk and hotkeys.ahk using your preferred text editor
    (Windows users, I recommend using Notepad++ or another editor which supports linux-style line endings)
  • Choose your default settings in options.ahk and add, delete, or edit binds as needed in hotkeys.ahk
  • Run realmscript.ahk to initiate the script

Running the compiled .exe:

  • Visit the releases page and download the latest compiled script's archive
  • Extract the archive to a folder of your choice
  • Run the included .exe

Default Binds

  • ` : /pause
  • F1 : Heal please?
  • F2 : Thank you!
  • F3 : MP please?
  • F4 : He lives and reigns and conquers the world
  • F11 : /tutorial
  • F12 : /nexustutorial
  • /tp ... : Automatically expands to /teleport ...
  • ctrl + 1 : Double-click inventory slot 1
  • ctrl + 2 : Double-click inventory slot 2
  • ctrl + q : Disabled to avoid accidental tab or window closure.
  • ctrl + e : Disabled to avoid accidental tab or window closure.
  • ctrl + f : Interact functionality (clicks on Enter or Change for entering a portal or changing characters)
  • ctrl + w : /who
  • ctrl + s : /server
  • ctrl + d : /tell mreyeball server
  • right-click : shift + left-click (identical to using ability or drinking potion)
  • ctrl + right-click : Literal right-click (brings up Flash right-click menu, for instance)
  • ctrl + t : Dialog box to set a teleport anchor (person to teleport to using /teleport ...)
  • shift + right-click : Teleport to set anchor (from ctrl+t)
  • shift + scroll-wheel-up : Page Up (for scrolling chat up)
  • shift + scroll-wheel-down : Page Down (for scrolling chat down)
  • Esc : Close the package advertisement modal window that appears on login

Features

  • Right click sends shift+left click and resends left click if it was set when right clicking
  • Ctrl+right click sends right click
  • Ctrl+t, then shift+right click sets and teleports to anchor
  • Several text send hotkeys
  • Pause hotkey
  • Tutorial and nexustutorial hotkeys
  • Swap hotkeys (allows for slot selecting via bind editing)
  • Shift+scroll wheel scrolls chat log
  • /tp is converted to /teleport
  • Resizable borders can be disabled for projector or Steam client players
  • Ctrl+f acts as a fixed interact key for portals and character select
  • Ctrl+1 and Ctrl+2 act as item-swap binds.
  • Ctrl+q and Ctrl+e are disabled to avoid accidental presses.

Frequently Asked Questions

I don't like one of the default binds. How do I get rid of it?
Within hotkeys.ahk, search for the key pressed for the hotkey (for example, F12) and remove the lines from the beginning of the definition (eg. F12::) until the next line that reads Return.
How many hotkeys can I add?
As many as you'd like. Keep in mind that creating hotkeys without modifier keys (ctrl, alt, shift) may cause unintended effects for keys that are used otherwise.
How can I edit my settings or hotkeys using the .exe?
Sadly, you can't. This is one of the notable limitations, because compiled scripts will incorporate the code of #included files rather than continue to obey normal #include commands, thus it can't be configured using options.ahk and hotkeys.ahk like the source script can.
Can I change the cursor used for the .exe version?
You can replace the bmj_precision.cur file that is generated with a cursor of your choice after the script has begun running. You may also delete it entirely, though that will cause an error message to appear each time your game comes into focus.

Troubleshooting

This section will cover some common issues but will, of course, not be fully comprehensive of all possible issues which can occur with this script.
If you encounter an issue which is not covered below, please submit it to this repository's issue tracker and I'd be more than happy to help resolve the problem.

I get an error reading #Include file "includes/SetSystemCursor.ahk" cannot be opened.
Since July 20, 2013 (commit 2b7fcb3), this script has included a small library to reliably set the system cursor. Please make sure you are using the latest version of this script.
I get an error reading Error: Invalid file path or cursor name
The cursors provided with this script reside in the "/img/cursors" directory - if they are not present, trying to use them for your custom cursor will cause this error. Make sure that they have been downloaded at that path, or ensure your cursor path is correct.
I get an error containing This line does not contain a recognized action.
You are running an old version of AutoHotKey. Visit the download and setup section for a link to download and install the latest version of AutoHotKey.

Personal Thanks

I'd like to extend a big personal thanks to a couple people who made this project possible.

I'd like to thank NGJMoses for his helping hand in testing, Kalle for creating the original realmscript, BMJ for his contributions to that with stuff from QuickSpeech and TKGP for the item swap.