README.md

FiveNet

For more screenshots and a detailed overview of the features, please check out the FiveNet documentation.

Table of Contents

• Roadmap
• Features
• Installation
• Translations (i18n)
• Security
• Development
• Community
• FAQ
• Credits
• License

Roadmap

Things on the roadmap may or may not be implemented/changed/removed without warning. For the roadmap click here.

Features

Checkout the documentation for an uptodate list of features with screenshots here.

Installation

For detailed installation methods, please visit the Getting Started Installation Methods page.

Container Images

Container images are available via GHCR.io fivenet-app/fivenet image.

Helm Chart

Helm chart is available in the separate GitHub fivenet-app/charts repository.

Plugins

Gameserver plugins are available in the separate GitHub fivenet-app/plugins repository.

Translations (i18n)

Want to help translate FiveNet or fix a translation issue? You can join the translation group by heading over to FiveNet's POEditor.com project here.

Thanks to POEditor for providing FiveNet with a free translation project!

Security

If you find a vulnerability or a potential vulnerability in FiveNet, please see the security release process.

Development

Please see development documentation.

Community

Join our community on Discord to connect with other users and developers, ask questions, and share feedback.

FAQ

What is FiveNet?

FiveNet is a platform designed to provide advanced tools and features for managing and enhancing your server infrastructure. For more details, visit the FiveNet website.

How do I install FiveNet?

You can find detailed installation instructions on the Getting Started Installation Methods page.

Where can I get support?

You can join our Discord community to ask questions, share feedback, and connect with other users and developers.

How can I contribute to FiveNet?

We welcome contributions! Please refer to the CONTRIBUTING.md file for guidelines on how to contribute.

Is FiveNet free to use?

Yes, FiveNet is open-source and licensed under the Apache 2.0 license. You can find more details in the LICENSE file.

Credits

• Leaflet Livemap Code CRS: Based upon NelsonMinar's Map Viewer Gist and VPC's CopNet/ MedicNet livemap code, and a lot of Leaflet CRS related Stackoverflow posts.

License

Code licensed under Apache 2.0 license, see LICENSE.

Licenses of used libraries, code and media can be found in the public/licenses/ folder.