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

README fixes

Browse source
This commit is contained in:
michael-grace 2021-05-15 23:53:53 +01:00
parent 09133ebcb6
commit 29094aa2f8
1 changed files with 18 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,4 +1,5 @@
# BAPSicle
### a.k.a. The Next-Gen BAPS server
!["BAPSicle logo, a pink melting ice lolly."](docs/images/logo.png "BAPSicle Logo")
@ -11,12 +12,13 @@ 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.
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](localhost:13500) for the server UI.
- Copy BAPSicle into `C:\Program Files\BAPSicle`
- Install BAPSicle.exe as a Windows Service with NSSM.
- If all goes well, open [http://localhost:13500](localhost:13500) for the server UI.
### Linux
@ -24,7 +26,7 @@ Installed service for linux is coming soon. Testing is primarily on Ubuntu 20.04
### 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).
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.
@ -35,29 +37,32 @@ Starting and stopping the server, as well as UI links, are available in the Syst
### Requirements
On all platforms:
* Python 3.7 - 3.9 Tested (macOS 3.7 may be iffy)
* Git (Obviously)
- Python 3.8 - 3.9 Tested
- Git (Obviously)
On MacOS:
* Homebrew (To install command line Platypus)
- Homebrew (To install command line Platypus)
### 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.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.
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``.
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``.
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!
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!