PDA

View Full Version : ZShell: A Live debugging and cheat shell for ZC for Necromancer (2.556)+



ZoriaRPG
11-02-2018, 08:35 AM
Some of you are probably aware, that since I've added the ability to type into ZScript, I've made a few text parsing modules.

Recently, I've given some thought to making a more portable version of my complex debug shell (https://pastebin.com/pi77rptH).

The one that I use is rather tightly woven into other things, and it isn't very easy for most people todeduce how it works. Therefore, I started again clean, writing something designed to run a single instruction in a shell, rather than a macro script.

This is now, tested and working. Press F7 to open the debug shell.

Demo Quest (http://timelord.insomnia247.nl/zc/zc_dev/testdebugshell_1.14.2.qst) | Docs (https://pastebin.com/1G2dGSwn)

FFC and Additional Visual and Audio Commands

https://youtu.be/gIHVy6StR7w


In version 1.11, I added the ability to enqueue a series of commands at one time.
Press the down arrow key to enqueue an instruction!

Enqueued Commands

https://youtu.be/T6UecY8XE9c

Basic Commands

https://youtu.be/-0iSkymXrmk


Visual Commands

https://youtu.be/1G_hE1-W5Rc


Sequence Scripts
You can store a sequernce of instructions as a sequence script, that you can run at any time by invoking RunSequence,id.


https://www.youtube.com/watch?v=H-rLwwPq1oE

You may screate up to ten sequence scripts, that function like macros, and you can save them whenj you save the quest, so that you can easily design test macros (like shell/batch scripts).

If anyone is curious on how to do new, insane things, have a look at this beastie! ;)

I designed the code in the link (above) so that when you press the F7 key (you can change this in the CFG settings), ZC opens a shell window. From there, you may type in any of the following commands:

Supported Instructions (https://www.armageddongames.net/showthread.php?98277-ZShell-A-Live-debugging-and-cheat-shell-for-ZC-for-Necromancer-(2-556)&p=918714&viewfull=1#post918714)

Syntax and Usage (https://www.armageddongames.net/showthread.php?98277-ZShell-A-Live-debugging-and-cheat-shell-for-ZC-for-Necromancer-(2-556)&p=918715&viewfull=1#post918715)

Tokens terminate by either a comma, or reaching the end of the string (NULL character).

If anyone is interested in using this, or if any of you are curious and have questions, please let me know. I may expand it to support multiple instructions and macros in the future, if there is any demand for that.

It also does not yet pause the action in ZC. I plan to add some ZScript functions to suspend all of ZC, except for scripts, just as the combo types Freeze All, and Freeze All (except FFCs), as Game->Freeze(int type, bool state), at some future point, so that scripts needn't use messy combo modification (or steal FFCs), in order to pause the game action.

The code for this should be both highly legible, and easy to modify. Adding instructions is relatively simple and straightforward, although you do need to add them in a few places--similar to adding ZASM and ZScript in the ZC Source files pertaining to ZScript (ffscript):

To Expand the Instructions
1. Define a case value after:
define LINKITEM = 12; //item, (BOOL), on / off

2. In the switch statement inside of int num_instruction_params(int instr),
add a case value for the new instruction, and return the number of params that it uses.

3. Determine the actual in-use instruction identifier, and create a case set flow/entry for its characters, in int match_instruction(int token), returning the new case value on a match.

3. Determine the actual in-use instruction identifier, and create a case set flow/entry for its characters, in int match_instruction(int token), returning the new case value on a match.

4. In the switch statement inside of void execute(), add the new case label, and give it instructions to call a normal ZScript function.

5. Args and Stack Size
The present stack supports up to two args, so, if you need more, you will need to modify the value of MAX_ARGS. The size of the stack is automatically determined and generated on compilation.


Script Syntax and Structure
This script makes use of a few new syntax features in ZScript, that require the latest Necromancer alpha builds. These include both typedef instructions, and script-local variables, arrays, and constants.

The details on these new mechanical ZScript components are a bit lengthy, so, for the sake of those shy of <tl;dr>, I'll put it all in a spoiler tag...

-=SPOILER=-

ZoriaRPG
11-02-2018, 09:07 AM
Using

Press F7 to open the shell.
Type an instruction.
Press the DOWN ARROW KEy to ENQUEUE the instruction, or;
Press ENTER to execute the instruction.
If you have enqueued instructions, press ENTER either at the
end of an instruction, or on an empty line to EXECUTE
all of your enqueued instructions.



Traces

You may print a line of text, or a literal value directly
to allegro.log using the following syntax:

%s
This traces all characters that follow it, to
allegro.log as a string.
It eats all leading spaces and characters,
so all of these are identical:
%sPRINTME
%s PRINTME
%s: PRINTME

The output of this will be:
LOG: PRINTME

%d
This traces a literal value (integer or float)
to allegro.log.
It eats all leading spaces and characters,
so all of these are identical:
%100.500
%s:100.500
%s 100.500
%s: 100.500

The output of this will be:
LOG: 100.500

Traces cannot be enqueued at this time.


Sequence Scripts

You may save a sequence of instructions that you have entered
into the shell into one of TEN SEQUENCE SLOTS.

To do this, after entering a series of commands, with a BLANK LINE,
press the CONTROL KEY and one of the main number keys (above the home row,
not on the number pad), 1 through 0.

The number key that you press corresponds to the SEQUENCE slot that your
sequence script is using.

If you save the quest, your sequence script will save with it.

To run a sequence script, open the shell, and do not add any INSTRUCTIONS ON THE STACK:
Type the command: RunSequence,id

[example--

RunSequence,1

--end example]

This will immediate;y run Sequence Script 1.



Supported Instructions

Link's Position
w : Warp Link to a specific dmap and screen
po : Reposition Link on the screen.
mx : Move link by +/-n pixels on the X axis.
my : Move link by +/-n pixels on the Y axis.

Counters
h : Set Link's HP to a specific value.
m : Set Link's Magic to a specific value.
a : Set the current number of Arrows
b : Set the current number of Bombs
r : Set the current number of Rupees
mb : Set the current number of Max Bombs
ma : Set the current number of Max Arrows
mr : Set the current number of Max Rupees
k : Set the current number of Keys
co : Set an arbitrary counter to a specific value.
rh : Refill Link's HP to Max.
rm : Refill Link's HP to Max.
rc : Refill a specific counter to Max.
mh : Set Link's Max HP.
mm : Set Link's Max MP
mc : Set the maximum value of a specific counter.

Items
lk : Set the current number of Level Keys for a specific level ID.
lm : Set if the MAP item for a specific Level is in inventory.
lc : Set if the COMPASS item for a specific Level is in inventory.
lt : Set if the TRIFORCE item for a specific Level is in inventory.
lb : Set if the BOSS KEy item for a specific Level is in inventory.
itm : Set the state of a specific item in Link's inventory.

Link's States
hb : Set if Link uses a full tile hitbox. (hitbox)
d : Set if Link can move diagonally.
inv : Set Link's Invisible state.

Create Objects
crn : Create an npc.
cri : Create an item.

FFC Values
fd : Set the Data value of one ffc.
fs : Set the Script value of one ffc.
fc : Set the CSet of an ffc.
fx : Set the X component of an ffc.
fy : Set the Y component of an ffc.
fvx : Set the X Velocity Component of an ffc.
fvy : Set the Y Velocity Component of an ffc.
fax : Set the X Accel. Component of an ffc.
fay : Set the XYAccel. Component of an ffc.
ffl : Set an ffc flag state true or false.
fth : Set the TileHeight of an ffc.
ftw : Set the TileWidth of an ffc.
feh : Set the EffectHeight of an ffc.
few : Set the EffectWidth of an ffc.
fl : Link an ffc to another, or clear a link.
fm : Write to the Misc[] values of an ffc.

Audio
pls : Play a sound effect.
plm : Play a MIDI.
dmm : Set the MIDI for a specific DMap to a desired ID.

Visual
pal : Change a DMap palette.
mon : Set a monochrome graphical state.
hu : Set a specific hue effect.
t : Set a specific tint effect.
cl : Clear hue/tint.

Misc.
run : Attempt to run an ffc script.
save : Save the game.

LITERAL VALUES
Use these as srg values, if desired, instead of literals:
lx : The current X-coordinate for Link.
ly : The current Y-coordinate for Link.

ZoriaRPG
11-02-2018, 09:09 AM
Syntax and Usage

Link's Position
w,1,2 : w,0,32 : Warps Link to DMap 0, screen 32.
po,1,2 : po,60,12 : Set Link's X to 60, and his Y to 12
mx,1 : mx,12 : moves Link +12 pixels on his X coordinate
mx,-1 : mx,-12 : moves Link -12 pixels on his X coordinate
my,1 : my,12 : moves Link +12 pixels on his Y coordinate
my,-1 : my,-12 : moves Link -12 pixels on his Y coordinate

Counters
h : h,amount
h : h,amount
m : m,amount
a : a,amount
b : b,amount
r : r,amount
mb : mb,amount
ma : mb,amount
mr : mr,amount
k : k,amount
co : co,counter_id,amount
rh : Refill Link's HP to full.
rm : Refill Link's Magic to full.
rc,1 : rc,2 : Refill Counter CR_BOMBS to full.
mh,1 : mh,64 : Set Link's HP to 64
mm,1 : mm,256 : Set Link's Max Magic to 256
mc,1,2 : mc,2,16 : Set the Bombs counter max to 16.

Items
lk : lk,level_id,,amount
lm : lm,level_id,true|false
lc : lc,level_id,true|false
lt : lt,level_id,true|false
lb : lb,level_id,tru|false
itm,1,true : itm,6,true : Set the white sword true in inventory.
itm,1,false : itm,6,true : Set the white sword falsein inventory.

Link's States
hb : hb,true|false
d : d,true|false
inv,true : Set Link's Invincibility state true.
inv,false : Set Link's Invincibility state false.

Create Objects
cri,1,2,3 : cri,id,x,y : cri,id,lx,ly : Create an item (id) at x,y
crn,1,2,3 : cri,id,x,y : Create n npc (id) at x,y

FFC Values
fc : fc,ffc_id,cset
fx : fx,ffc_id,x
fy : fy,ffc_id,y
fvx : fvx,ffc_id,vx
fvy : fvy,ffc_id,vy
fax : fax,ffc_id,ax
fay : fay,ffc_id,ay
ffl : fl,ffc_id,flag_index,(true|false)
fth : fth,ffc_id,tileheight
ftw : ftw,ffc_id,tilewidth
feh : feh,ffc_id,effectheight
few : few,ffc_id,effecteidth
fl : fl,ffc_id,link_id
fm : fm,ffc_id,misc_index,value
fd : fd,ffc_id,combo_id
fs : fsscript_id

Audio
pls : pls,sound_id
plm : plm,midi_id
dmm : dmm,dmap_id,midi_id

Visual
hu : hu,red,green,blue
t : t,red,green,blue [,distributed (true|false)]
pal : pal,-1,6 : Sets the current DMap palette to 6.
: pal,3,6 : Sets the palette for DMap ID 3 to Palette ID 6.
mon : mon,5 : Sets monochrome (violet hue) mode on. (0 to disable).
cl : cl

Misc.
run : run,script_id
save : Save the game.