BAPSicle/README.md

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

!["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.

## 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](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"](docs/images/system-menu.png "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!
Capitalise BAPSicle 2020-10-29 20:08:25 +00:00			`# BAPSicle`
Fix readme image and aka 2020-10-29 20:01:47 +00:00			`### a.k.a. The Next-Gen BAPS server`
Fill readme with instructions 2020-10-29 19:59:08 +00:00
Update readme with MacOS support. 2020-11-01 00:54:50 +00:00			`!["BAPSicle logo, a pink melting ice lolly."](docs/images/logo.png "BAPSicle Logo")`
Fill readme with instructions 2020-10-29 19:59:08 +00:00
			`Welcome! This is BAPS. More acurately, this is yet another attempt at a BAPS3 server.`

			`## Installing`

			`Just want to install BAPSicle?`

			`### Windows`

Fix typo 2020-10-29 20:21:39 +00:00			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.
Fill readme with instructions 2020-10-29 19:59:08 +00:00
			`This will:`
			* Copy BAPSicle into ``C:\Program Files\BAPSicle``
			`* Install BAPSicle.exe as a Windows Service with NSSM.`
Readme typos 2020-11-01 02:50:50 +00:00			`* If all goes well, open [http://localhost:13500](localhost:13500) for the server UI.`
Fill readme with instructions 2020-10-29 19:59:08 +00:00
			`### Linux`

Readme typos 2020-11-01 02:50:50 +00:00			`Installed service for linux is coming soon. Testing is primarily on Ubuntu 20.04. Your milage with other distros will vary.`
Fill readme with instructions 2020-10-29 19:59:08 +00:00
			`### MacOS`

Update readme with MacOS support. 2020-11-01 00:54:50 +00:00			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")`
Fill readme with instructions 2020-10-29 19:59:08 +00:00
			`## Developing`

			`### Requirements`

Update readme with MacOS support. 2020-11-01 00:54:50 +00:00			`On all platforms:`
Fill readme with instructions 2020-10-29 19:59:08 +00:00			`* Python 3.7 (3.8 may also work, 3.9 is unlikely to.)`
			`* Git (Obviously)`

Update readme with MacOS support. 2020-11-01 00:54:50 +00:00			`On MacOS:`
			`* Homebrew (To install command line Platypus)`

Fill readme with instructions 2020-10-29 19:59:08 +00:00			`### Running`
			To just run the server standaline without installing, run ``python ./launch_standalone.py``.

Update readme with MacOS support. 2020-11-01 00:54:50 +00:00			`## 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`
Fill readme with instructions 2020-10-29 19:59:08 +00:00
Add linux build to the readme. 2020-11-03 22:05:48 +00:00			To build a ``BAPSicle`` executable, run ``build/build-linux.sh``. The resulting file will appear in ``build/output``.
Update readme with MacOS support. 2020-11-01 00:54:50 +00:00
			`### MacOS`
Fill readme with instructions 2020-10-29 19:59:08 +00:00
Update readme with MacOS support. 2020-11-01 00:54:50 +00:00			To build a ``BAPSicle.app``, run ``build/build-macos.sh``. The resulting file will appear in ``build/output``.
Fill readme with instructions 2020-10-29 19:59:08 +00:00
			`### Other bits`

Update readme with MacOS support. 2020-11-01 00:54:50 +00:00			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!