2020-10-29 20:08:25 +00:00
# BAPSicle
2021-05-15 22:53:53 +00:00
2020-10-29 20:01:47 +00:00
### a.k.a. The Next-Gen BAPS server
2020-10-29 19:59:08 +00:00
2020-11-01 00:54:50 +00:00
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
2021-05-15 22:53:53 +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.
2020-10-29 19:59:08 +00:00
This will:
2021-05-15 22:53:53 +00:00
- 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.
2020-10-29 19:59:08 +00:00
### Linux
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.
2020-10-29 19:59:08 +00:00
### MacOS
2021-05-15 22:53:53 +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).
2020-11-01 00:54:50 +00:00
Starting and stopping the server, as well as UI links, are available in the System Menu once opening the app.
2020-10-29 19:59:08 +00:00
## Developing
### Requirements
2020-11-01 00:54:50 +00:00
On all platforms:
2021-05-15 22:53:53 +00:00
2024-03-31 17:22:29 +00:00
- Python 3.8 - 3.11 Tested
2021-05-15 22:53:53 +00:00
- Git (Obviously)
2020-10-29 19:59:08 +00:00
2020-11-01 00:54:50 +00:00
On MacOS:
2021-05-15 22:53:53 +00:00
- Homebrew (To install command line Platypus)
2020-11-01 00:54:50 +00:00
2020-10-29 19:59:08 +00:00
### Running
2021-05-15 22:53:53 +00:00
2021-05-27 20:04:32 +00:00
To just run the server standalone without installing, run `python ./launch.py` .
2020-10-29 19:59:08 +00:00
2020-11-01 00:54:50 +00:00
## Building
### Windows
2021-05-15 22:53:53 +00:00
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.
2020-11-01 00:54:50 +00:00
### Linux
2020-10-29 19:59:08 +00:00
2021-05-15 22:53:53 +00:00
To build a `BAPSicle` executable, run `build/build-linux.sh` . The resulting file will appear in `build/output` .
2020-11-01 00:54:50 +00:00
### MacOS
2020-10-29 19:59:08 +00:00
2021-05-15 22:53:53 +00:00
To build a `BAPSicle.app` , run `build/build-macos.sh` . The resulting file will appear in `build/output` .
2020-10-29 19:59:08 +00:00
### Other bits
2021-05-15 22:53:53 +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!
