Skip to content

Installation and Usage on Windows

Jump to bottom
adosikas edited this page Jun 17, 2024 · 20 revisions

Installation

NOTE: This is primarily tested with the alpha version of the beatmap editor. The beta or release version will still work for most stuff tho.

Installing Python

The easiest way is installing Python directly from the Microsoft Store:

  1. Search for Python and select the latest version by "Python Software Foundation" (3.12 as of June 2024)
  2. Click the button to open the Store App
  3. Then click the download button in window that opened
  4. When done you can close the tab and the Store App

illustration of which buttons to click

If you are installing Python another way (ie from https://www.python.org/downloads/windows/), or already have it installed, ensure you have at least version 3.10 .

Installing or updating

  1. Go to the releases page and download the latest install.bat
  2. Place it anywhere convenient (does not matter where).
  3. Double click install.bat to install the latest version of this tool and all required libraries
  4. Windows now may warn you about files from untrusted sources. Feel free to open the file with a text editor to ensure it doesn't contain anything malicious, then click on "More Info" to show the "Run anyway" button. This should happen once for every .bat file.
  5. A black console window will open briefly while it is downloading and installing everything
  6. Download the start_gui_beta.bat and place it anywhere convenient (does not matter where).

Opening GUI

Just double-click the start_gui_beta.bat. Once again, the first time you will get the "untrusted source" warning (see above).

This will open a black console window showing the log (this is important if something goes wrong). Don't close this window, as it works as "server" for the GUI.

Moments later your browser should open the GUI, in a new tab.
If you accidentally close this tab, you can visit the URL again (typically http://127.0.0.1:8080 or http://localhost:8080), while the server is still running.

If the server is not running (ie crashed, or stopped, or not yet started, the GUI may report "connection lost", or your browser may report "connection failed"). In that case, simply close the tab and re-start the server.

Quick Links: Home | Installation | Glossary | Companion

Options (in order of operation)

  1. Pre-Processing: Change BPM, Delete Everything Not Matching Filter, Connect Single Notes Into Rails, Merge Rails, Change Note Type, Swap Hands, Change Wall Type
  2. Rails: Interpolate, Shorten Rails, Spiral, Spikes
  3. Movement: Scaling, Rotate, Offset, Outset, Stacking, Following Notes, Auto-Stacking, Random Offset, Random Rotation
  4. Post-Processing, Create parallel patterns, Split Rails, Convert Rails Into Single Notes, Snap to Rails, Keep Selection Alignment
Clone this wiki locally