https://github.com/enginemachiner/biteye
bitEye is a library for Outfox and StepMania 5+.
https://github.com/enginemachiner/biteye
bga-rm bgscript feature library lua preview previewer stepmania tool
Last synced: 6 months ago
JSON representation
bitEye is a library for Outfox and StepMania 5+.
- Host: GitHub
- URL: https://github.com/enginemachiner/biteye
- Owner: EngineMachiner
- License: gpl-3.0
- Created: 2020-01-29T21:00:57.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-14T05:36:33.000Z (about 2 years ago)
- Last Synced: 2023-12-14T06:29:55.495Z (about 2 years ago)
- Topics: bga-rm, bgscript, feature, library, lua, preview, previewer, stepmania, tool
- Language: Lua
- Homepage:
- Size: 104 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://ko-fi.com/W7W32691S)
# bitEye
**bitEye** is a tool, a set of actors to **preview animations and images in-game** designed for simfile creators using **[StepMania 5](https://github.com/stepmania/stepmania) or [OutFox](https://github.com/TeamRizu/OutFox)**.
This simplifies the process of creating background changes (BGChanges) for the simfiles.
**bitEye** focuses to be compatible with newer game builds, so it may not be compatible with older versions.
## Features
- An actor for the editor's notefield.
- An actor for the background changes menu.
- This actor includes a search box to browse through search results.
https://user-images.githubusercontent.com/15896027/213898537-2c43ed29-0e4f-40b9-8ab4-c883ab724bf8.mp4
## Installation
1. Install [tapLua](https://github.com/EngineMachiner/tapLua).
### Linux
2. Run the next commands in the game directory:
```console
curl -o bitEye.sh https://raw.githubusercontent.com/EngineMachiner/bitEye/refs/heads/master/bitEye.sh
./bitEye.sh; rm bitEye.sh
```
---
Or it can be installed manually:
Be aware that to successfully install bitEye 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.
3. Load it after tapLua.
```lua
LoadModule("bitEye/bitEye.lua") -- After loading tapLua...
```
4. Load the actors to each screen top layer:
```lua
bitEye.actor("OptionRow") -- ScreenMiniMenuBackgroundChange overlay.lua
bitEye.actor("EditNoteField") -- ScreenEdit overlay.lua
```
5. Use the [inputs](#Inputs) to interact with it.
---
## Inputs
- **LEFT ALT:** toggles the visibility of the preview.
### OptionRow Actor
- **LEFT CTRL:** toggles the visibility of the search box.
- **RIGHT CTRL** key zooms in and out the preview.
- The search box accepts input and performs a search based on it.
- You can navigate through the results using the **arrow keys**.
---
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)
- [Inori](https://github.com/Inorizushi)
- [leadbman](https://github.com/leadbman)
- [Accelerator](https://github.com/RhythmLunatic)
Thank you to everyone who contributed to the development of this project!