diff --git a/README.md b/README.md index 1167c34..12b5782 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # BAPSicle ### 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. @@ -16,7 +16,7 @@ Currently there's just a batch script. Simply run ``install.bat`` as administrat 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:5000](localhost:5000) for the server UI. +* If all goes well, open [http://localhost:5000](localhost:13500) for the server UI. ### Linux @@ -24,24 +24,40 @@ Installed service for linux is comming soon. Testing is primarily on Ubuntu 20.0 ### 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 ### 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 +## 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 -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! diff --git a/dev/install-githook.sh b/dev/install-githook.sh new file mode 100644 index 0000000..78853f1 --- /dev/null +++ b/dev/install-githook.sh @@ -0,0 +1,4 @@ +#!/bin/bash +cd "$(dirname "$0")" + +cp "./pre-commit" "../.git/hooks/" diff --git a/dev/logo.png b/docs/images/logo.png similarity index 100% rename from dev/logo.png rename to docs/images/logo.png diff --git a/docs/images/system-menu.png b/docs/images/system-menu.png new file mode 100644 index 0000000..2c5eeb0 Binary files /dev/null and b/docs/images/system-menu.png differ