Fork of BAPSicle including a nix flake for packaging https://github.com/UniversityRadioYork/BAPSicle

Find a file

Matthew Stratford a45cbda37e Switch API to async, remove APIHandler.		2021-04-18 03:14:14 +01:00
.github/workflows	Merge branch 'webstudio-build' into dev	2021-04-17 13:17:37 +01:00
.vscode	Shuffle flask into own file, change platypus options.	2021-04-17 21:28:57 +01:00
baps_types	Finish audio markers support.	2021-04-12 22:59:51 +01:00
build	Switch API to async, remove APIHandler.	2021-04-18 03:14:14 +01:00
controllers	Clean shutdown on external exit with the terminator	2021-04-17 22:51:43 +01:00
dev	Make githook set itself up.	2021-04-10 20:25:18 +01:00
docs/images
helpers	Switch API to async, remove APIHandler.	2021-04-18 03:14:14 +01:00
install
logs
presenter@2b151649c9	Update presenter to latest (actually working)	2021-04-17 18:52:22 +01:00
state
tests	Finish audio markers support.	2021-04-12 22:59:51 +01:00
ui-static
ui-templates	Switch to sanic from flask.	2021-04-18 02:03:44 +01:00
.gitignore	Add presenter to bapsicle.	2021-04-16 20:30:50 +01:00
.gitmodules	Add presenter to bapsicle.	2021-04-16 20:30:50 +01:00
__init__.py	Ran black for formatting.	2021-04-08 20:53:51 +01:00
config.py	Switch to using separate untracked build.py.	2021-04-11 20:27:46 +01:00
launch.py	Clean shutdown on external exit with the terminator	2021-04-17 22:51:43 +01:00
package-lock.json	Add presenter to bapsicle.	2021-04-16 20:30:50 +01:00
package.json	Add presenter to bapsicle.	2021-04-16 20:30:50 +01:00
player.py	Switch API to async, remove APIHandler.	2021-04-18 03:14:14 +01:00
player_handler.py	Last few pep issues.	2021-04-08 22:32:16 +01:00
README.md	Update py3.7 is iffy.	2021-04-08 23:29:44 +01:00
server.py	Switch API to async, remove APIHandler.	2021-04-18 03:14:14 +01:00
setup.py	Ran black for formatting.	2021-04-08 20:53:51 +01:00
web_server.py	Switch API to async, remove APIHandler.	2021-04-18 03:14:14 +01:00
websocket_server.py	Clean shutdown on external exit with the terminator	2021-04-17 22:51:43 +01:00

README.md

BAPSicle

a.k.a. The Next-Gen BAPS server

Welcome! This is BAPS. More acurately, this is yet another attempt at a BAPS3 server.

Installing

Just want to install BAPSicle?

Windows

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.

Linux

Installed service for linux is coming soon. Testing is primarily on Ubuntu 20.04. Your milage with other distros will vary.

MacOS

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.

Developing

Requirements

On all platforms:

Python 3.7 - 3.9 Tested (macOS 3.7 may be iffy)
Git (Obviously)

On MacOS:

Homebrew (To install command line Platypus)

Running

To just run the server standaline without installing, run python ./launch_standalone.py.

Building

Windows

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.

Linux

To build a BAPSicle executable, run build/build-linux.sh. The resulting file will appear in build/output.

MacOS

To build a BAPSicle.app, run build/build-macos.sh. The resulting file will appear in build/output.

Other bits

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!