Engine/README.md

3 KiB

Index

About

The StarOpenSource Engine is a game and application framework written in Kotlin, primarily targeting the JVM. The engine is designed to be modular, configurable and extensible while being lightweight and fast.

In this repository you can find the engine's logging system, engine core, official subsystems, their documentation and some miscellaneous files.

Contributing

TODO, waiting for Infrastructure/website-docs#1. Sorry :c

Gradle properties

You can modify Gradle's behaviour by passing one or multiple project properties. These are read by our build.gradle.kts files and actively change the build behaviour. You can pass one by adding -P<property>=<value> to your Gradle command line.

Skipping the Java toolchain specification

Setting java.skipToolchainSpecification to true disables the JDK version check & download step performed by Gradle. Useful when automating things or if you're facing the No locally installed toolchains match and toolchain download repositories have not been defined error.

JVM arguments

You can pass the following arguments to modify the behaviour of JVMs used for executing projects.

jvm.logGC

Enables garbage collection logging.

Takes effect if set to true.

jvm.logJITandAOT

Enables logging about JIT and AOT code compilation.

Takes effect if set to true.

jvm.garbageCollector

Sets the garbage collector to use. Requires the specified garbage collector to be built into the JVM (some aren't compiled by default).

Accepts epsilon, serial and g1.