Skip to content

kleister/kleister-api

Repository files navigation

Kleister: API server

General Workflow Join the Matrix chat at https://matrix.to/#/#kleister:matrix.org Codacy Badge Go Reference GitHub Repo

Kleister is a web UI to manage mod packs for the Minecraft, initially focused on the Technic Launcher and MCUpdater. Even if there is an upstream version available the Technic Launcher at TechnicPack/TechnicSolder I prefered to implement it in Go for the API and VueJS for the UI including some further features like uploading the mods I want to manage and even generating docker images directly out of the managed packs. Hosting Minecraft servers based on docker images works pretty cool.

Install

You can download prebuilt binaries from the GitHub releases or from our download site. If you prefer to use containers you could use our images published on Docker Hub or Quay. You are a Mac user? Just take a look at our homebrew formula. If you need further guidance how to install this take a look at our documentation.

Development

Make sure you have a working Go environment, for further reference or a guide take a look at the install instructions. This project requires Go >= v1.18, at least that's the version we are using.

git clone https://github.com/kleister/kleister-api.git
cd kleister-api

make generate build

./bin/kleister-api -h

Security

If you find a security issue please contact kleister@webhippie.de first.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

Apache-2.0

Copyright

Copyright (c) 2018 Thomas Boerger <thomas@webhippie.de>