ash/BAPSicle
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update readme with MacOS support.

Browse source
This commit is contained in:
Matthew Stratford 2020-11-01 00:54:50 +00:00
parent 90b6707cdf
commit 6560cf52b6
No known key found for this signature in database
GPG key ID: 9E53C8B3F0B57395
4 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,7 +1,7 @@
# BAPSicle # BAPSicle
### a.k.a. The Next-Gen BAPS server ### a.k.a. The Next-Gen BAPS server
!["BAPSicle logo, a pink melting ice lolly."](/dev/logo.png "BAPSicle Logo") !["BAPSicle logo, a pink melting ice lolly."](docs/images/logo.png "BAPSicle Logo")
Welcome! This is BAPS. More acurately, this is yet another attempt at a BAPS3 server. Welcome! This is BAPS. More acurately, this is yet another attempt at a BAPS3 server.
@ -16,7 +16,7 @@ Currently there's just a batch script. Simply run ``install.bat`` as administrat
This will: This will:
* Copy BAPSicle into ``C:\Program Files\BAPSicle`` * Copy BAPSicle into ``C:\Program Files\BAPSicle``
* Install BAPSicle.exe as a Windows Service with NSSM. * Install BAPSicle.exe as a Windows Service with NSSM.
* If all goes well, open [http://localhost:5000](localhost:5000) for the server UI. * If all goes well, open [http://localhost:5000](localhost:13500) for the server UI.
### Linux ### Linux
@ -24,24 +24,40 @@ Installed service for linux is comming soon. Testing is primarily on Ubuntu 20.0
### MacOS ### MacOS
Support for MacOS will be the last to come, sorry about that. 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"](docs/images/system-menu.png "System Menu")
## Developing ## Developing
### Requirements ### Requirements
On all platforms:
* Python 3.7 (3.8 may also work, 3.9 is unlikely to.) * Python 3.7 (3.8 may also work, 3.9 is unlikely to.)
* Git (Obviously) * Git (Obviously)
On MacOS:
* Homebrew (To install command line Platypus)
### Running ### Running
To just run the server standaline without installing, run ``python ./launch_standalone.py``. To just run the server standaline without installing, run ``python ./launch_standalone.py``.
### Building ## Building
Currently mostly Windows focused. ### Windows
To build a BAPSicle.exe, run ``build\build-exe.py``. 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.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
Coming soon...
### MacOS
To build a ``BAPSicle.app``, run ``build/build-macos.sh``. The resulting file will appear in ``build/output``.
### Other bits ### Other bits
Provided is a VScode debug config to let you debug live, as well as ``dev\install-githook.bat`` that will help git to clean your code up as you're committing! 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!

4
dev/install-githook.sh Normal file
View file

@ -0,0 +1,4 @@
#!/bin/bash
cd "$(dirname "$0")"
cp "./pre-commit" "../.git/hooks/"

0
dev/logo.png → docs/images/logo.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

BIN
docs/images/system-menu.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 83 KiB