Skip to content

LewMC/Essence

Repository files navigation

Essence

Crowdin Maven Build

Contributing

We welcome contributions from the community. Please fork the repository, make your changes, and submit a pull request.

Please read our contributor guide before submitting any changes, thank you!

Please merge any changes into the next-update branch, not the main branch. This helps us to ensure that our snapshot builds are labelled as snapshot so that it is clear to users download them that they are still in development, and that any changes being made will work with future versions of Essence.

Build Process

Install JDK 21 before continuing. Click here for documentation.

  • You will also need Maven for the mvn command, which can be installed here.
  • Make sure that your version of JDK 21 includes JavaDoc.
    • For example, Eclipse Temurin JDK with Hotspot 21 includes this executable.
# Clone the repository and move into it.
git clone https://github.com/lewmc/essence && cd essence

# Perform a clean build (optional if you're rebuilding).
mvn clean package -Dmaven.test.skip=true

# Build the package with an explicit version target of 21.
mvn -B package --file pom.xml -Dmaven.compiler.source=21 -Dmaven.compiler.target=21

Licensing

Essence is licensed under the Apache License 2.0. See LICENSE for more information.