PHP Backend code used to power the Sploder Revival.
The code is mostly complete and will only ever be updated to allow for running on newer PHP versions.
For using Sploder Revival securely as an end-user, we recommend you to download the official launcher directly from the Sploder Revival website. It will prompt you to download it when necessary.
In order to use the Sploder Revival for development purposes (in a usable state, not via Ruffle), you will need to install a working version of Flash Player. We recommend downloading either of these:
- CleanFlash A modified Chinese Flash Player without adware. Flash in China still receives security updates for Windows and macOS.
- Adobe Flash Player Official version of Flash Player available in all other regions. No longer updated after December of 2020.
As well as a Flash/CleanFlash compatible browser:
Note that Flash has been discontinued since January 2021, and that using a Flash compatible browser and Flash itself should be exercised with caution outside of Sploder Revival usage.
To run the Sploder Revival, you will need to ensure you have the following installed:
Also, to ensure formatting is done correctly, please run make dev.hook
to install the necessary hooks as well as composer install
.
Further, whenever you have updated the schema of the database, please run make dev.backup.db
, which will update the schema of the database from the Dockerfile. If you are running an manual installation, please ensure you run the following Postgres command into /db/sploder.sql
when you update the database: pg_dump -U sploder_owner -d sploder --format=p --schema-only --create > /db/sploder.sql
The provided Makefile provides an easy to use interface for running the development docker compose files.
First, you need to build the image.
make build # build the sploder-image
After this, you will want to make sure you bootstrap the database for local development. This only needs to be ran once, or can be re-ran if you manually delete the database information.
If you run dev.bootstrap, it will also create two users: test
and test2
, with the password password
.
For development, the following commands will let you run the instance locally
make dev.bootstrap # RUN ONCE: bootstraps the backup database while inserting test data
make dev # Runs the dev docker compose, detaching the container
make dev.watch # Runs the dev docker compose
For production, the following commands will let you run the instance in production
make prod.bootstrap # RUN ONCE: bootstraps the backup schema only
make prod # Runs the production docker compose
If executing a manual deployment, be sure to copy .env.example
to ./src/.env
and populate the values with the specified configuration.