Getting Started with Oxygen

What is Oxygen and Why Use It?

Oxygen is a powerful and flexible plugin framework for SCUM servers, enabling server owners to customize and extend gameplay through the use of plugins. It opens the door to limitless possibilities, providing the tools to control and customize your server in ways that wouldn't be possible with the vanilla server software.

Whether you're aiming to create a unique player experience, want more administrative control, or simply wish to experiment with new features, Oxygen is an excellent tool to have in your arsenal.

Key Features

Oxygen provides:

• C# Plugin System - Write plugins using modern C# and .NET 8
• Hot Reload - Edit and reload plugins without server restart
• Role-Based Permissions - Advanced user and group management with wildcard support
• Event Hooks - React to player and server events
• Managed Timers - Schedule delayed and recurring tasks
• Data Persistence - Config files and data storage for plugin state
• HTTP Integration - Web API endpoints and external HTTP requests
• Database Access - Read-only access to SCUM server database

Understanding Oxygen

In the following guides, you'll learn about the various aspects of using Oxygen to manage your SCUM server:

• Installing Oxygen - Learn how to install Oxygen onto your server using the automated updater tool
• Managing Permissions - Dive into Oxygen's permission system for granular control over who can do what on your server
• Installing Plugins - Learn how to add new features and capabilities to your server by installing plugins
• Configuring Plugins - Customize plugin behavior through JSON configuration files
• Understanding Data Files - Learn about plugin data persistence and when to interact with data files

What You Can Do with Oxygen

Oxygen allows server owners to:

1. Enhance Moderation - Use advanced permission systems and admin commands for better server control
2. Automate Tasks - Schedule recurring actions like announcements, saves, and maintenance
3. Customize Gameplay - Install plugins that add kits, teleportation, economy systems, and more
4. Integrate External Tools - Connect Discord bots, web panels, and other services via HTTP
5. Track Statistics - Collect and store player data, leaderboards, and analytics

Getting Help

If you encounter issues or have questions about Oxygen:

1. Search First - Check existing documentation and community forums before asking for help
2. Plugin Issues - For plugin-specific issues, check the plugin's documentation or contact the developer
3. General Help - For questions about the Oxygen framework, ask in the Discord server or GitHub discussions
4. Report Bugs - If you find a bug in Oxygen itself, report it on GitHub with:
   • Detailed error messages
   • Steps to reproduce
   • Your Oxygen version
   • Server logs

Remember that most plugins are maintained voluntarily without compensation. While the community is supportive, immediate responses aren't guaranteed.

Next Steps

By exploring these guides, you'll gain a comprehensive understanding of Oxygen and its potential, empowering you to create a truly unique and controlled server experience.

Start with Installing Oxygen →