README

MC-CMS is a modern, open-source Content Management System designed specifically for game servers. Built on Laravel 12, it provides a powerful and extensible platform for managing your gaming community.

✨ Features

🎮 Multi-Game Support: Minecraft, Garry's Mod, ARK, Rust, FiveM, Counter-Strike 2, and more
🔌 Plugin System: Extend functionality with powerful plugins
🎨 Theme System: Customize the look and feel with beautiful themes
👥 User Management: Comprehensive role and permission system
🛒 Marketplace: Install plugins and themes from the community marketplace
🌍 Internationalization: Fully translatable interface
🔐 Security: Built-in protection against common vulnerabilities
📊 Analytics: Track your server statistics and user activity
🎯 Modern Stack: Laravel 12, PHP 8.2+, Bootstrap 5

📋 Requirements

PHP >= 8.2
Composer >= 2.0
Node.js >= 16.x & NPM
MySQL >= 5.7 or MariaDB >= 10.2 or PostgreSQL >= 10
Web Server: Apache (with mod_rewrite) or Nginx

PHP Extensions:

BCMath, Ctype, JSON, Mbstring, OpenSSL, PDO, Tokenizer, XML, Zip

🚀 Installation

Using MC-CMS CLI (Recommended)

# Install CLI globally
composer global require exilon-studios/mccms-cli

# Create new project
mccms new my-server

# Navigate to project
cd my-server

# Follow installation wizard
php artisan serve
# Visit http://localhost:8000/install

Manual Installation

# Clone or download MC-CMS
git clone https://github.com/Exilon-Studios/MCCMS.git my-server

# Navigate to project
cd my-server

# Copy environment file
cp .env.example .env

# Generate application key
php artisan key:generate

# Configure your database in .env file
# Then run migrations
php artisan migrate --seed

# Create storage symlink
php artisan storage:link

# Install frontend dependencies
npm install && npm run prod

# Start development server
php artisan serve

Then visit http://localhost:8000/install to complete the installation.

Using Docker

# Clone the repository
git clone https://github.com/Exilon-Studios/MCCMS.git
cd MCCMS

# Copy environment file
cp .env.example .env

# Start containers
docker-compose up -d

# Install dependencies
docker-compose exec app composer install
docker-compose exec app php artisan key:generate
docker-compose exec app php artisan migrate --seed

# Visit http://localhost

📚 Documentation

Plugin Development - Create your own plugins
Theme Development - Design custom themes
CLAUDE.md - Developer guide for working with this codebase
Laravel Documentation - Framework documentation

Quick Start Guides

Creating a Plugin

php artisan plugin:create "My Plugin"

This will generate a plugin structure in plugins/my-plugin/.

Creating a Theme

php artisan theme:create "My Theme"

This will generate a theme structure in resources/themes/my-theme/.

🎮 Supported Games

MC-CMS natively supports the following games:

Minecraft (Java & Bedrock Edition)
Garry's Mod
ARK: Survival Evolved
Rust
FiveM (GTA V)
Unturned
Counter-Strike 2
7 Days to Die
Team Fortress 2

You can also implement support for custom games through the extensible game API.

🛠️ Development

Running Tests

# Run all tests
composer test

# Run specific test suite
php artisan test --testsuite=Feature
php artisan test --testsuite=Unit

Code Quality

# Fix code style (PSR-12)
./vendor/bin/pint

# Check code style
./vendor/bin/pint --test

Development Server

# Start development server with debug mode
php artisan serve

# Watch for frontend changes
npm run watch

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

How to Contribute

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Please adhere to the Code of Conduct.

📦 Marketplace

Install plugins and themes from the MC-CMS Marketplace:

# Browse available plugins (from admin panel or CLI)
php artisan plugin:list

# Install a plugin
php artisan plugin:download <plugin-name>

# Enable a plugin
php artisan plugin:enable <plugin-name>

🔒 Security

If you discover any security vulnerabilities, please email security@mc-cms.com instead of using the issue tracker. All security vulnerabilities will be promptly addressed.

Note: JavaScript injections from the admin dashboard are not classified as XSS vulnerabilities. XSS found in user-facing areas will be recognized and addressed accordingly.

📄 License

MC-CMS is open-source software licensed under the GNU General Public License v3.0.

MC-CMS - Modern CMS for Game Servers
Copyright (C) 2025 Exilon Studios

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

💖 Community & Support

💬 Discord: Join our community
📖 Documentation: docs/
🐛 Issues: GitHub Issues
💡 Discussions: GitHub Discussions

🌟 Star History

If you find MC-CMS useful, please consider giving it a star on GitHub!

Made with ❤️ by Exilon Studios

exilon-studios / mccms

Maintainers

Details