README.md

blueprints

Blueprints are models used to determine how an instance, a component of its terminology, will be built.
The specification can be found here

Table of Contents

• Introduction
• Contributing

Introduction

Created from files in HOCON format, blueprints definitions will later be transformed into instances, these files are verified and published in this repository not containing any sensitive data or malicious purpose, of course, if they are not used in private scope.

Here's a minimal example:

name = "My Awesome Blueprint"
version = "1.0.0"

type = "service"

remote {
    origin = "https://github.com/KatanPanel/blueprints"
}

build {
    image = "busybox"
}

The above example demonstrates the following features of blueprints:

• Semantic Versioning: Blueprints must follow the semantic versioning standard.
• Remote Tracking: Blueprints can be imported from remote sources so Katan users will not be limited to local blueprints.
• Variant: A blueprint does not necessarily have to be from a game server, service blueprints can also be created eg for a database.

Contributing

Before you start contributing remember that this repository is public and used by Katan so always remember this when doing something during your contribution that is not just beneficial to you but also in a general context.

Click to read the contribution guidelines.