[XP][VX] Key Simulator

[Fantasist]

Key Simulator
Authors: Fantasist
Version: 0.1
Type: Low-level Functionality Addon
Key Term: Game Utility

Introduction

This script can simulate the pressing of the keyboard and mouse keys. You can use this, for example, to switch to fullscreen by simulating the ALT and ENTER keys.
Features

• Simulates the most common keyboard and mouse keys.
• More of a development tool than a script.

Screenshots

n/a
Demo

Place this piece of code just below this script and you're game goes fullscreen on start. If you still want a demo, I'll put it up, but remember, respect my laziness

(click to show/hide)

Code:

VK.down(VK::ALT) # ALT down
VK.down(VK::ENTER) # ENTER down
VK.up(VK::ENTER) # ENTER up
VK.up(VK::ALT) # ALT up

Script

Place it in the very first slot. If you don't like that, you can paste this virtually anywhere before main.

(click to show/hide)

Code:

#==============================================================================
# ** Key Simulator
#------------------------------------------------------------------------------
# by Fantasist
# Version: 0.1
# Date: 11-Dec-2008
#------------------------------------------------------------------------------
# Version History:
#
#   0.1 - First version
#------------------------------------------------------------------------------
# Description:
#
#     This script can simulate the pressing of the keyboard and mouse keys.
#   You can use this, for example, to switch to fullscreen by simulating the
#   ALT and ENTER keys.
#------------------------------------------------------------------------------
# Compatibility:
#
#     Should be compatible with almost everything.
#     Might not be compatible with similar scripts.
#------------------------------------------------------------------------------
# Instructions:
#
#     This script can simulate most of the common keyboard and mouse presses.
#   You can simulate three things: "key down" (press), "key up" (release) and
#   "trigger key" (press and release)
#
#   Syntax:
#             VK.down(VIRTUAL_KEY)
#             VK.up(VIRTUAL_KEY)
#             VK.trigger(VIRTUAL_KEY)
#
#   where VIRTUAL_KEY is the constant representing the required key.
#   For the exact name of the constant, scroll down and find the required key.
#
#   Number keys work a little different. For the number n, VIRTUAL_KEY is:#
#              NUM[n]
#   So 2, 6 and 0 are NUM[2], NUM[6], NUM[0] respectively.
#   Note that this is only the case with the number keys above the letter keys.
#   Numpad keys have individual constants. Numpad 4 is NUMPAD4
#
#   Example: Simulating "Alt + Enter"
#
#     Scroll down to find the constants for alt and enter keys. They are ALT
#   and ENTER respectively. Now, we need to simulate "alt down", "enter down",
#   "enter up", "alt up". The following code does that:
#
#             VK.down(VK::ALT) # ALT down
#             VK.down(VK::ENTER) # ENTER down
#             VK.up(VK::ENTER) # ENTER up
#             VK.up(VK::ALT) # ALT up
#
#------------------------------------------------------------------------------
# Issues:
#
#     I have very limited experience in this area, so I don't know what some
#   keys are (for example the OEM keys and such). The constants here are used
#   directly from the microsoft MSDN page regarding virtual keys.
#------------------------------------------------------------------------------
# Credits and Thanks:
#
#   Credits: Fantasist for making this.
#   Thanks: Memor-X for requesting this.
#------------------------------------------------------------------------------
# Notes:
#
#     If you have any questions, suggestions or comments, you can
#   find me (Fantasist) at:
#
#    - www.chaos-project.com
#    - www.quantumcore.forumotion.com
#
#   Enjoy ^_^
#==============================================================================

#==============================================================================
# ** module VK (Virtual Keys)
#==============================================================================

module VK
 
  V_KEYBD = Win32API.new 'user32.dll', 'keybd_event', ['i', 'i', 'l', 'l'], 'v'
 
  def self.down(vk)
    V_KEYBD.call(vk, 0, 0, 0)
  end
 
  def self.up(vk)
    V_KEYBD.call(vk, 0, 2, 0)
  end
 
  def self.trigger(vk)
    V_KEYBD.call(vk, 0, 0, 0)
    V_KEYBD.call(vk, 0, 2, 0)
  end
 
  LBUTTON = 0x01 # Left mouse button
  RBUTTON = 0x02 # Right mouse button
  CANCEL = 0X03 # Control-break processing
  MBUTTON = 0x04 # Middle mouse button (Three-button mouse)
  XBUTTON1 = 0x05 # Windows 2000/XP: X1 mouse button
  XBUTTON2 = 0x06 # Windows 2000/XP: X2 mouse button
  BACK = 0x08 # BACKSPACE key
  TAB = 0x09 # TAB key
  CLEAR = 0x0C # CLEAR key
  ENTER = 0x0D # ENTER key
  SHIFT = 0x10 # SHIFT key
  CONTROL = 0x11 # CTRL key
  ALT = 0x12 # ALT key
  PAUSE = 0x13 # PAUSE key
  CAPITAL = 0x14 # CAPS LOCK key
  ESCAPE = 0x1B # ESC key
  SPACE = 0x20 # SPACEBAR
  PRIOR = 0x21 # PAGE UP key
  NEXT = 0x22 # PAGE DOWN key
  END_ = 0x23 # END key
  HOME = 0x24 # HOME key
  LEFT = 0x25 # LEFT ARROW key
  UP = 0x26 # UP ARROW key
  RIGHT = 0x27 # RIGHT ARROW key
  DOWN = 0x28 # DOWN ARROW key
  SELECT = 0x29 # SELECT key
  PRINT = 0x2A # PRINT key
  EXECUTE = 0x2B # EXECUTE key
  SNAPSHOT = 0x2C # PRINT SCREEN key
  INSERT = 0x2D # INS key
  DELETE = 0x2E # DEL key
  HELP = 0x2F # HELP key
  NUM = [0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39]
  A = 0x41 # A key
  B = 0x42 # B key
  C = 0x43 # C key
  D = 0x44 # D key
  E = 0x45 # E key
  F = 0x46 # F key
  G = 0x47 # G key
  H = 0x48 # H key
  I = 0x49 # I key
  J = 0x4A # J key
  K = 0x4B # K key
  L = 0x4C # L key
  M = 0x4D # M key
  N = 0x4E # N key
  O = 0x4F # O key
  P = 0x50 # P key
  Q = 0x51 # Q key
  R = 0x52 # R key
  S = 0x53 # S key
  T = 0x54 # T key
  U = 0x55 # U key
  V = 0x56 # V key
  W = 0x57 # W key
  X = 0x58 # X key
  Y = 0x59 # Y key
  Z = 0x5A # Z key
  LWIN = 0x5B # Left Windows key (Microsoft Natural keyboard)
  RWIN = 0x5C # Right Windows key (Natural keyboard)
  APPS = 0x5D # Applications key (Natural keyboard)
  SLEEP = 0x5F # Computer Sleep key
  NUMPAD0 = 0x60 # Numeric keypad 0 key
  NUMPAD1 = 0x61 # Numeric keypad 1 key
  NUMPAD2 = 0x62 # Numeric keypad 2 key
  NUMPAD3 = 0x63 # Numeric keypad 3 key
  NUMPAD4 = 0x64 # Numeric keypad 4 key
  NUMPAD5 = 0x65 # Numeric keypad 5 key
  NUMPAD6 = 0x66 # Numeric keypad 6 key
  NUMPAD7 = 0x67 # Numeric keypad 7 key
  NUMPAD8 = 0x68 # Numeric keypad 8 key
  NUMPAD9 = 0x69 # Numeric keypad 9 key
  MULTIPLY = 0x6A # Multiply key
  ADD = 0x6B # Add key
  SEPARATOR = 0x6C # Separator key
  SUBTRACT = 0x6D # Subtract key
  DECIMAL = 0x6E # Decimal key
  DIVIDE = 0x6F # Divide key
  F1 = 0x70 # F1 key
  F2 = 0x71 # F2 key
  F3 = 0x72 # F3 key
  F4 = 0x73 # F4 key
  F5 = 0x74 # F5 key
  F6 = 0x75 # F6 key
  F7 = 0x76 # F7 key
  F8 = 0x77 # F8 key
  F9 = 0x78 # F9 key
  F10 = 0x79 # F10 key
  F11 = 0x7A # F11 key
  F12 = 0x7B # F12 key
  F13 = 0x7C # F13 key
  F14 = 0x7D # F14 key
  F15 = 0x7E # F15 key
  F16 = 0x7F # F16 key
  NUMLOCK = 0x90 # NUM LOCK key
  SCROLL = 0x91 # SCROLL LOCK key
  LSHIFT = 0xA0 # Left SHIFT key
  RSHIFT = 0xA1 # Right SHIFT key
  LCONTROL = 0xA2 # Left CONTROL key
  RCONTROL = 0xA3 # Right CONTROL key
  LMENU = 0xA4 # Left MENU key
  RMENU = 0xA5 # Right MENU key
  BROWSER_BACK = 0xA6 # Windows 2000/XP: Browser Back key
  BROWSER_FORWARD = 0xA7 # Windows 2000/XP: Browser Forward key
  BROWSER_REFRESH = 0xA8 # Windows 2000/XP: Browser Refresh key
  BROWSER_STOP = 0xA9 # Windows 2000/XP: Browser Stop key
  BROWSER_SEARCH = 0xAA # Windows 2000/XP: Browser Search key
  BROWSER_FAVORITES = 0xAB # Windows 2000/XP: Browser Favorites key
  BROWSER_HOME = 0xAC # Windows 2000/XP: Browser Start and Home key
  VOLUME_MUTE = 0xAD # Windows 2000/XP: Volume Mute key
  VOLUME_DOWN = 0xAE # Windows 2000/XP: Volume Down key
  VOLUME_UP = 0xAF # Windows 2000/XP: Volume Up key
  MEDIA_NEXT_TRACK = 0xB0 # Windows 2000/XP: Next Track key
  MEDIA_PREV_TRACK = 0xB1 # Windows 2000/XP: Previous Track key
  MEDIA_STOP = 0xB2 # Windows 2000/XP: Stop Media key
  MEDIA_PLAY_PAUSE = 0xB3 # Windows 2000/XP: Play/Pause Media key
  LAUNCH_MAIL = 0xB4 # Windows 2000/XP: Start Mail key
  LAUNCH_MEDIA_SELECT = 0xB5 # Windows 2000/XP: Select Media key
  LAUNCH_APP1 = 0xB6 # Windows 2000/XP: Start Application 1 key
  LAUNCH_APP2 = 0xB7 # Windows 2000/XP: Start Application 2 key
  OEM_1 = 0xBA # Used for miscellaneous characters; it can vary by keyboard.
  #Windows 2000/XP: For the US standard keyboard, the ';:' key
  OEM_PLUS = 0xBB # Windows 2000/XP: For any country/region, the '+' key
  OEM_COMMA = 0xBC # Windows 2000/XP: For any country/region, the ',' key
  OEM_MINUS = 0xBD # Windows 2000/XP: For any country/region, the '-' key
  OEM_PERIOD = 0xBE # Windows 2000/XP: For any country/region, the '.' key
  OEM_2 = 0xBF # Used for miscellaneous characters; it can vary by keyboard.
  #Windows 2000/XP: For the US standard keyboard, the '/?' key
  OEM_3 = 0xC0 # Used for miscellaneous characters; it can vary by keyboard.
  #Windows 2000/XP: For the US standard keyboard, the '`~' key
  OEM_4 = 0xDB # Used for miscellaneous characters; it can vary by keyboard.
  #Windows 2000/XP: For the US standard keyboard, the '[{' key
  OEM_5 = 0xDC # Used for miscellaneous characters; it can vary by keyboard.
  #Windows 2000/XP: For the US standard keyboard, the '\|' key
  OEM_6 = 0xDD # Used for miscellaneous characters; it can vary by keyboard.
  #Windows 2000/XP: For the US standard keyboard, the ']}' key
  OEM_7 = 0xDE # Used for miscellaneous characters; it can vary by keyboard.
  #Windows 2000/XP: For the US standard keyboard, the 'single-quote/double-quote' key
  OEM_8 = 0xDF # Used for miscellaneous characters; it can vary by keyboard.
  OEM_102 = 0xE2 # Windows 2000/XP: Either the angle bracket key or the backslash key on the RT 102-key keyboard
  PROCESSKEY = 0xE5 # Windows 95/98/Me, Windows NT 4.0, Windows 2000/XP: IME PROCESS key
  PLAY = 0xFA # Play key
  ZOOM = 0xFB # Zoom key
  OEM_CLEAR = 0xFE # Clear key
 
end

Instructions

This script can simulate most of the common keyboard and mouse presses. You can simulate three things:
"key down" (press), "key up" (release) and "trigger key" (press and release). The syntaxes respectively are:

Code:

VK.down(VIRTUAL_KEY)
VK.up(VIRTUAL_KEY)
VK.trigger(VIRTUAL_KEY)

where VIRTUAL_KEY is the constant representing the required key.
For the exact name of the constant, check the script.
Number keys work a little different. For the number n, VIRTUAL_KEY is:

Code:

NUM[n]

So 2, 6 and 0 are "NUM[2]", "NUM[6]", "NUM[0]" respectively.
Note that this is only the case with the number keys above the letter keys. Numpad keys have individual constants. So the constant for Numpad 4 is NUMPAD4

Example: Simulating "Alt + Enter"

     Scroll down to find the constants for alt and enter keys. They are ALT
   and ENTER respectively. Now, we need to simulate "alt down", "enter down",
   "enter up", "alt up". The following code does that:

Code:

VK.down(VK::ALT) # ALT down
VK.down(VK::ENTER) # ENTER down
VK.up(VK::ENTER) # ENTER up
VK.up(VK::ALT) # ALT up

Compatibility

Should be compatible with almost everything. Might not be compatible with similar scripts.
Credits and Thanks

Credits: Fantasist for making this.
Thanks: Memor-X for requesting this.
Author's Notes

If you have any questions, suggestions or comments, you can find me (Fantasist) at:

    - www.chaos-project.com
    - www.quantumcore.forumotion.com

Enjoy ^_^

[winkio]

this seems like a useful little script.  I think I'll download it.

[DeathLock]

I wanted something like this, and you've made it a reality. Thanks. ^_^

[winkio]

Awesome for status effects for Blizz-ABS

Can make so much better effects for confuse and berserk.

[Kagutsuchi]

Looks really nice ^^ I think I will put it to good use =D

[Blizzard]

Lol, I was going to make that for Blizz-ABS. Well, you could extend this to work with Blizz-ABS so I wouldn't have to make a separate one. xD

[Fantasist]

Ah, glad you guys like it

@Bliz: What's there to extend exactly? Wait a second! I could integrate this with your input module so that VK.trigger(Input::Attack) instead of using the exact key constant. Do I have time or did you plan to do this before the contest?

[Blizzard]

Nah, I didn't plan it before the contest. v2.2 will be out later today. It will probably stay v2.2x for a while.

[Fantasist]

Good, cause I still need to figure out how to decide the commas and semicolon stuff ("OEM" keys) and do some more research.

[Blizzard]

Actually a Blizz-ABS key force input should be like "@triggered.push(Input::Key['XXX']); @pressed.push(Input::Key['XXX'])..." in Input, you get the idea.

[Memor-X]

ha, ha, one of the main reasons why i requested this script was for Blizz-ABS to show how to use allies and to make advance attacks (like a sword dash slash, like what Agile does in Megaman X2)

[Tazero]

i probaly won't use this but yaaaaaaay nun the less
Power up

[Memor-X]

i don't know if the SDK and/or Blizz-ABS is causing this problem but when i use the trigger call script for the arrow keys and Esc key something strange happens

the first test i did

Code:

Call script: VK.trigger(DOWN)
Wait: 8 frames
Call script: VK.trigger(LEFT)
Wait: 8 frames
Call script: VK.trigger(RIGHT)
Wait: 8 frames
Call script: VK.trigger(UP)
Wait: 8 frames

the character doesn't move but the game does the waiting

the second test

Code:

Call script: VK.trigger(DOWN)
Wait: 8 frames
Call script: VK.trigger(LEFT)
Wait: 8 frames
Call script: VK.trigger(RIGHT)
Wait: 8 frames
Call script: VK.trigger(UP)
Wait: 8 frames
Call script: VK.trigger(ESCAPE)

same as before, character doesn't move and the game wait but after the waiting it opens up the menu (because i'm using Blizz-ABS, the sub-menu opens)

the third test

Code:

Call script: VK.trigger(DOWN)
Wait: 8 frames
Call script: VK.trigger(LEFT)
Wait: 8 frames
Call script: VK.trigger(RIGHT)
Wait: 8 frames
Call script: VK.trigger(UP)
Wait: 8 frames
Call script: VK.trigger(ESCAPE)
Wait: 8 frames
Call script: VK.trigger(DOWN)

this time, it does nothing, doesn't even open up the menu, but it does the waiting fine

[Blizzard]

It's probably Blizz-ABS if you disabled RMXP's default controls. I'm actually not sure if this can work with Blizz-ABS without modification.

[Fantasist]

I'm guessing the character doesn't move because the DOWN constant in this script is the down arrow key on the keyboard, not the Blizz-ABS down key. Try using VK.trigger(W), VK.trigger(A), VK.trigger(S), VK.trigger(D) instead.

Yeah, this still needs some work.

[Blizzard]

VK.trigger(Input::Key['W']), VK.trigger(Input::Key['A']), etc. Try that.

[Memor-X]

i should have mentioned this but i don't have RMXP's default controls disabled and i chnage the controls in Blizz-ABS so the arrow keys move the character, not W A S D, so the key should be working, what i find strange is in the tests i did, ESCAPE worked the first time but not the second when i used DOWN

[Blizzard]

Then it could be something wrong with the key simulator. Maybe FTS should test it with Blizz-ABS. xD

[Fantasist]

o.o I will.

[Hadeki]

I must be really stupid or something because I can't figure this script out. I'd like a certain sound effect to play when a certain key is pressed. Do I make a condition branch with the script "VK.trigger(VK::NUM[1])"? Because that didn't work and I'm not sure what else to try.
(However, I really like this script by the way.)

[Today]

Today at 12:36:40 PM Karltheking4 - [french]hello[/french] == Bon jour!