https://github.com/enginemachiner/mindbox
Debug and display tool for OutFox and StepMania 5+.
https://github.com/enginemachiner/mindbox
debug outfox print stepmania
Last synced: about 1 year ago
JSON representation
Debug and display tool for OutFox and StepMania 5+.
- 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-03-02T04:07:55.000Z (over 1 year ago)
- Last Synced: 2025-03-02T05:18:43.378Z (over 1 year ago)
- Topics: debug, outfox, print, stepmania
- Language: Lua
- Homepage:
- Size: 1.09 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.
## Usage
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. Use [tapLua](https://github.com/EngineMachiner/tapLua).
---
### OutFox
2. Clone the repository in the fallback's Modules folder.
```
git clone https://github.com/EngineMachiner/mindbox mind\$box
```
3. Load tapLua first, then load mind$box and add the console actor
in `ScreenSystemLayer aux.lua` to make the console actor persistent:
```lua
-- Themes/_fallback/BGAnimations/ScreenSystemLayer aux.lua
LoadModule("tapLua/tapLua.lua")
LoadModule("mind$box/mind$box.lua")
return mindbox.console()
```
### Legacy
2. Clone the repository in the same Modules folder following the same
steps for tapLua cloning.
```
git clone https://github.com/EngineMachiner/mindbox mind\$box
```
3. Load tapLua first, then load mind$box and add the console actor
in `ScreenSystemLayer aux.lua` to make the console actor persistent:
```lua
-- Themes/_fallback/BGAnimations/ScreenSystemLayer aux.lua
dofile("Modules/tapLua/tapLua.lua")
LoadModule("mind$box/mind$box.lua")
return mindbox.console()
```
---
4. Use `mindbox.print(...)` to print into the console or `mindbox.sysPrint(...)`
if you want 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!