docs: Add CHANGELOG, update Geary -> WorldScoped in examples

Author: 0ffz

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project between Minecraft versions will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). We currently do not follow semver while
+MAJOR is set to zero.
+
+## [Unreleased]
+
+### Added
+
+- `geary-examples` module with some basic engine setup examples
+
+### Changed
+
+- Switched to our own small DI library for internal module and for addons
+- `WorldScoped` is now the preferred receiver when writing extension functions. `WorldScoped.newScope()` can be used to
+  register systems, observers, etc... and automatically unregister them when calling `close` on the returned scope

README.md

@@ -30,7 +30,7 @@ Read our [Quickstart guide](https://docs.mineinabyss.com/geary/quickstart/) to s
 data class Position(var x: Double, var y: Double)
 data class Velocity(var x: Double, var y: Double)
 
-fun Geary.updatePositionSystem() = system(query<Position, Velocity>())
+fun WorldScoped.updatePositionSystem() = system(query<Position, Velocity>())
     .every(interval = 20.milliseconds)
     .exec { (position, velocity) ->
         // We can access our components like regular variables!
@@ -41,22 +41,27 @@ fun Geary.updatePositionSystem() = system(query<Position, Velocity>())
 
 fun main() {
     // Set up geary
-    geary(ArchetypeEngineModule) {
+    val world = geary(ArchetypeEngineModule()) {
         // example engine configuration
         install(Prefabs)
     }
 
-    val posSystem = geary.updatePositionSystem()
+    with(world) {
+        // Create our system
+        val posSystem = updatePositionSystem()
 
-    // Create an entity the system can run on
-    entity {
-        setAll(Position(0.0, 0.0), Velocity(1.0, 0.0))
+        // Create an entity the system can run on
+        entity {
+            setAll(Position(0.0, 0.0), Velocity(1.0, 0.0))
+        }
+
+        posSystem.tick() // exec just this system
+        tick() // exec all registered repeating systems, interval used to calculate every n ticks to run
+
+        val positions: List<Position> = posSystem.map { (pos) -> pos }
     }
-    
-    posSystem.tick() // exec just this system
-    geary.engine.tick() // exec all registered repeating systems, interval used to calculate every n ticks to run
-    
-    val positions: List<Position> = posSystem.map { (pos) -> pos }
+
+    world.close() // Use world.newScope(), then close to separate groups of systems into modules
 }
 
 ```

addons/geary-actions/test/com/mineinabyss/geary/actions/ConfigEntityObserversTests.kt

@@ -32,7 +32,7 @@ class ConfigEntityObserversTests : GearyTest() {
     class MyComp()
 
     override fun setupGeary() = geary(TestEngineModule) {
-        load(GearyActions)
+        install(GearyActions)
 
         serialization {
             withCommonComponentNames()

addons/geary-actions/test/com/mineinabyss/geary/actions/ExpressionDecodingTest.kt

@@ -27,13 +27,13 @@ class ExpressionDecodingTest : GearyTest() {
     override fun setupGeary() = geary(TestEngineModule) {
         serialization {
             registerComponentSerializers(
-                TestFunction.serializer()
+                TestFunction::class to TestFunction.serializer()
             )
             format("yml", ::YamlFormat)
         }
     }
 
-    val format get() = getAddon(SerializableComponents).formats["yml"] as YamlFormat
+    val format get() = getAddon(SerializableComponents).formats.getFormat("yml") as YamlFormat
 //    @org.junit.jupiter.api.Test
 //    fun `should correctly decode json`() {
 //        val input = """

addons/geary-serialization/src/com/mineinabyss/geary/serialization/helpers/Component.kt

@@ -2,12 +2,12 @@ package com.mineinabyss.geary.serialization.helpers
 
 import com.mineinabyss.geary.datatypes.ComponentId
 import com.mineinabyss.geary.helpers.componentId
-import com.mineinabyss.geary.modules.Geary
+import com.mineinabyss.geary.modules.WorldScoped
 import com.mineinabyss.geary.serialization.SerializableComponents
 
 /**
  * Gets the id of a component by its serial name.
  * Throws an error if the component name does not exist.
  */
-fun Geary.componentId(serialName: String): ComponentId =
+fun WorldScoped.componentId(serialName: String): ComponentId =
     componentId(getAddon(SerializableComponents).serializers.getClassFor(serialName))

geary-benchmarks/src/com/mineinabyss/geary/benchmarks/unpacking/Systems.kt

@@ -1,11 +1,10 @@
 package com.mineinabyss.geary.benchmarks.unpacking
 
 import com.mineinabyss.geary.benchmarks.helpers.*
-import com.mineinabyss.geary.modules.Geary
-import com.mineinabyss.geary.systems.query.GearyQuery
+import com.mineinabyss.geary.modules.WorldScoped
 import com.mineinabyss.geary.systems.query.query
 
-fun Geary.systemOf1() = cache(query<Comp1>())
-fun Geary.systemOf1OrNull() = cache(query<Comp1?>())
-fun Geary.systemOf2() = cache(query<Comp1, Comp2>())
-fun Geary.systemOf6() = cache(query<Comp1, Comp2, Comp3, Comp4, Comp5, Comp6>())
+fun WorldScoped.systemOf1() = cache(query<Comp1>())
+fun WorldScoped.systemOf1OrNull() = cache(query<Comp1?>())
+fun WorldScoped.systemOf2() = cache(query<Comp1, Comp2>())
+fun WorldScoped.systemOf6() = cache(query<Comp1, Comp2, Comp3, Comp4, Comp5, Comp6>())

gradle.properties

@@ -1,6 +1,8 @@
 group=com.mineinabyss
-version=0.28
+version=0.29
 # Workaround for dokka builds failing on CI, see https://github.com/Kotlin/dokka/issues/1405
 #org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m
 idofrontVersion=2.0.0-dev.7
 kotlin.native.ignoreDisabledTargets=true
+org.gradle.configuration-cache=true
+org.gradle.caching=true

gradle/libs.versions.toml

@@ -2,20 +2,12 @@
 androidxCollection = "1.4.0"
 atomicfu = "0.24.0"
 kotlinxBenchmarkRuntime = "0.4.10"
-okio = "3.9.0"
 roaringbitmap = "1.0.6"
 statelyConcurrency = "2.0.7"
-koin = "4.1.0"
-junitJupiter = "5.8.1"
-kodein = "7.30.0"
 
 [libraries]
 androidx-collection = { module = "androidx.collection:collection", version.ref = "androidxCollection" }
 atomicfu = { module = "org.jetbrains.kotlinx:atomicfu", version.ref = "atomicfu" }
 kotlinx-benchmark-runtime = { module = "org.jetbrains.kotlinx:kotlinx-benchmark-runtime", version.ref = "kotlinxBenchmarkRuntime" }
-okio = { module = "com.squareup.okio:okio", version.ref = "okio" }
 roaringbitmap = { module = "org.roaringbitmap:RoaringBitmap", version.ref = "roaringbitmap" }
 stately-concurrency = { module = "co.touchlab:stately-concurrency", version.ref = "statelyConcurrency" }
-koin-test = { module = "io.insert-koin:koin-test", version.ref = "koin" }
-junit-jupiter = { group = "org.junit.jupiter", name = "junit-jupiter", version.ref = "junitJupiter" }
-kodein-di = { module = "org.kodein.di:kodein-di", version.ref = "kodein" }