SimpleClansStats

Laravel based web interface for SimpleClans plugin.
Laravel version: 10.15.0

• Laravel documentation
• SimpleClans plugin

---

Features

• Powerful Leaderboard:
  Easily see which players have the best combat performance with sorting options for KDR (Kill-Death Ratio), Balance, and Member count.
• Updates clan positions daily, weekly, and monthly:
  Track your progress and see how your clan ranks over different time periods.
• Multi Language Support:
  Seamless language switching without page reload.
  Instantly translate the page into supported languages for a smoother user experience.
  Currently supported languages are: English, Portuguese (Brazil), Russian.
• Comprehensive Statistics:
  Displays latest kills between clan players, provides detailed kills by types, shows average clan balance,
  and tracks the total number of clans on the server.
• Extremely Fast and Configurable::
  Built with Vue and Inertia for a smooth and dynamic user experience.
  Easily deployable with Docker, allowing you to quickly set up and configure your environment to meet your needs.
• Adaptive Design:
  Responsive layout that adjusts seamlessly to different screen sizes and devices,
  ensuring an optimal viewing experience on desktops and mobile phones.

Support

If you have faced any issues, I'll answer on any questions in official SimpleClans discord.

🚀 Getting Started

Docker

To run SimpleClansStats under Docker, you have to use minat0/scstats:latest docker image in your compose file.
Example is located here.

Web server

Prerequisites

• Any http server. Most popular are Nginx or Apache.
• PHP v8.1 or higher
• Composer v2.7.2 or higher
• Node.js v20.12.2 or higher
• npm v10.8.2 or higher

Step by step

1. Clone from master branch or download from release page.
2. Install php dependencies through composer:

composer install --no-dev --optimize-autoloader

3. Install and build node.js dependencies through npm:

npm install
npm run build

4. Make copy of .env.example to .env and set up it.

cp .env.example .env
php artisan key:generate

You have to change DB_, SC_ settings to connect to the databases.
Make sure SC_ database has sc_players, sc_clans, sc_kills tables to work finely.

5. Add task scheduling rule to crontab.

crontab -e 
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

6. Configure your http server to process the SCStats.
   You may look an example of Nginx configuration here.
   Don't forget to change fastcgi_pass scstats:9000; to your php-fpm server.

7. Profit!

✨ Sponsored By

mikasa.host

It is my game hosting, the perfect solution for launching your own Minecraft server.
For just $1 in a month, you can create a powerful server featuring top-tier components like Ryzen 9 5950X processors, DDR4 RAM, and NVMe disks. Mikasa.host offers convenient and speedy registration via Discord and supports hosting servers for a variety of games, not just Minecraft.

😎 Thank you especially

License

This project is under Apache2 license.