UltimateServer Plugins

A collection of community-created plugins to extend the functionality of UltimateServer.

Table of Contents

• 🔧 Installation
• 🧩 Plugin Showcase
• 📖 Usage
• 👨‍💻 Developer Guide
• 🤝 Contributing
• 📄 License
• 💬 Support

🔧 Installation

Follow these steps to add a plugin to your UltimateServer instance.

1. Download The Plugins

   Download the .dll plugin file from the collection.

2. Upload To The Server

   Upload the plugin .dll file you downloaded trough the UltimateServer dashboard.

3. Configure The Plugin

   Most of plugins have a config file like config.json in /path/to/your/UltimateServer/Plugins/Plugin-Name/config.json and By editing it you can configure the plugin using that file.

🧩 Plugin Showcase

This is a list of all available plugins in this repository. Click on a plugin's name to view its source code and specific documentation.

Plugin Name	Description	Author	Status
SuperLib	Provides essential api routes like /api/health and /api/system/info.	VoidbornGames	Active
HyperGames	A powerfull game hosting plugin.	VoidbornGames	Active

📖 Usage

Each plugin may have its own configuration file (usually config.yml) and a set of commands. After installing a plugin, check its dedicated folder within the repository for a specific README or configuration guide.

For example, to configure the SuperLib plugin, you would edit the file located at:

/path/to/your/UltimateServer/Plugins/SuperLib/config.json

👨‍💻 Developer Guide

Want to create your own plugin? That's great! Here's the basic structure.

See The Details Here

🤝 Contributing

We welcome contributions from the community! Whether you're fixing a bug, adding a new feature, or creating a brand new plugin, we'd love to see it.

1. Fork this repository.
2. Create a new branch for your feature (git checkout -b feature/MyNewPlugin).
3. Commit your changes (git commit -am 'Add some awesome plugin').
4. Push to the branch (git push origin feature/MyNewPlugin).
5. Create a new Pull Request.

Please ensure your code follows the project's coding standards and that you have tested your plugin thoroughly before submitting a pull request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.

💬 Support

If you encounter any issues with a plugin or have a feature request, please open an issue on the GitHub Issues page.

Made with ❤️ by the Voidborn Games community.