https://github.com/EngineMachiner/mindbox
mind$box is a debug console for StepMania 5 and OutFox.
https://github.com/EngineMachiner/mindbox
console debugging game-development open-source outfox stepmania taplua
Last synced: 8 months ago
JSON representation
mind$box is a debug console for StepMania 5 and OutFox.
- Host: GitHub
- URL: https://github.com/EngineMachiner/mindbox
- Owner: EngineMachiner
- License: gpl-3.0
- Created: 2021-10-10T21:45:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-07-02T22:32:42.000Z (12 months ago)
- Last Synced: 2025-07-02T23:28:57.616Z (12 months ago)
- Topics: console, debugging, game-development, open-source, outfox, stepmania, taplua
- Language: Lua
- Homepage:
- Size: 1.12 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://ko-fi.com/W7W32691S)
# mind$box
**mind$box** is a **debug console** for **[StepMania 5](https://github.com/stepmania/stepmania) and [OutFox](https://github.com/TeamRizu/OutFox)**
designed to display information and data.
https://github.com/user-attachments/assets/6b68068e-5170-4935-9646-03ab4d3cb311
mind$box focuses to be compatible with newer game builds, so it may not be
compatible with older versions.
## Installation
1. Install [tapLua](https://github.com/EngineMachiner/tapLua).
### Linux
2. Run the next commands in the game directory:
```console
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**.
2. Clone the repository in the modules folder.
```
git clone https://github.com/EngineMachiner/mindbox mind\$box
```
3. Load it after tapLua.
```lua
LoadModule("mind$box/mind$box.lua") -- After loading tapLua...
```
4. Add the console actor as a persistent actor:
```lua
mindbox.console() -- fallbacks's ScreenSystemLayer aux.lua
```
5. 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
- [TeamRizu](https://github.com/TeamRizu)
Thank you to everyone who contributed to the development of this project!