Skip to content

caseif/Flint

Repository files navigation

Flint

Flint is a cross-platform engine designed to act as a universal backend for Minecraft minigame mods, handling generic tasks such as arena, round, and player management which would normally require a significant time investment to develop for each minigame.

Usage

A tutorial is available in the Github wiki. Additionally, documentation is published continuously to https://jd.caseif.net/flint.

Prerequisites

Flint requires Java 7 for both compilation and use.

Building

Flint uses Gradle as its build system. To clone and build the project from scratch:

  • git clone https://github.com/caseif/Flint.git
  • cd Flint
  • cp scripts/* .git/hooks
  • ./gradlew (gradlew or sh ./gradlew on Windows)

Contribution guidelines

If you think you have a code contribution which would benefit Flint's API, feel free to create an issue or pull request. All contributions must follow the Flint doctrine where applicable.

Implementing

Specification for those wishing to implement Flint may be found here.

Contact

I can be contacted via email at [email protected].

Copyright

Flint's source code and binary are provided under the MIT license.