Welcome! This is BAPS. More acurately, this is yet another attempt at a BAPS3 server.
Just want to install BAPSicle?
Currently there's just a batch script. Simply run install.bat
as administrator. If you've just built BAPSicle yourself, it'll be in the /install
folder.
This will:
- Copy BAPSicle into
C:\Program Files\BAPSicle
- Install BAPSicle.exe as a Windows Service with NSSM.
- If all goes well, open http://localhost:13500 for the server UI.
Installed service for linux is coming soon. Testing is primarily on Ubuntu 20.04. Your milage with other distros will vary.
Currently there's no installer for MacOS, so you'll have to move the build/output/BAPSicle.app
you've built and make it start automatically (if you want).
Starting and stopping the server, as well as UI links, are available in the System Menu once opening the app.
On all platforms:
- Python 3.8 - 3.11 Tested
- Poetry
- NodeJS and Yarn 1.x
- Git (Obviously)
On MacOS:
- Homebrew (To install command line Platypus)
To run the server standalone without installing BAPSicle, you'll need to install the dependencies.
Run poetry install
in the root directory to install them.
BAPSicle also requires a built version of the presenter UI in order to use; run npm run presenter-make
to build it (the output will be in presenter-ui
/).
Then, run poetry run python ./launch.py
to start the server.
Make sure to add your API key into the config page once its running.
To build a BAPSicle.exe
, run build\build-exe.bat
. The resulting file will appear in build\output
. You can then use the install instructions above to install it, or just run it standalone.
To build a BAPSicle
executable, run build/build-linux.sh
. The resulting file will appear in build/output
.
To build a BAPSicle.app
, run build/build-macos.sh
. The resulting file will appear in build/output
.
Provided is a VScode debug config to let you debug live, as well as dev\install-githook.{bat,sh}
that will help git to clean your code up as you're committing!