STROOP: Difference between revisions

STROOP (view source)

Revision as of 15:49, 4 May 2019

16,536 bytes added , 4 May 2019

Not a stub, although it is incomplete

JoshDuMan

Bureaucrats, Interface administrators, Administrators

1,811

edits

@@ Line 1: / Line 1: @@
-{{stub}}
+'''S'''uperMario64 '''T'''echnical '''R'''untime '''O'''bserver and '''O'''bject '''P'''rocessor, or '''STROOP''' for short, is a '''diagnostic tool''' for Super Mario 64 which displays and allows for simple editing of various game values and information. It can connect to a running emulator and update values in real time. Some core features include views of loaded/unloaded objects, Mario structure variables, camera + HUD values, an overhead map display, and many more. An up-to-date version of STROOP can be downloaded from [https://github.com/SM64-TAS-ABC/STROOP/releases/download/vDev/STROOP.zip here].
 [[File:STROOP.jpg|350px|thumb|STROOP on [https://en.wikipedia.org/wiki/Windows_10 Windows 10]]]
 [[File:ObjectSlotHack.png|350px|thumb|Tyler's ROM hack that displayed the object slots in text form]]
 [[File:Blueprint.png|350px|thumb|A blueprint of what Pannenkoek2012 suggested the program should look like]]
 [[File:SM64_diagnostic.png|350px|thumb|The SM64 Diagnostic]]
-'''S'''uperMario64 '''T'''echnical '''R'''untime '''O'''bserver and '''O'''bject '''P'''rocessor, or '''STROOP''' for short, is a diagnostic tool for Super Mario 64 which displays and allows for simple editing of various game values and information. It can connect to a running emulator and update values in real time. Some core features include views of loaded/unloaded objects, Mario structure variables, camera + HUD values, an overhead map display, and many more. An up-to-date version of STROOP can be downloaded from [https://github.com/SM64-TAS-ABC/STROOP/releases/download/vDev/STROOP.zip here].
 == History ==
 After Pannenkoek2012 discussed object slots in his [https://youtu.be/9xE2otZ-9os Science of Cloning] video, there had been a desire to view the object slots of the game in real time. Pannenkoek2012 discussed this desire with Tyler Kehne. Tyler then proceeded to make a ROM hack that could display the object slot behaviors in text form, overlaid onto the screen. Pannenkoek2012 was not pleased with this implementation, as he wanted a separate program that would show the slots visually with images of the objects. Thus, Tyler then proceeded to make a program that would do just that, which he named the SM64 Diagnostic. Tyler wrote the code for it, and Pannenkoek2012 provided the object images and names. The SM64 Diagnostic was a major breakthrough, as it showed the object slots, the process groups, the held object, object variables, and Mario variables. However, it also had some annoyances, such as it couldn't connect to an already open Mupen (it had to open Mupen itself), it would occasionally crash Mupen, the angle variables (yaw/pitch/roll) had confusing names, the variables couldn't be edited, and the checkbox variables used a confusing system.
@@ Line 18: / Line 15: @@
 == Connection Screen ==
+[[File:Connection Screen.jpg|475px|thumb|STROOP Connection Screen]]
 After STROOP finishes loading, you'll encounter a screen where you can choose what process or savestate to connect to. There are various buttons to use:
 * '''Refresh''': Refreshes the list of processes to choose from.
@@ Line 47: / Line 44: @@
 STROOP has several tabs, each of which manages one specific domain. For example, there's a Mario tab, Triangles tab, M64 tab, Map tab, etc. In fact, there are so many tabs that it's recommended that you customize which tabs are shown and their order, for your own convenience. To reorder tabs, use the left/right arrow buttons on the top right of STROOP, which will move the current tab one space over in the arrow's direction. To hide a tab, click on the tab while holding control. Using these 2 techniques, you should be able to reduce the number of tabs to a reasonable amount as well as put the tabs in the order most convenient to you. If you ever need to use a tab that you've hidden, then simply add it back using the Add Tab button on the top right of STROOP. Note that the order of tabs and which tabs are hidden are saved, so you only need to do this once, as these settings will stay the same on subsequent STROOP opens. However, if you ever download a new version of STROOP, the settings will be back to their original state. Nevertheless, you can always copy the saved settings file (STROOP\Config\SavedSettings.xml) from the older version of STROOP and replace that corresponding file in the newer version of STROOP.
+{{STROOP_Tabs}}
 == Object Slot Panel ==
@@ Line 66: / Line 64: @@
 == Object Slots ==
 The object slots are found in the Object Slot Panel. An object slot has 4 parts to it: an image, a label, a background color, and zero or more overlays.
 * '''Image''': The image shows what object is represented by the object slot. The image is transparent when the object is unloaded or set to be unloaded.
@@ Line 143: / Line 142: @@
 * '''Copy Object''': Copies the object's bytes to a custom clipboard in STROOP.
 * '''Paste Object''': Pastes STROOP's custom clipboard data onto the object. Note that this doesn't overwrite the object's next/previous memory/processed object slots references, since that would corrupt the linked list structure.
+== Variable Panel ==
 == Variables ==
+Variables are found in a Variable Panel. A variable has 2 parts to it: a name (on the left) and a value (on the right). On every STROOP update, the value updates. You can set a variable's value by double clicking on the value, entering text, and then pressing enter. Some variables are values in memory, while other variables are calculated manually (referred to as special variables). While memory variables can always be set, special variables may or may not be able to be set. If you try to set a variable and it doesn't go through (either because the variable can't be set or because you entered an illegal value), then the variable will flash red to indicate this.
+All variables come with the following options when right clicked:
+* '''Highlight''': Highlights the variable by giving it a red outline.
+* '''Lock''': Locks the variable's value. Note that the variable's value can still be edited while it's locked.
+* '''Copy''': Copies the variable's value (with no rounding) to the clipboard.
+* '''Paste''': Pastes the clipboard value to the variable.
+* '''Panel Options''': Opens up the Variable Panel options.
+* '''Open Controller''': Opens up an Advanced Controller for the variable.
+* '''Add to Custom Tab''': Adds the variable to the Custom Tab.
+* '''Fix Address''': Fixes the address of the variable.
+* '''Rename''': Allows you to rename the variable.
+* '''Remove''': Removes the variable from the Variable Panel.
+Number variables come with the following additional options when right clicked:
+* '''Round to ...''': Sets how many digits to round the variable to.
+* '''Display as Hex''': Toggles whether the variable is displayed as hex or decimal.
+Angle variables come with the following additional options when right clicked:
+* '''Signed''': Toggles whether the variable is displayed as signed or not.
+* '''Units...''': Sets the units for the angle variable. The unit options are:
+** '''In-Game Units''': These are the units that the game uses. One revolution is 65536 in-game units.
+** '''HAU''': Standing for hexadecimal angle units, these are in-game units divided by 16. Thus, one revolution is 4096 HAU. These are useful because angles that fall under the same HAU value use the same entry in the game's trig table, since angles are truncated to the closest multiple of 16 before accessing the table.
+** '''Degrees''': One revolution is 360 degrees.
+** '''Radians''': One revolution is 2*pi radians.
+** '''Revolutions''': One revolution is one revolution.
+* '''Truncate to Multiple of 16''': Toggles whether the angle's value is truncated to a multiple of 16. This is useful since angles that truncated to same the closest multiple of 16 use the same entry in the game's trig table.
+* '''Constrain to One Revolution''': Toggles whether the angle's value is constrained to one revolution. For example, an angle that's unsigned and in angle units would be constrained to the range [0, 65535], whereas an angle that's signed and in angle units would be constrained to the range [-32768, 32767].
+* '''Reverse''': Toggles whether the angle is displayed as the reverse of what it actually is.
+Address variables come with the following additional options when right clicked:
+* '''View Address''': Views the variable's value as an address in the Memory Tab.
+Object variables come with the following additional options when right clicked:
+* '''Display as Object''': Displays the variable's value as an Object. Values include:
+** '''Slot n''': The nth loaded slot.
+** '''Slot VSn''': The nth vacant slot.
+** '''PG n''': Process Group n's node.
+** '''(none)''': The value 0.
+** '''(unused object)''': The unused object slot.
+** '''(unknown object)''': A value that's not recognized as a valid object reference.
+* '''Select Object''': Selects the object slot whose object's address equals the variable's value.
+Triangle variables come with the following additional options when right clicked:
+* '''Select Triangle''': Selects a custom triangle in the Triangle Tab whose address equals the variable's value.
+Boolean variables are unique in that instead of having a text value, they have a checkbox value. The checkbox is checked if the underlying number value (after possibly masking) is non-zero. In the case that the variable represents multiple values with different checked states, the checkbox will be indeterminant. Boolean variables come with the following additional options when right clicked:
+* '''Display as Checkbox''': Toggles whether the variable is displayed as a checkbox.
+* '''Display as Inverted''': Toggles whether the checkbox's checked state is inverted.
+Variables can be selected by clicking on them. You can hold shift and click on a variable to select the range of variables from the previously selected variable to the currently selected variable. To toggle whether a variable is selected or not without unselecting all variable, click on the variable while holding control. To unselect all variables, click on the variable panel. If you right click on a variable that's selected, then you'll see a different set of options from normal, and these options will affect all selected variables. Options prefixed with "Angle:" only affect angles. Choosing the "Default" value for an option (e.g. Display as Hex) will set that option to how the variable was originally (e.g. its original status of whether it was displaying as hex). Here are these options:
+* '''Highlight...''': Highlights the variables with a red or custom-colored outline.
+* '''Lock...''': Locks the variables' values.
+* '''Fix Address...''': Fixes the addresses of the variables.
+* '''Copy...''': Copies the variable's value (with no rounding) to the clipboard. This can be done with commas, tabs, or line breaks separating the variable values. Separately, you can copy the variable values for code, which will copy instantiation statements for each of the variables, e.g. "float X = 100f". For more control over what the variables are named, hold control while clicking this option. This will open up a dialog where you can enter text, where the $ represents the variables' original names. For example, entering "my$Value" will result in "float myXValue = 100f" being copied to the clipboard.
+* '''Paste''': Pastes the clipboard value to the variables. The values for the variables will be parsed from the clipboard value, which will work so long as the values are separated by whitespace (e.g. spaces, tabs, line breaks) or commas.
+* '''Round to...''': Sets how many digits to round the variables to.
+* '''Display as Hex...''': Sets whether the variables are displayed as hex or decimal.
+* '''Angle: Signed...''': Sets whether the variables are displayed as signed or not.
+* '''Angle: Units...''': Sets the units for the angle variables. See above for more information on the unit options.
+* '''Angle: Truncate to Multiple of 16...''': Sets whether the angles' values are truncated to a multiple of 16.
+* '''Angle: Constrain to One Revolution...''': Sets whether the angles' values are constrained to one revolution.
+* '''Angle: Reverse...''': Sets whether the angles are displayed as the reverse of what it actually is.
+* '''Angle: Display as Hex...''': Sets whether the angle variables are displayed as hex or decimal.
+* '''Show Variable XML''': Shows the XML that represents the variables.
+* '''Show Variable Info''': Shows info on the variables in table form, including Name, Type, Base + Offset, N64 Address, and Emulator Address.
+* '''Background Color...''': Changes the variables background color.
+* '''Move...''': Options for moving variables.
+** '''Start Move''': Adds the selected variables to the moving-variables-clipboard.
+** '''End Move''': Moves the variables on the moving-variables-clipboard to the location of the selected variables.
+** '''Clear Move''': Clears the selected-variables-clipboard.
+* '''Remove''': Removes the variables from the Variable Panel.
+* '''Rename''': Allows you to rename the variables. This will open up a dialog where you can enter text, where the $ represents the variables' original names. For example, entering "my$Value" will result in renaming "X" to "myXValue".
+* '''Open Controller''': Opens up an Advanced Controller for the variables.
+* '''Open Triplet Controller''': Opens up a Triplet Controller for the variables.
+* '''Open Pop Out''': Opens up a Pop Out for the variables.
+* '''Add to Tab...''': Adds the variables to a tab of your choosing.
+* '''Add to Custom Tab''': Adds the variables to the Custom Tab.
+There are also many keyboard shortcuts that can be performed on variables, namely by clicking on a variable when holding one or more keys. These are:
+* '''Double Click''': Opens up the Variable Viewer form for the variable, which shows the variable's Name, Type, Base + Offset, N64 Address, and Emulator Address.
+* '''Click + Shift + Number''': Sets the variable's background color to different colors, depending on the number.
+* '''Click + Number''': Sets the variable's highlight color to different colors, depending on the number.
+* '''Click + S''': Adds the variable to the Custom Tab.
+* '''Click + T''': Adds the variable to the TAS Tab.
+* '''Click + M''': Adds the variable to the Memory Tab.
+* '''Click + P''': Adds the variable to a tab of your choosing.
+* '''Click + N''': Views the variable's value as an address in the Memory Tab.
+* '''Click + F''': Fixes the address of the variable.
+* '''Click + H''': Highlights the variable with a red outline.
+* '''Click + L''': Locks the variable's value.
+* '''Click + D''': Toggles whether the variable is displayed as hex or decimal.
+* '''Click + R''': Allows you to rename the variable.
+* '''Click + C''': Opens up an Advanced Controller for the variable.
+* '''Click + B''': Opens up an Bit Controller for the variable.
+* '''Click + Escape''': Removes the variable from the Variable Panel.
+* '''Click + Backspace''': Removes the variable from the Variable Panel.
+* '''Click + Delete''': Removes the variable from the Variable Panel.
+* '''Click + X''': Does an action related to moving a variable. Specifically: If the moving-variables-clipboard is empty, then adds the variable to the moving-variables-clipboard. If the moving-variables-clipboard is non-empty, then moves the variables of the moving-variables-clipboard to the clicked variable's current location.
+* '''Click + Backtick''': Adds the variable to the Var Hack tab.
+* '''Click + Z''': Sets the variable value to zero.
+* '''Click + Minus''': Decrements the variable value.
+* '''Click + Plus''': Increments the variable value.
+* '''Click + Q''': Sets the variable's background color to a custom color.
+* '''Click + O''': Sets the variable's background color to the last custom color.
 == Controllers ==
-[[File:STROOP Controllers.png|350px|thumb|The 3 kinds of controllers]]
+[[File:STROOP Controllers.png|350px|thumb|The various kinds of controllers]]
-Controllers are a set of controls used for manipulating one or more variables. There are 3 kinds of controllers:
+Controllers are a set of controls used for manipulating one or more variables. There are various kinds of controllers:
+* '''Simple Controller''': A Simple Controller is in charge of manipulating one variable. It consists of 2 buttons and a textbox. The buttons are used for subtracting from and adding to the variable using the value that's in the textbox. Right clicking on one of the buttons shows the option to toggle whether the buttons are inverted, i.e. swapping whether subtraction is on the left and addition is on the right or vice versa. Simple Controllers are found on the left panel of several tabs of STROOP.
-* '''Simple Controller''':
+* '''Triplet Controller''': A Triplet Controller is in charge of manipulating a triplet of variables, usually a set of (x,y,z) Euler coordinates or (theta,phi,radius) spherical coordinates. It consists of 2 sets of controls:
+** '''Square Controls''': On the left are the Square Controls, consisting of 8 buttons and a textbox arranged in square formation. For Euler coordinates, these controls manipulate the x and z coordinates. For spherical coordinates, these controls manipulate the theta and phi coordinates. In both cases, the buttons will add to or subtract from the corresponding variable(s) by the amount in the textbox. Note that you can right click on the buttons for more options so that you can customize the orientation of the buttons. Specifically, this allows you to rotate the buttons any one of eight ways, as well as invert the orientation (i.e. flip it).
+** '''Line Controls''': One the right are the Line Controls, consisting of 2 buttons and a textbox arranged in a vertical line formation. For Euler coordinates, these controls manipulate the y coordinate. For spherical coordinates, these controls manipulate the radius coordinate. In both cases, the buttons will add to or subtract from the corresponding variable by the amount in the textbox. Note that you can right click on the buttons for options to invert the buttons.
+: Triplet controllers also frequently have a Relative Checkbox in the upper right, which toggles whether the controls manipulate the variables absolutely or relative to some angle. When in relative mode, the labels on the buttons will change to emphasize this. Specifically, F = forward, B = backward, L = left, R = right, U = up, D = down. Triplet Controllers are found on the left panel of several tabs of STROOP. However, you can also create your own Triplet Controller by selecting 3 or 4 variables to represent the x,y,z and optional angle variables, right clicking, and choosing to open a Triplet Controller.
-* '''Triplet Controller''':
+* '''Advanced Controller''': An advanced controller is in charge of manipulating one or more variables. It consists of the following controls:
+** '''Name Textbox''': This shows the name(s) of the variable(s) being manipulated. Note that this can be edited.
+** '''Fix Address Checkbox''': This is used to toggle whether the variable(s) are using fixed addresses.
+** '''Value Textbox''': This displays the current value(s) of the variable(s). The background color is red if the variable(s) have fixed addresses, blue if the variable(s) don't have fixed addresses, and purple if some variables do and some variables don't have fixed addresses.
+** '''Lock Checkbox''': This is used to toggle whether the variable(s) are locked.
+** '''Subtraction Button''': This is used to subtract a value from the variable(s).
+** '''Addition/Subtraction Textbox''': This is the value that's used by the Addition Button and Subtraction Button.
+** '''Addition Button''': This is used to add a value to the variable(s).
+** '''Get Button''': This gets the value(s) of the variable(s).
+** '''Get/Set Textbox''': This is the value used by the Get Button and Set Button.
+** '''Set Button''': This sets the value(s) of the variable(s).
+: Additional notes:
+:* In the case of setting multiple variables, you can set all of the variables to different values by separating the values in the textbox with commas. Alternatively, leave just one value in the textbox to set all variables to that one value. The same applies to adding and subtracting values.
+:* The add and subtract buttons can be inverted by right clicking on them and choosing to invert.
+:* You can click on the add/subtract button and hold the mouse down while holding control in order to continuously add to or subtract from the variables. Alternatively, right click on either button and choose to Start Continuous Add (or Subtract) and then later choose to Stop Continuous Add (or Subtract).
+: You can create an Advanced Controller for a variable by clicking on the variable while holding C. Alternatively, you can create an Advanced Controller for multiple variables by selecting multiple variables, right clicking, and choosing to open a controller.
-* '''Advanced Controller''':
+* '''Bit Controller''': A Bit Controller is in charge of manipulating one variable. It consists of the following controls:
+** '''Name Textbox''': This shows the name of the variable being manipulated. Note that this can be edited.
+** '''Decimal Value''': This shows the decimal value of the variable.
+** '''Hex Value''': This shows the hex value of the variable.
+** '''Binary Value''': This shows the binary value of the variable.
+** '''Value Table''': This shows various representations of the bytes of the variable, including the decimal representation, hex representation, and binary representation. It also provides a set of checkboxes that can be used to toggle each bit of the variable. For floats, these checkboxes are colored according to the bits' role in the float, as blue represents sign, red represents exponent, and green represents mantissa.
+: Note that for floats, you can right click on the empty space of the controller, and change what the textboxes display. Specifically, they can be set to display the sign, exponent, and mantissa values of the float. You can create a Bit Controller for a variable by clicking on the variable while holding B.
 == Object Tab ==
@@ Line 218: / Line 351: @@
 == Testing Tab ==
+== Painting Tab ==

STROOP: Difference between revisions

STROOP (view source)

Revision as of 15:49, 4 May 2019

Navigation menu

Search