Skip to content

README.md

Latest commit

 

History

History
55 lines (37 loc) · 1.69 KB

README.md

File metadata and controls

55 lines (37 loc) · 1.69 KB

ko-fi

mind$box

mind$box is a debug console for StepMania 5 and OutFox designed to display information and data.

mind.box.mp4

mind$box focuses to be compatible with newer game builds, so it may not be compatible with older versions.

Installation

  1. Install tapLua.

Linux

  1. Run the next commands in the game directory:
curl -o mindbox.sh https://raw.githubusercontent.com/EngineMachiner/mindbox/refs/heads/master/setup.sh
./mindbox.sh; rm mindbox.sh

Or it can be installed manually:

Be aware that to successfully install mind$box in your game build, it's important to have a basic understanding of scripting and theme structure.

  1. Clone the repository in the modules folder.
git clone https://github.com/EngineMachiner/mindbox mind\$box
  1. Load it after tapLua.
  LoadModule("mind$box/mind$box.lua") -- After loading tapLua...
  1. Use mindbox.print(...) to print on the console or mindbox.sysPrint(...) to use the system message function.

Remember, if you're having problems with the texture being white, not showing up and you're using legacy builds, you should enable only OpenGL as renderer in your Preferences.ini due to D3D not being able to render textures in these builds.

VideoRenderers=opengl

Credits

Thank you to everyone who contributed to the development of this project!