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

Find a file

Matthew Stratford 2ce75a4cd4 Include test resources in repo.		2021-04-07 22:32:56 +01:00
.github/workflows	Always archive test logs.	2021-04-07 22:25:39 +01:00
.vscode	Add initial player tests.	2021-04-06 00:32:58 +01:00
build	Check for modinfo soundcore.	2021-04-07 21:45:36 +01:00
controllers	Fix serial init	2021-04-07 19:54:27 +01:00
dev	Merge branch 'dev' into debugging	2020-11-01 03:02:51 +00:00
docs/images	Update readme with MacOS support.	2020-11-01 00:54:50 +00:00
helpers	Fix file leak.	2021-04-07 21:22:11 +01:00
install	Add logs folder mkdir to installer	2020-11-05 19:03:26 +00:00
logs	Add logrotate and create dir if missing.	2021-04-05 22:41:22 +01:00
state	keep the folders to keep windows happy	2020-11-10 18:45:54 +00:00
templates	Finish controller to log correctly, make port configurable.	2021-04-05 22:13:53 +01:00
tests	Include test resources in repo.	2021-04-07 22:32:56 +01:00
ui-static	Setting output stays on config page & add favicon	2021-03-22 00:45:46 +00:00
.gitignore	Include test resources in repo.	2021-04-07 22:32:56 +01:00
__init__.py	Initial Root logging	2020-10-26 21:15:28 +00:00
api_handler.py	Various reliabilty / debugging improvements	2021-04-04 22:34:46 +01:00
config.py.example	Fix some queuing issues for playback position timers.	2021-02-14 13:23:51 +00:00
launch_standalone.py	Various reliabilty / debugging improvements	2021-04-04 22:34:46 +01:00
plan.py	make sure weight and trackid are ints.	2021-04-06 22:39:33 +01:00
player.py	File exists/output name validation.	2021-04-07 20:14:39 +01:00
player_handler.py	Lower CPU a bit with slower loops.	2021-04-04 23:14:08 +01:00
README.md	Add linux build to the readme.	2020-11-03 22:05:48 +00:00
server.py	Tidy up init for flake8.	2021-04-07 21:13:19 +01:00
setup.py
websocket_server.py	Lower CPU a bit with slower loops.	2021-04-04 23:14:08 +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.8 may also work, 3.9 is unlikely to.)
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!