Modular, extensible, fast. https://engine.staropensource.de
Find a file
JeremyStarTM 9866b9b0dd
All checks were successful
PRs & Pushes / build (push) Successful in 2m35s
PRs & Pushes / test (push) Successful in 2m38s
PRs & Pushes / build-apidoc (push) Successful in 2m28s
Use buildString method for some StringBuilders
2024-12-20 18:31:19 +01:00
.forgejo Add test job to commit workflow 2024-12-16 02:45:36 +01:00
.idea/copyright Change license from GNU AGPL v3 to GNU GPL v3 2024-12-20 01:23:25 +01:00
base Use buildString method for some StringBuilders 2024-12-20 18:31:19 +01:00
dist Add EngineConfiguration.toDefault method 2024-12-20 01:37:39 +01:00
gradle/wrapper Change license from GNU AGPL v3 to GNU GPL v3 2024-12-20 01:23:25 +01:00
testapp Use buildString method for some StringBuilders 2024-12-20 18:31:19 +01:00
testing Change license from GNU AGPL v3 to GNU GPL v3 2024-12-20 01:23:25 +01:00
.gitattributes Initial rewrite commit (see #17) 2024-12-12 23:10:29 +01:00
.gitignore Add .kotlin directory to .gitignore 2024-12-16 02:33:02 +01:00
build.gradle.kts Change license from GNU AGPL v3 to GNU GPL v3 2024-12-20 01:23:25 +01:00
gradle.properties Change license from GNU AGPL v3 to GNU GPL v3 2024-12-20 01:23:25 +01:00
gradlew Update to Gradle 8.9 2024-08-01 02:04:54 +02:00
gradlew.bat Initial rewrite commit (see #17) 2024-12-12 23:10:29 +01:00
LICENSE Change license from GNU AGPL v3 to GNU GPL v3 2024-12-20 01:23:25 +01:00
README.md Add dead documentation warning 2024-12-20 02:52:24 +01:00
settings.gradle.kts Change license from GNU AGPL v3 to GNU GPL v3 2024-12-20 01:23:25 +01:00

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 core engine, official subsystems, their documentation (TODO) and some miscellaneous files.

Documentation

The documentation is not yet available. We will create one soon.

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.

Please note however that you should only pass this option if your default, installed JDK is matching Java 21 or you will experience issues.

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.