[Change] Updated README and TODO.

This commit is contained in:
Allanis 2013-12-31 19:08:12 +00:00
parent 3ab5bb9313
commit 2ed2d84d0e
2 changed files with 14 additions and 3 deletions

15
README
View File

@ -72,13 +72,16 @@ Keys:
-- Syntax. -- Syntax.
KEY_IDENTIFIER = { type = KEY_TYPE, key = KEY_NUMBER, KEY_IDENTIFIER = { type = KEY_TYPE, key = KEY_NUMBER,
[reverse = KEY_REVERSE] } [reverse = KEY_REVERSE, mod = MOD_IDENTIFIER] }
KEY_IDENTIFIER is the indetifier given below: KEY_IDENTIFIER is the indetifier given below:
KEY_TYPE can be one of keyboard, jaxis or jbutton. KEY_TYPE can be one of keyboard, jaxis or jbutton.
KEY_NUMBER is the number of the key (found with xev) KEY_NUMBER is the number of the key (found with xev)
KEY_REVERSE is whether it is reversed or not, which KEY_REVERSE is whether it is reversed or not, which
is only useful in the case of jaxis. is only useful in the case of jaxis.
MOD_IDENTIFIER is the modifier to take into account, can be on of:
lctrl, rctrl, lshift, rshift, lmeta, rmeta, ralt, lalt
It isn't used with joystick bindings.
-- Eg. -- Eg.
accel = { type = "jbutton", key = 0 } accel = { type = "jbutton", key = 0 }
@ -97,9 +100,17 @@ Keys:
-- 'r' : Target closest hostile ship. -- 'r' : Target closest hostile ship.
-- 'f' : Faces the target. -- 'f' : Faces the target.
-- 'b' : Board the target. -- 'b' : Board the target.
-- 'LSHIFT' : Fires secondary weapon. -- 'LALT' : Fires secondary weapon.
-- 'e' : Switches to the next secondary weapon. -- 'e' : Switches to the next secondary weapon.
Escorts:
-- Cycle through secondary weapons until you find fighter bay, then fire
secondary weapon with LALT to dispatch fighters.
-- 1 : Command escort to attack.
-- 2 : Command escort to hold.
-- 3 : Command escort to return to hold.
-- 4 : Command escort to clear all commands.
Space: Space:
-- 'p' : Cycles through planets. -- 'p' : Cycles through planets.
-- 'l' : Attempts to land or targets nearest planet. -- 'l' : Attempts to land or targets nearest planet.

2
TODO
View File

@ -1,5 +1,5 @@
Vital: Vital:
-- Nothing right now! WOO!! -- Proper documentation.
Major: Major:
-- Event System. -- Event System.