Skip to content

README.md

Latest commit

 

History

History
42 lines (33 loc) · 1.42 KB

README.md

File metadata and controls

42 lines (33 loc) · 1.42 KB

Warning

This project is in early stage of development. Its use in production is not recommended.

Cinnamon banner
MIT License badge

Overview

What is Cinnamon?

Cinnamon is a framework for PaperMC, which tries to allow developers code "extended vanilla" experience, providing tools for easier management of resource packs, creation of custom items and even own custom blocks all in vanilla Minecraft!

Building Cinnamon

Cinnamon has three modules:

  • cinnamon contains code of the Cinnamon plugin itself.
  • cinnamon-api contains the code of Cinnamon API. Cinnamon's core shades API in its own jar.
  • cinnamon-dummy contains the code of a "dummy" plugin, that utilizes Cinnamon API. It is a good example, if you want to see Cinnamon in live use.

To build the Cinnamon, run the next commands:

git clone https://github.com/Avatcher/Cinnamon.git
./gradlew build

Built jar locations:

  • Plugin: cinnamon/build/libs/cinnamon-${VERSION}.jar
  • API: cinnamon-api/build/libs/cinnamon-api-${VERSION}.jar
  • Dummy plugin: cinnamon-dummy/build/libs/cinnamon-dummy-${VERSION}.jar