mirror of
https://github.com/daffyyyy/CS2-SimpleAdmin.git
synced 2026-02-17 10:31:01 +00:00
Refactor database layer and add module/plugin improvements
Reworked the database layer to support both MySQL and SQLite via new provider classes and migration scripts for each backend. Updated the build workflow to support building and packaging additional modules, including StealthModule and BanSoundModule, and improved artifact handling. Refactored command registration to allow dynamic registration/unregistration and improved API event handling. Updated dependencies, project structure, and configuration checks for better reliability and extensibility. Added new language files, updated versioning, and removed obsolete files.
**⚠️ Warning: SQLite support is currently experimental.
Using this version requires reconfiguration of your database settings!
Plugin now uses UTC time. Please adjust your configurations accordingly!
**
This commit is contained in:
66
README.md
66
README.md
@@ -1,24 +1,40 @@
|
||||
# CS2-SimpleAdmin
|
||||
|
||||
---
|
||||
|
||||
> **Manage your Counter-Strike 2 server with simple commands!**
|
||||
> CS2-SimpleAdmin is a plugin designed to help you easily manage your Counter-Strike 2 server with user-friendly commands. Whether you're banning players, managing teams, or configuring server settings, CS2-SimpleAdmin has you covered.
|
||||
|
||||
## 📜 Features
|
||||
- **Simple Commands**: Manage your server with an easy-to-use command system.
|
||||
- **MySQL Integration**: Store and retrieve player data seamlessly with MySQL.
|
||||
- **Ongoing Development**: New features and improvements are added whenever possible.
|
||||
- **Performance Optimization**: Lightweight and optimized for minimal impact on server performance.
|
||||
- **Extensible API**: Extend the functionality of CS2-SimpleAdmin by integrating it with your own plugins using the API. Create custom commands, automate tasks, and interact with the plugin programmatically to meet the specific needs of your server.
|
||||
---
|
||||
|
||||
## 🚀 Features
|
||||
|
||||
- 🎮 **Simple, Intuitive Commands:** Manage players, teams, bans, and server settings using an easy command system.
|
||||
- 🗄 **Full Database Integration:** Reliable MySQL backend with optional experimental SQLite support for persistent data storage.
|
||||
- ⚡ **Efficient and Lightweight:** Designed to minimize server resource usage while maintaining robust functionality.
|
||||
- 🚨 **Real-time Notifications:** Instant in-game and Discord notifications to keep admins and players informed.
|
||||
- 🎛 **User-Friendly Admin Interface:** Plugin menus for quick and efficient management without complex commands.
|
||||
- 🔄 **Multi-Server Compatibility:** Manage and sync data across multiple servers seamlessly.
|
||||
- 🧩 **Modular and Extensible:** Tailor the plugin with API access to add custom commands and automation.
|
||||
- 📜 **Complete Auditing Logs:** Track all administrative actions rigorously for accountability.
|
||||
- 🌐 **Discord Integration:** Stream logs and alerts to your Discord channels for centralized monitoring.
|
||||
- 🤝 **Community Driven:** Open-source with ongoing contributions from a passionate community.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Requirements
|
||||
|
||||
**Ensure all the following dependencies are installed before proceeding**
|
||||
- [CounterStrikeSharp](https://github.com/roflmuffin/CounterStrikeSharp)
|
||||
- [PlayerSettings](https://github.com/NickFox007/PlayerSettingsCS2) - Required by MenuManagerCS2
|
||||
- [AnyBaseLibCS2](https://github.com/NickFox007/AnyBaseLibCS2) - Required by PlayerSettings
|
||||
- [MenuManagerCS2](https://github.com/NickFox007/MenuManagerCS2)
|
||||
- MySQL database
|
||||
- MySQL database / SQLite
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
1. **Clone or Download the Repository**:
|
||||
Download or clone the repository and publish to your `addons/counterstrikesharp/plugins/` directory.
|
||||
|
||||
@@ -32,22 +48,48 @@
|
||||
3. **Enjoy Managing Your Server!**
|
||||
Use the commands provided by the plugin to easily manage your server.
|
||||
|
||||
---
|
||||
|
||||
## 📁 Configuration
|
||||
|
||||
The configuration file (`CS2-SimpleAdmin.json`) will be auto-generated after the first launch. It contains settings for MySQL connections, command permissions, and other plugin-specific configurations.
|
||||
|
||||
## 📙 Wiki
|
||||
For detailed documentation, guides, and tutorials, please visit [Wiki](https://cs2-simpleadmin.daffyy.dev).
|
||||
---
|
||||
|
||||
## 📚 Documentation & Support
|
||||
|
||||
Access full documentation, guides, tutorials, and developer API references here:
|
||||
[CS2-SimpleAdmin Wiki](https://cs2-simpleadmin.daffyy.dev)
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Development
|
||||
|
||||
This project started as a base for other plugins but has grown into a standalone admin management tool. Contributions are welcome! If you'd like to help with development or have ideas for new features, feel free to submit a pull request or open an issue.
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Contributing & Feedback
|
||||
|
||||
Help improve CS2-SimpleAdmin by:
|
||||
- Reporting bugs or requesting features on GitHub
|
||||
- Submitting pull requests with improvements
|
||||
- Participating in discussions and sharing ideas
|
||||
|
||||
---
|
||||
|
||||
## 💡 Credits
|
||||
|
||||
This project is inspired by the work of [Hackmastr](https://github.com/Hackmastr/css-basic-admin/). Thanks for laying the groundwork!
|
||||
|
||||
## ❤️ Support the Project
|
||||
If you find this plugin helpful and would like to support further development, consider buying me a cup of tea! Your support is greatly appreciated.
|
||||
---
|
||||
|
||||
[](https://ko-fi.com/Y8Y4THKXG)
|
||||
## ☕ Support Development
|
||||
|
||||
If you find CS2-SimpleAdmin useful, consider supporting the ongoing development:
|
||||
[](https://ko-fi.com/Y8Y4THKXG)
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
Reference in New Issue
Block a user