ash/BAPSicle
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Fork of BAPSicle including a nix flake for packaging https://github.com/UniversityRadioYork/BAPSicle
85 commits 5 branches 0 tags 8 MiB
CSS 48.6%
Python 45%
HTML 4%
Nix 1%
Batchfile 0.5%
Other 0.9%
Find a file
Matthew Stratford bddab0208d
Implement rate limiting to stop spamming state file writes
2020-11-04 01:19:56 +00:00
.github/workflows don't need to install unittest 2020-10-24 16:17:35 +01:00
.vscode Add standalone player running ability. 2020-10-29 21:23:37 +00:00
build Add linux build support. 2020-11-03 20:13:32 +00: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 Implement rate limiting to stop spamming state file writes 2020-11-04 01:19:56 +00:00
install Add MacOS .app support via Platypus, change port to 13500 2020-11-01 00:38:46 +00:00
templates Add pause support, as well as "true" position 2020-10-30 19:31:18 +00:00
tests Add unit test. 2020-10-24 16:16:41 +01:00
ui-static Add 404 page. 2020-10-24 13:47:48 +01:00
.gitignore Merge branch 'dev' into debugging 2020-11-01 03:02:51 +00:00
__init__.py Initial Root logging 2020-10-26 21:15:28 +00:00
launch_standalone.py Fix Windows freeze support. BONKERS. 2020-11-01 02:37:40 +00:00
player.py Implement rate limiting to stop spamming state file writes 2020-11-04 01:19:56 +00:00
README.md Add linux build to the readme. 2020-11-03 22:05:48 +00:00
server.py Merge remote-tracking branch 'origin/dev' into debugging 2020-11-03 22:24:58 +00:00
setup.py Turn bapsicle into a package. 2020-10-24 15:36:11 +01:00

README.md

BAPSicle

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

"BAPSicle logo, a pink melting ice lolly."

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.

"BAPSicle in the MacOS System Menu"

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!