Introduces a new documentation site for CS2-SimpleAdmin using Docusaurus, including developer API references, tutorials, user guides, and module documentation. Removes the CleanModule example and updates FunCommands and ExampleModule. Also updates main plugin and API files to support new documentation and module structure.
5.3 KiB
sidebar_position
| sidebar_position |
|---|
| 1 |
Modules Introduction
Extend CS2-SimpleAdmin functionality with powerful modules.
What are Modules?
Modules are extensions that add new features to CS2-SimpleAdmin. They use the CS2-SimpleAdmin API to integrate seamlessly with the core plugin.
Official Modules
Fun Commands Module
Adds entertainment and player manipulation commands like god mode, noclip, freeze, and more.
Benefits of Modules
🔌 Easy Integration
- Built on CS2-SimpleAdmin API
- Automatic menu registration
- Command system integration
🎨 Feature Separation
- Keep core plugin lightweight
- Add only features you need
- Easy to enable/disable
🔧 Customizable
- Configure each module independently
- Disable unwanted commands
- Customize permissions
📦 Simple Installation
- Drop module files in folder
- Restart server
- Module auto-loads
Installing Modules
Standard Installation
-
Download the module from releases or build from source
-
Extract to plugins folder:
game/csgo/addons/counterstrikesharp/plugins/ModuleName/ -
Restart server or reload plugins:
css_plugins reload -
Configure (if needed):
addons/counterstrikesharp/configs/plugins/ModuleName/
Module Structure
Typical module structure:
plugins/
└── CS2-SimpleAdmin_ModuleName/
├── CS2-SimpleAdmin_ModuleName.dll
├── CS2-SimpleAdmin_ModuleName.json (config)
└── lang/ (translations)
├── en.json
├── pl.json
└── ...
Module Configuration
Each module has its own configuration file:
addons/counterstrikesharp/configs/plugins/ModuleName/ModuleName.json
Common Configuration Pattern
{
"Version": 1,
"CommandName": ["css_command", "css_alias"],
"OtherSettings": {
"EnableFeature": true
}
}
Key Features:
- Command lists allow multiple aliases
- Empty command list = feature disabled
- Module-specific settings
Available Modules
Core Modules
| Module | Description | Status |
|---|---|---|
| Fun Commands | God mode, noclip, freeze, speed, gravity | ✅ Official |
Community Modules
Check the GitHub repository for community-contributed modules.
Developing Modules
Want to create your own module?
See Module Development Guide →
Module vs Core Plugin
When to use Core Plugin:
- Essential admin functions
- Punishment system
- Permission management
- Database operations
When to use Modules:
- Optional features
- Server-specific functionality
- Experimental features
- Custom integrations
Module Dependencies
Required for All Modules:
- CS2-SimpleAdmin (core plugin)
- CS2-SimpleAdminApi.dll
Module-Specific:
Check each module's documentation for specific requirements.
Troubleshooting Modules
Module doesn't load
Check:
- Is CS2-SimpleAdmin loaded?
- Is CS2-SimpleAdminApi.dll in shared folder?
- Check server console for errors
- Verify module files are complete
Module commands not working
Check:
- Is command enabled in module config?
- Do you have required permissions?
- Check Commands.json for conflicts
- Verify module loaded successfully
Module conflicts
Check:
- Multiple modules providing same command
- Check server console for warnings
- Disable conflicting module
Best Practices
Module Management
- Use only needed modules - Don't overload server
- Keep modules updated - Check for updates regularly
- Test before production - Test modules on dev server first
- Review permissions - Understand what each module can do
Performance
- Monitor resource usage - Some modules may impact performance
- Configure wisely - Disable unused features
- Check logs - Monitor for errors
Module Updates
Updating Modules
- Backup current version
- Download new version
- Replace files in plugins folder
- Check configuration - New config options may exist
- Restart server
Breaking Changes
Some updates may have breaking changes:
- Check module changelog
- Review new configuration options
- Test thoroughly
Community Contributions
Sharing Modules
Created a module? Share it with the community!
- Publish on GitHub
- Document thoroughly
- Provide examples
- Include README
Using Community Modules
- Review code - Ensure it's safe
- Check compatibility - Verify CS2-SimpleAdmin version
- Test thoroughly - Don't trust blindly
- Report issues - Help improve modules
Next Steps
- Explore Fun Commands Module - Add entertainment features
- Learn Module Development - Create your own modules
- Read API Documentation - Understand the API
Need Help?
- Issues - GitHub Issues
- Discussions - GitHub Discussions
- Examples - Check official modules for reference