diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d08bff --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +A runtime instance inspector for GMS1 + +## Setup +1) Add the files in the right order: objDebugList first, everything else after +2) Call scrDebugInspectorInitialize with the name of the global for determining whether the game has been started +example: +``` +scrDebugInspectorInitialize("gameStarted") +``` +3) Run the game and click on the screen +- Middle mouse button brings up a searchable list of instances in the room +- Left mouse button will inspect all objects under the cursor +- Right mouse button will quit out of the currently open lists + +## Other setup +The other two arguments for the initialization function are optional but nice to have. +- `debug_key`: Sets a keyboard key that must be held before its possible to bring up the inspector using mouse buttons +- `font`: Font to use instead of the default font. Monospace works best. + +![Demo]("images for readme/demo.gif") diff --git a/images for readme/demo.gif b/images for readme/demo.gif new file mode 100644 index 0000000..347b5e3 Binary files /dev/null and b/images for readme/demo.gif differ