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: 20 days 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 (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-14T05:36:33.000Z (about 1 year ago)
• Last Synced: 2023-12-14T06:29:55.495Z (about 1 year 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

        
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/W7W32691S)

# bitEye

bitEye is a library and tool to preview RandomMovies and BGAnimations when creating simfiles or charts in OutFox and StepMania 5+.

bitEye has been tested through from StepMania 5.0.12 to 5.3 / OutFox.

https://user-images.githubusercontent.com/15896027/213898537-2c43ed29-0e4f-40b9-8ab4-c883ab724bf8.mp4

## How to use

0. Make sure you have [tapLua]( https://github.com/EngineMachiner/tapLua ).

### Outfox

1. Copy the bitEye folder to fallback Modules folder.

2. Load the tapLua and bitEye module using LoadModule() on the initial fallback screen.

   For example the ScreenInit overlay script should look like this using LoadModule(): 



   

   



### StepMania

1. Copy the bitEye folder in your "Stepmania/Scripts" folder.

2. Reload scripts once at first screen if something goes wrong.

---

3. Load bitEye's EditNoteField preview window actor to a fallback's ScreenEdit top layer:

```lua 

return Def.ActorFrame{ bitEye.spawn("EditNoteField/Actor") }

```

4. Load bitEye's OptionRow preview window actor to a fallback's ScreenMiniMenuBackgroundChange top layer:

```lua 

return Def.ActorFrame{ bitEye.spawn("OptionRow/Actor") }

```

5. Use the inputs while on these screens.

## Inputs

* The **Left Alt** key shows and hides the preview on both screens.

#### ScreenMiniMenuBackgroundChange

* The **Left Ctrl** key opens the search box. 

* Write the keywords while focusing the search box and switch the option row between results by using the **DOT** and **ENTER** keys. **Only available on OutFox.**

* The **Right Ctrl** key zooms in and out the preview.

## Credits

- Project Moondance developers

- Inori

- leadbman

- Accelerator