Input Device Action Names Used in Cloanto Software

Abstract

This document describes the names associated to keyboard and other input device actions as implemented in scripting and configuration files used by Cloanto applications.

Overview to Keyboard Names

Keyboard names include all single-character marks that appear on keyboard keys, like "A", "@" or "5". These names are not case sensitive, i.e. "a" is the same as "A". Special attributes (e.g. UPPERCASE, or SHIFT and/or CAPS LOCK) must be used to indicate specific conditions such as upper or lower case, numeric keypad, etc. Attributes are also used to indicate certain combinations of control keys and non-control keys.

Names for Graphical Keys (All Systems)

All graphical keys (symbols) can be represented by the single character (symbol) which they are associated with, using either ISO 8859-1 or Unicode representation. In certain contexts, however, it is necessary or preferable to avoid the use of certain characters, which may be confused with control characters. For this reason, the following names are available as aliases (synonyms), of characters which may be considered special.

PLUS

MINUS

HYPHEN

PERIOD

COMMA

EURO

POUND

YEN

EQUALS

DOUBLE QUOTE

BACKSLASH

SEMICOLON

Names for Graphical Keys (PET/CBM)

The following graphical keys (symbols) appear on some models by Commodore, such as the PET/CBM, VIC 20 and C64.

UPWARDS ARROW

LEFTWARDS ARROW

PI

Names for Japanese Keys (PET/CBM)

The following keys appear on Japanese versions of the VIC 1001, VIC 20 and C64.

Names for "PETSCII" Graphical Keys (PET/CBM)

Work in progress. We may directly reference Unicode characters and make a formal proposal for missing characters.

Names for Non-Graphical Keys (Multiple Systems)

The following names are used to describe keys which do not enter text, but rather are associated with some control or spacing action. Where a key name exists with the LEFT or RIGHT prefix, the key name without prefix means "either LEFT or RIGHT".

The Commodore HOME, INST, DEL, RETURN keys use the same name as the corresponding PC keys (HOME, INSERT, DELETE, ENTER), even if the function sometimes differs (e.g. INST on the C64 inserts a white space). LINE FEED is used on both PET/CBM and Sun systems.

The C128 uses all six cursor key names (four individual direction keys, plus two horizontal/vertical keys).

SPACE

ESCAPE

TAB

ENTER ("Return" on some systems)

BACKSPACE ["Back Space" on some systems]

DELETE ("Del" on some systems)

INSERT ("Inst" on some systems)

HOME [Shift+Home gives CLR on some PET/CBM systems]

END

PAGE UP

PAGE DOWN

CURSOR UP

CURSOR DOWN

CURSOR LEFT

CURSOR RIGHT

CURSOR HORIZONTAL

CURSOR VERTICAL

PRINT SCREEN

SYS RQ

NUM LOCK

LINE FEED

SCROLL LOCK

PAUSE

BREAK

APPLICATION

F1 .. F24

SHIFT

LEFT SHIFT

RIGHT SHIFT

ALT ["Alternate" on some systems]

LEFT ALT

RIGHT ALT

CONTROL

LEFT CONTROL

RIGHT CONTROL

WINDOWS

LEFT WINDOWS

RIGHT WINDOWS

CAPS LOCK

GRAPHICS

Names for Non-Graphical Keys (Sun)

The following names are used to describe keys which do not enter text, but rather are associated with some control or spacing action. LEFT and RIGHT are not prefixes, but actual key names. For "Return" and "Alternate", see ENTER and ALT under Multiple Systems.

COMPOSE

LEFT

RIGHT

L1 .. L10 [became "Sun keys" on Sun Type 4]

R1 .. R15

Names for Non-Graphical Keys (PET/CBM and Amiga)

The following names are used to describe keys which do not enter text, but rather are associated with some spacing or other control action. Where a key name exists with the LEFT or RIGHT prefix, the key name without prefix means "either LEFT or RIGHT".

For the PET/CBM "Inst/Del" key, see INSERT and BACKSPACE under Multiple Systems ("Del" is defined by its functionality, which is a BACKSPACE, not a DELETE). For "Return", see ENTER under Multiple Systems.

For the C128 "No Scroll" key, see SCROLL LOCK under Multiple Systems.

LEFT AMIGA [solid "A" symbol]

RIGHT AMIGA ["A" outline symbol]

HELP

CLR

STOP [Shift+Stop gives RUN]

RESTORE

COMMODORE ["C=" symbol]

40 80 DISPLAY

NO SCROLL

REVERSE

OFF REVERSE

REPEAT

Keyboard Attributes

The following Keyboard Attributes can be combined together, and must be used in combination with a non-attribute key name. Attributes can be combined with the "+" sign. Space separators are optional. The KEYBOARD, NUMPAD, UPPERCASE and LOWERCASE attributes are used immediately before a key name, separated by a space, but without "+" sign.

SHIFT+

ALT+

CONTROL+

WINDOWS+

LEFT SHIFT+

RIGHT SHIFT+

LEFT ALT+

RIGHT ALT+

LEFT CONTROL+

RIGHT CONTROL+

LEFT WINDOWS+

RIGHT WINDOWS+

LEFT AMIGA+

RIGHT AMIGA+

CAPS LOCK+

ALT GR+

KEYBOARD

NUMPAD

UPPERCASE

LOWERCASE

RESTORE+

COMMODORE+

Names for CDTV and CD³² Remote (Joypad) Keys

The infrared-linked CDTV remote control is a hybrid joypad-like device which has both a set of buttons which are sent to the main unit as keyboard keys, and a set of buttons which can be set (via the Joy/Mouse switch) to emulate either an Amiga joystick or a mouse. The CD³² joypad had similar buttons, which all had a dual function (joystick/color and media player controls). The following names are used to describe the peculiar remote keyboard events (since joystick and mouse events are already described elsewhere). The internal codes are added for clarity, since some documentation contained incorrect codes.

REMOTE PLAY [also used for Pause]

REMOTE STOP [CD³² blue button]

REMOTE REWIND [also known as REW, Reverse, Fast Reverse or Previous, code 0x74]

REMOTE FORWARD [also known as FF, Fast Forward or Next, code 0x75]

REMOTE SHUFFLE [CD³² only, green button, code 0x76]

REMOTE REPEAT [CD³² only, yellow button, code 0x77]

Names for Non-Keyboard Buttons

The following names are used to describe mouse and joystick button actions. The optional PORT # prefix may be used to indicate an input port number (1 or 2 on both CBM 8-bit and Amiga systems, i.e. 0 is never used). If no port number is indicated, it is assumed that the event is related to the primary or default or current device (e.g. mouse or joystick). The PRIMARY mouse button is usually the left mouse button, and the SECONDARY mouse button is the right button.

MOUSE PRIMARY

MOUSE MIDDLE

MOUSE SECONDARY

PORT 1 MOUSE PRIMARY

JOYSTICK UP [meaning Forward]

JOYSTICK DOWN [meaning Back]

JOYSTICK LEFT

JOYSTICK RIGHT

JOYSTICK FIRE [meaning button 1]

PORT 1 JOYSTICK FIRE

PORT 2 JOYSTICK FIRE

JOYSTICK BUTTON <#> [where <#> is a button number 1-]

PORT <X> JOYSTICK BUTTON <Y> [where <X> is a port number 1-2 and <Y> is a button number 1-]

TAPE PLAY

TAPE STOP

TAPE RECORD

TAPE REWIND

TAPE FAST FORWARD

TAPE EJECT

Examples

The following are example of valid key name combinations:

NUMPAD PLUS SIGN

NUMPAD +

NUMPAD CE

NUMPAD 00

LEFT SHIFT+NUMPAD 5

KEYBOARD ENTER

LEFT ALT + RIGHT ALT + SHIFT + RIGHT WINDOWS + PLUS

SHIFT + RUN STOP

RESTORE + RUN STOP

SHIFT + CURSOR HORIZONTAL

TAPE PLAY + TAPE RECORD

Changelog

• 2007-11-11: Added non-keyboard events
• 2010-03-25: Replaced "left/right/up/down arrow" with "cursor left/right/up/down"; Added RetroPlatform events
• 2011-11-02: Added more PET/CBM names and normalization by function
• 2016-10-18: Added more PET/CBM names
• 2016-12-15: Added CDTV Joypad names
• 2019-10-22: Added CD³² Joypad Names
• 2020-11-28: Added port number prefix for non-keyboard buttons
• 2021-08-06: Added Sun names