App:Spectrum - Revision history

Mzxrules at 16:42, 23 March 2021

2021-03-23T16:42:20Z

Mzxrules at 20:22, 28 January 2021

2021-01-28T20:22:33Z

Mzxrules: /* GBI Parser */

2019-07-11T14:38:25Z

‎GBI Parser

Mzxrules: /* Memory Viewing Commands */

2019-02-17T17:59:28Z

‎Memory Viewing Commands

Mzxrules at 05:07, 15 December 2018

2018-12-15T05:07:47Z

Mzxrules: /* Setup Commands */

2018-12-15T04:57:30Z

‎Setup Commands

Mzxrules at 19:48, 18 June 2017

2017-06-18T19:48:29Z

Mzxrules at 07:44, 6 April 2017

2017-04-06T07:44:50Z

Mzxrules: Created page with "[http://forums.zelda64.net/topic/11646892/1/ Spectrum] is a console-based external memory viewer and editor created by mzxrules custom tailored to Ocarina of..."

2017-04-04T02:33:16Z

Created page with "[http://forums.zelda64.net/topic/11646892/1/ Spectrum] is a console-based external memory viewer and editor created by mzxrules custom tailored to Ocarina of..."

New page

[http://forums.zelda64.net/topic/11646892/1/ Spectrum] is a console-based external memory viewer and editor created by [[User:mzxrules|mzxrules]] custom tailored to Ocarina of Time and Majora's Mask. Initially created to understand how the infamous wrong warp glitch worked in Ocarina of Time, the scope tool's features have been expanded to add in various features designed to make it easier to test and debug the Zelda 64 games.

== Prerequisites ==

Windows Vista or higher operating system

== Setup Commands ==
=== emu ===
Sets up a profile for an emulator to attach to.
emu key, processName, processDescription, ramStartExpression
* key - this should be a short reference to the emulator profile. key cannot be the same as any other key value, and will likely not work if it contains spaces
* processName - The internal process name of the emulator.
* processDescription - Lets you set a quick description of the emulator
* ramStartExpression - Sets an expression to use to point to where the emulated RDRAM is located within the emulator process's memory. Process module names must be enclosed with backticks, as shown in the pj64 example below. See the expression parser for more information on expressions.
==== Example ====
emu nemu, Nemu64, Nemu64 0.8, 10020000
emu pj64, Project64, Project 64 1.6, [`project64`+d6a1c]
=== mount ===
Allows you to specify which active emulator process the program will attach itself to.
mount
mount key
<tt>mount</tt> scans for all supported emulators, while <tt>mount key</tt> will allow you to specify a specific emulator by the key value set with the <tt>emu</tt> command. If multiple instances of the same emulator are running, you will given an additional option to select the process to attach to.
==== Example ====
mount
mount pj64
mount nemu
=== game ===
Sets what game you wish to work with. You can optionally supply a ver here now, or later with the ver command
==== Examples ====
game oot
game mm
game oot n0
game mm dbg
=== ver ===
Sets what version of Ocarina of Time or Majora's Mask is loaded, without needing to specify the game. If no parameters are passed in, this will show all version codes supported by Spectrum.

== Expression Parser ==
Spectrum comes with a simple expression parser, allowing you to write expressions in place of some numeric parameters. All numbers within an expression are assumed to be in hexadecimal. The expression parser uses C#'s <tt>long</tt> type to perform calculations. The following operators are supported:
<tt>+ - * / & | ( ) [ ]</tt>
* <tt>[ ]</tt> is used to read in up to a 4 byte value at the address specified between the brackets, making it easy to follow pointer values. With the exception of the <tt>emu</tt> command's ramStartExpression, the address specified between the brackets will be truncated (value &= 0xFFFFFF).
=== Commands ===
* <tt>=</tt> - allows you to evaluate an expression <pre>=[1C84A0]</pre>

== Memory Layout Viewer Commands ==
Once you've hooked on to an emulator and chose your game version, pressing Enter on a blank line/invalid command will create a ram map. This memory map is most accurate/useful while the main [[Game States|game state]] is loaded, but it still has some use during boot/file select. To simplify the data output, RDRAM addresses are truncated to their low three bytes.
=== Toggles ===
* <tt>actor</tt> - Toggles on/off viewing actor files/overlay mapping. By default, this is set to on.
* <tt>obj</tt> - Toggles on/off object file mapping. By default, this is set to on.
* <tt>ll</tt> - Toggles on/off link list mapping for actors. By default, this set to off.
* <tt>size</tt> - Toggles whether the the end address of an item should be replaced with it's size instead. By default, this is set to off.
=== Actor Hiding ===
* <tt>hidea</tt> - Hides actor instances and their code files from the memory map by actor id. <pre>hidea 125</pre>
* <tt>showalla</tt> - Unhides all hidden actors

== Memory Viewing Commands ==
* <tt>ram</tt> - Dumps the first 0x100 bytes starting from the given address. Accepts expressions
* <tt>ramf</tt> - Dumps the first 0x100 bytes starting from the given address, displaying them as floating point numbers. Accepts expressions
* <tt>a</tt> - Attempts to find the containing item for a given ram or virtual ram address, and return various applicable info (ram, virtual ram, virtual rom addresses, etc.). Accepts expressions
* <tt>r</tt> - Attempts to convert a virtual rom address into a ram address, and return various applicable info (ram, virtual ram, virtual rom addresses, etc.). Accepts expressions.

== Actor Misc. Commands ==
* <tt>anear</tt> - Lists the actors nearest to Link, ordered by distance
* <tt>dumpa</tt> - Dumps a given actor instance to file, within the "dump" folder

== GBI Parser ==
Spectrum comes with a few commands to facilitate parsing [[F3DZEX]] GBI.
* <tt>gfx</tt> (OoT, Partial/Broken MM support) - Prints out information on the [[Graphics Context]]
* <tt>gfxclean</tt> (OoT, Partial/Broken MM support - Zero clears 'garbage' gbi instructions written by previous frames. May cause graphics exceptions if used during the middle of a gbi write.
* <tt>gbi</tt> interprets the next 0x100 bytes at the address provided as being F3DZEX GBI, printing out the result. Accepts expressions.
* <tt>dumpgbi</tt> parses every microcode instruction it encounters, and writes it to a "dump/{game}_{version}_frame.txt" file. This command will follow branches, and will stop parsing if it encounters a DL end command without any display lists stored on stack. By default, it will dump the last complete frame's display list, but it can optionally be supplied with an expression.

== Spawning and Positioning Commands ==
Spectrum allows you to warp to any reasonable coordinate in the game with ease, putting the map select to shame.
* <tt>sp</tt> - Spawns Link at "entrance 0" of the given scene. Uses internal scene numbers.
* <tt>sa</tt> (Partial MM support) - Spawn anywhere (unless you crash). Enter a scene number, room number, and x, y, z coordinates.
* <tt>sr</tt> (Partial MM support) - Spawn in a room within a given scene. Enter a room number and an x, y, z coordinate.
* <tt>xyz</tt> - Sets Link's x, y, z coordinates to the given integer value
* <tt>y</tt> - Sets's Link's y coordinate to the given integer value
* <tt>ent</tt> - Spawn using a given entrance index. Due to the way MM's entrance indexes are structured, the last byte of the index can be omitted in MM.
[[Category:Software]]

@@ Line 89: / Line 89: @@
 == GBI Parser ==
-Spectrum comes with a few commands to facilitate parsing [[F3DZEX]] GBI.
+Spectrum comes with a few commands to facilitate parsing [[F3DZEX2]] GBI, and a limited subset of [[S2DEX]] GBI.
 * <tt>gfx</tt> (OoT, Partial/Broken MM support) - Prints out information on the [[Graphics Context]]
-* <tt>gbi</tt> interprets the next 0x100 bytes at the address provided as being F3DZEX GBI, printing out the result. Accepts expressions.
+* <tt>gbi</tt> interprets the next 0x100 bytes at the address provided as being F3DZEX2 GBI, printing out the result. Accepts expressions.
 * <tt>gbidump</tt> parses every gbi instruction it encounters, and writes it to "dump/{game}_{version}_frame.txt". This command will follow branches, and will stop parsing if it encounters a DL end command without any display lists stored on stack. By default, it will dump the last complete frame's display list, but it can optionally be supplied with an expression.
 * <tt>gbiclean</tt> (OoT, Partial/Broken MM support) - Zero clears 'garbage' gbi instructions written by previous frames. Avoid using this command after a gbi instruction is written, but before the append start or end ptr has been updated.

@@ Line 85: / Line 85: @@
 * <tt>gfx</tt> (OoT, Partial/Broken MM support) - Prints out information on the [[Graphics Context]]
 * <tt>gbi</tt> interprets the next 0x100 bytes at the address provided as being F3DZEX GBI, printing out the result. Accepts expressions.
-* <tt>gbidump</tt> parses every microcode instruction it encounters, and writes it to a "dump/{game}_{version}_frame.txt" file. This command will follow branches, and will stop parsing if it encounters a DL end command
+* <tt>gbidump</tt> parses every gbi instruction it encounters, and writes it to "dump/{game}_{version}_frame.txt". This command will follow branches, and will stop parsing if it encounters a DL end command without any display lists stored on stack. By default, it will dump the last complete frame's display list, but it can optionally be supplied with an expression.
-* <tt>gbiclean</tt> (OoT, Partial/Broken MM support - Zero clears 'garbage' gbi instructions written by previous frames. May cause graphics exceptions if used during the middle of a gbi write. without any display lists stored on stack. By default, it will dump the last complete frame's display list, but it can optionally be supplied with an expression.
+* <tt>gbiclean</tt> (OoT, Partial/Broken MM support) - Zero clears 'garbage' gbi instructions written by previous frames. Avoid using this command after a gbi instruction is written, but before the append start or end ptr has been updated.
 == Spawning and Positioning Commands ==

@@ Line 1: / Line 1: @@
 {{TOC limit|3}}
-[https://www.mediafire.com/folder/qgo57n7fcczc3/Latest Spectrum] is a console-based external memory viewer and editor created by [[User:mzxrules|mzxrules]] custom tailored to Ocarina of Time and Majora's Mask. Initially created to understand how the infamous wrong warp glitch worked in Ocarina of Time, the scope tool's features have been expanded to add in various features designed to make it easier to test and debug the Zelda 64 games.
+[https://www.mediafire.com/folder/qgo57n7fcczc3/Latest Spectrum] is a console-based external memory viewer and editor created by [[User:mzxrules|mzxrules]] custom tailored to Ocarina of Time and Majora's Mask. It's initial goal was to map out the heap in order to understand the infamous wrong warp glitch better, but has been expanded to add various features such as dumping the current frame display list task, listing various collision struct data, utility functions that allow you to spawn anywhere in the game, and more.
 == Prerequisites ==
@@ Line 42: / Line 42: @@
 === ver ===
 Sets what version of Ocarina of Time or Majora's Mask is loaded, without needing to specify the game. If no parameters are passed in, this will show all version codes supported by Spectrum.
 == Expression Parser ==

@@ Line 17: / Line 17: @@
   emu nemu Nemu64, Nemu64 0.8, 10020000
   emu pj64 Project64, Project 64 1.6, [`project64`+d6a1c]
 === mount ===
 Allows you to specify which active emulator process the program will attach itself to.

← Older revision		Revision as of 07:44, 6 April 2017
Line 1:		Line 1:
		+	{{TOC limit\|3}}
	[http://forums.zelda64.net/topic/11646892/1/ Spectrum] is a console-based external memory viewer and editor created by [[User:mzxrules\|mzxrules]] custom tailored to Ocarina of Time and Majora's Mask. Initially created to understand how the infamous wrong warp glitch worked in Ocarina of Time, the scope tool's features have been expanded to add in various features designed to make it easier to test and debug the Zelda 64 games.		[http://forums.zelda64.net/topic/11646892/1/ Spectrum] is a console-based external memory viewer and editor created by [[User:mzxrules\|mzxrules]] custom tailored to Ocarina of Time and Majora's Mask. Initially created to understand how the infamous wrong warp glitch worked in Ocarina of Time, the scope tool's features have been expanded to add in various features designed to make it easier to test and debug the Zelda 64 games.

@@ Line 76: / Line 76: @@
 * <tt>a</tt> - Attempts to find the containing item for a given ram or virtual ram address, and return various applicable info (ram, virtual ram, virtual rom addresses, etc.). Accepts expressions
 * <tt>r</tt> - Attempts to convert a virtual rom address into a ram address, and return various applicable info (ram, virtual ram, virtual rom addresses, etc.). Accepts expressions.
 == Actor Misc. Commands ==

@@ Line 70: / Line 70: @@
 == Memory Viewing Commands ==
-* <tt>ram</tt> - Dumps the first 0x100 bytes starting from the given address. Accepts expressions
+* <tt>ram</tt> - Dumps the first 0x100 bytes starting from the given address, displaying them as 8 digit hexadecimal numbers. Accepts expressions
 * <tt>ramf</tt> - Dumps the first 0x100 bytes starting from the given address, displaying them as floating point numbers. Accepts expressions
 * <tt>a</tt> - Attempts to find the containing item for a given ram or virtual ram address, and return various applicable info (ram, virtual ram, virtual rom addresses, etc.). Accepts expressions

@@ Line 1: / Line 1: @@
 {{TOC limit|3}}
-[http://forums.zelda64.net/topic/11646892/1/ Spectrum] is a console-based external memory viewer and editor created by [[User:mzxrules|mzxrules]] custom tailored to Ocarina of Time and Majora's Mask. Initially created to understand how the infamous wrong warp glitch worked in Ocarina of Time, the scope tool's features have been expanded to add in various features designed to make it easier to test and debug the Zelda 64 games.
+[https://www.mediafire.com/folder/qgo57n7fcczc3/Latest Spectrum] is a console-based external memory viewer and editor created by [[User:mzxrules|mzxrules]] custom tailored to Ocarina of Time and Majora's Mask. Initially created to understand how the infamous wrong warp glitch worked in Ocarina of Time, the scope tool's features have been expanded to add in various features designed to make it easier to test and debug the Zelda 64 games.
 == Prerequisites ==
-Windows Vista or higher operating system
+Windows 8.1 or higher operating system
 == Setup Commands ==
 === emu ===
-Sets up a profile for an emulator to attach to.
+Sets up a profile for an emulator to attach to. Note that Spectrum comes with a small list of emulator settings of it's own
-  emu key, processName, processDescription, ramStartExpression
+  emu <literal> <string> <string> <string>
-* key - this should be a short reference to the emulator profile. key cannot be the same as any other key value, and will likely not work if it contains spaces
+* literal = Key, used to specify a specific emulator with the mount command. Key must be unique
-* processName - The internal process name of the emulator.
+* string = Process Name, the internal process name of the emulator
-* processDescription - Lets you set a quick description of the emulator
+* string = Process Description, used to describe the emulator in more detail
-* ramStartExpression - Sets an expression to use to point to where the emulated RDRAM is located within the emulator process's memory. Process module names must be enclosed with backticks, as shown in the pj64 example below. See the expression parser for more information on expressions.
+* string = Ram Start Expression. Sets an expression to use to point to where the emulated RDRAM is located within the emulator process's memory. Process module names must be enclosed with backticks, as shown in the pj64 example below. See the expression parser for more information on expressions.
 ==== Example ====
-  emu nemu, Nemu64, Nemu64 0.8, 10020000
+  emu nemu Nemu64, Nemu64 0.8, 10020000
-  emu pj64, Project64, Project 64 1.6, [`project64`+d6a1c]
+  emu pj64 Project64, Project 64 1.6, [`project64`+d6a1c]
 === mount ===
 Allows you to specify which active emulator process the program will attach itself to.
@@ Line 41: / Line 41: @@
 * <tt>[ ]</tt> is used to read in up to a 4 byte value at the address specified between the brackets, making it easy to follow pointer values. With the exception of the <tt>emu</tt> command's ramStartExpression, the address specified between the brackets will be truncated (value &= 0xFFFFFF).
 === Commands ===
-* <tt>=</tt> - allows you to evaluate an expression <pre>=[1C84A0]</pre>
+* <tt>= <expression></tt> - allows you to evaluate an expression <pre>=[1C84A0]</pre>
 == Memory Layout Viewer Commands ==
 Once you've hooked on to an emulator and chose your game version, pressing Enter on a blank line/invalid command will create a ram map. This memory map is most accurate/useful while the main [[Game States|game state]] is loaded, but it still has some use during boot/file select. To simplify the data output, RDRAM addresses are truncated to their low three bytes.
 === Toggles ===
 * <tt>actor</tt> - Toggles on/off viewing actor files/overlay mapping. By default, this is set to on.
 * <tt>obj</tt> - Toggles on/off object file mapping. By default, this is set to on.
-* <tt>ll</tt> - Toggles on/off link list mapping for actors. By default, this set to off.
+* <tt>part</tt> - Toggles on/off particle file mapping. By default, this is set to on.
 === Actor Hiding ===
 * <tt>hidea</tt> - Hides actor instances and their code files from the memory map by actor id. <pre>hidea 125</pre>
@@ Line 67: / Line 70: @@
 Spectrum comes with a few commands to facilitate parsing [[F3DZEX]] GBI.
 * <tt>gfx</tt> (OoT, Partial/Broken MM support) - Prints out information on the [[Graphics Context]]
 * <tt>gbi</tt> interprets the next 0x100 bytes at the address provided as being F3DZEX GBI, printing out the result. Accepts expressions.
-* <tt>dumpgbi</tt> parses every microcode instruction it encounters, and writes it to a "dump/{game}_{version}_frame.txt" file. This command will follow branches, and will stop parsing if it encounters a DL end command without any display lists stored on stack. By default, it will dump the last complete frame's display list, but it can optionally be supplied with an expression.
+* <tt>gbidump</tt> parses every microcode instruction it encounters, and writes it to a "dump/{game}_{version}_frame.txt" file. This command will follow branches, and will stop parsing if it encounters a DL end command
 == Spawning and Positioning Commands ==