mobmash.click/README.md
2024-08-07 14:53:03 +02:00

1.9 KiB

MobMash

This project aims to unravel the answer to the gargantuan query of existential magnitude: Which is the best Minecraft mob?

Visitors are prompted with two mobs and should decide which one they like better. After they choose, the "looser" is replaced with a new candidate. In the background, an Elo-style rating system is keeping track of the individual matches. The rating also determines the next candidate - similar rating are paired up. Within one session, pairings are not repeated.

Tech Stack

Credits

Minecraft content and materials are trademarks and copyrights of Mojang Studios.

The mob names and images are fetched from the Minecraft Wiki (CC BY-NC-SA 3.0). - Thank you for letting me use your API!

The font used is the Minecraft Font by JDGraphics (Public Domain). The icons are Font Awesome v4.7.0 (OFL-1.1 & MIT).

Contribution

Issues and Pull Requests are always welcome!

Local Development

To develop locally, you need a PostgreSQL database and a PHP 8 interpreter. If you don't have a local web server, you can just use the built-in development server of PHP: php -S localhost:8080 -t ./html/

As for configuration, just copy ./config.templ.php to ./config.php, fill out the values, and you are ready to go.

The migrations are automatically applied with the first served request.

You will probably have to run ./bin/cron/updateData.php to create the mob entries in the database and fetch the images. The other files in the ./bin/cron/ are not necessary for most development work, as they will just some cleanup and caching stuff for production.