About Leaderboard
A modern, feature-rich leaderboard application designed for rust servers with Steam integration, admin management, and real-time statistics tracking.
On download, you will get a .zip file. With in you get a plugin, website files and readme.txt. I will help with any installs of the websites just message me!
Discord bot soon? Maybe
FEATURES
Core Functionality:
- Multi-Server Support - Track statistics across multiple game servers
- Real-time Leaderboards - Live player rankings with kills, deaths, K/D ratio, headshots, and playtime
- Steam Integration - Seamless Steam authentication and profile integration
- Player Search - Quick search functionality to find specific players
- Responsive Design - Optimized for desktop and mobile devices
Authentication & Security:
- Steam OAuth - login through Steam OpenID
- Permission System - Granular admin permissions and role management
Admin Panel:
- Player Management - View and manage player statistics
- Server Administration - Add, edit, and manage multiple game servers
- Admin Controls - Manage admin users and permissions
- Theme Customization - Configure application themes and branding
- Wipe Scheduling - Automated server wipe scheduling and notifications
Customization:
- Dynamic Themes - Customizable color schemes and UI themes
- Configurable Navigation - Easy-to-modify navigation menu
- Server Branding - Customizable server names and branding
Advanced Features:
- Wipe Notifications - Real-time alerts for scheduled server wipes
- Performance Optimized - Fast loading with optimized queries and caching
INSTALLATION
For detailed installation steps, please refer to README.txt
USAGE
For Players:
1. Login with Steam - Click the Steam login button to authenticate
2. View Rankings - Browse leaderboards across different servers
3. Search Players - Use the search bar to find specific players
4. Track Progress - View your personal statistics and ranking
For Administrators:
1. Access Admin Panel - Navigate to /admin after logging in as an admin
2. Manage Servers - Add new servers or modify existing ones
3. User Management - Control admin permissions and player data
4. Schedule Wipes - Set up automated server wipe schedules
5. Customize Themes - Modify the application's appearance
CONFIGURATION
Edit min.config.json to customize:
- Navigation menu items
- External links
Database Schema:
The application uses Prisma with the following main models:
- Stats - Player statistics and rankings
- Admins - Administrator accounts
- Servers - Game server configurations
- ThemeSettings - UI customization options
- WipeSchedules - Automated wipe scheduling
API DOCUMENTATION
Available Endpoints:
- GET /api/stats
- GET /api/servers
- GET /api/admins
- POST /api/wipes/execute
- GET /api/themes
Environment Variables:
- Production database URL
- Steam API keys
- NextAuth configuration
- API security keys