readme.md

Ricochet Universe

Visit the live website at https://www.ricochetuniverse.com

Server requirements

Use the provided docker-compose.yml to easily set up the server environment.

For bare-metal installs:

• Caddy
  • Use Caddy instead of PHP's development server to match production usage as there can be subtle bugs/differences
• PHP 8.3
• Composer
• MariaDB 11.4
• Node.js v20
• Redis 6.2
• A queue worker
• A task scheduler

Installation for development

After you git clone this repo...

1. Add this host to your hosts file:

   127.0.0.1 ricochet.test
   

2. Install Docker and Docker Compose
3. Copy .env.example to .env and adjust your configuration. Note that DB_USERNAME and DB_PASSWORD will be used as the initial MariaDB user when creating the database container
4. Create a text file on docker/secrets/mariadb_root_password.txt that will be your root MariaDB password
5. Install mkcert, then run mkcert -install and mkcert ricochet.test, and move the 2 generated .pem files to docker/secrets/
6. Open a terminal window and execute these commands:

   docker-compose run --rm php composer install
   docker-compose run --rm node npm install
   docker-compose run --rm node npm run development
   docker-compose run --rm php php artisan migrate
   docker-compose run --rm php ln -rsTv storage/app/public/ public/storage # php artisan storage:link does not work as it's absolute rather than relative

7. Execute docker-compose run --rm node npm run watch and leave the terminal window open to rebuild assets whenever you save

The server runs and listens on https://ricochet.test:8000

Extra steps:

• Laravel IDE Helper is installed, you can generate helper files by executing these commands:

  docker-compose run --rm php php artisan ide-helper:generate
  docker-compose run --rm php php artisan ide-helper:meta

Some useful info

There are some known issues such as the Content Security Policy being very strict and blocking Laravel Debugbar.

User-agent

Windows edition:

• Ricochet Infinity Version 3 Build 62

Mac edition:

• Ricochet Lost Worlds Version 3 Build 71

web.archive.org

• https://web.archive.org/web/20171128131900/http://www.ricochetinfinity.com
• https://web.archive.org/web/20171128145057/http://www.ricochetinfinity.com:80/levels/index.php

License

Mozilla Public License, version 2.0

Discord and GitLab icons are from the Simple Icons project and licensed under the CC0 1.0 Universal License.