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

Find a file

Matthew Stratford a98388421c Fix typo		2021-04-10 23:05:38 +01:00
.github/workflows	Fix typo	2021-04-10 23:05:38 +01:00
.vscode	Add initial player tests.	2021-04-06 00:32:58 +01:00
build	More pep8 fixes	2021-04-08 22:21:28 +01:00
controllers	Last few pep issues.	2021-04-08 22:32:16 +01:00
dev	Make githook set itself up.	2021-04-10 20:25:18 +01:00
docs/images
helpers	Last pep8 errors.	2021-04-08 22:48:38 +01:00
install
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	Tickle testing	2021-04-10 20:24:53 +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	Ran black for formatting.	2021-04-08 20:53:51 +01:00
api_handler.py	Autopep run.	2021-04-08 21:15:15 +01:00
config.py.example	Fix some queuing issues for playback position timers.	2021-02-14 13:23:51 +00:00
launch_standalone.py	Ran black for formatting.	2021-04-08 20:53:51 +01:00
plan.py	Ran black for formatting.	2021-04-08 20:53:51 +01:00
player.py	Last few pep issues.	2021-04-08 22:32:16 +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	Fix log_file. var	2021-04-08 22:23:38 +01:00
setup.py	Ran black for formatting.	2021-04-08 20:53:51 +01:00
websocket_server.py	Fix player test fork() on macOS	2021-04-08 22:56:57 +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!