Better query syntax, observers, performance improvements

.github/workflows/gradle-ci.yml

@@ -22,7 +22,7 @@ jobs:
         uses: actions/setup-java@v3
         with:
           distribution: temurin
-          java-version: 17
+          java-version: 21
           cache: gradle
 
       - name: Build

.github/workflows/publish-packages.yml

@@ -13,28 +13,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
-      - uses: MineInAbyss/publish-action@master
+      - uses: MineInAbyss/publish-action@develop
         with:
           maven-metadata-url: https://repo.mineinabyss.com/releases/com/mineinabyss/geary-core/maven-metadata.xml
           maven-snapshot-metadata-url: https://repo.mineinabyss.com/snapshots/com/mineinabyss/geary-core/maven-metadata.xml
-          # pages-path: build/dokka/htmlMultiModule/
-          # dokka: dokkaHtmlMultiModule
           maven-username: ${{ secrets.MAVEN_PUBLISH_USERNAME }}
           maven-password: ${{ secrets.MAVEN_PUBLISH_PASSWORD }}
-
-  # deploy:
-  #   permissions:
-  #     pages: write
-  #     id-token: write
-  #   environment:
-  #     name: github-pages
-  #     url: ${{ steps.deployment.outputs.page_url }}
-  #   if: ${{ github.ref == 'refs/heads/master' }}
-  #   runs-on: ubuntu-latest
-  #   needs: build
-  #   steps:
-  #     - name: Deploy to GitHub Pages
-  #       id: deployment
-  #       uses: actions/deploy-pages@v2

.gitignore

@@ -4,6 +4,7 @@ build
 target
 out
 */out/production/
+.kotlin
 
 .classpath
 .project
@@ -12,3 +13,5 @@ eclipse
 *.ipr
 *.iws
 kotlin-js-store/
+
+geary-benchmarks/.results

README.md

@@ -1,62 +1,65 @@
 <div align="center">
 
 # Geary
-[![Java CI with Gradle](https://github.com/MineInAbyss/Geary/actions/workflows/gradle-ci.yml/badge.svg)](https://github.com/MineInAbyss/Geary/actions/workflows/gradle-ci.yml)
-[![Package](https://img.shields.io/maven-metadata/v?metadataUrl=https://repo.mineinabyss.com/releases/com/mineinabyss/geary-core/maven-metadata.xml)](https://repo.mineinabyss.com/#/releases/com/mineinabyss/geary-core)
+[![Package](https://img.shields.io/maven-metadata/v?metadataUrl=https://repo.mineinabyss.com/releases/com/mineinabyss/geary-core/maven-metadata.xml&color=light_green)](https://repo.mineinabyss.com/#/releases/com/mineinabyss/geary-core)
+[![Package](https://img.shields.io/maven-metadata/v?metadataUrl=https://repo.mineinabyss.com/snapshots/com/mineinabyss/geary-core/maven-metadata.xml&label=prerelease)](https://repo.mineinabyss.com/#/snapshots/com/mineinabyss/geary-core)
 [![Wiki](https://img.shields.io/badge/-Project%20Wiki-blueviolet?logo=Wikipedia&labelColor=gray)](https://wiki.mineinabyss.com/geary)
 [![Contribute](https://shields.io/badge/Contribute-e57be5?logo=github%20sponsors&style=flat&logoColor=white)](https://wiki.mineinabyss.com/contribute)
 </div>
 
 ## Overview
 
-Geary is an Entity Component System (ECS) written in Kotlin. The engine design is inspired by [flecs](https://github.com/SanderMertens/flecs). Core parts of the engine (ex. system iteration, entity creation) are quite optimized, with the main exception being our event system. We use Geary internally for our Minecraft plugins, see [geary-papermc](https://github.com/MineInAbyss/geary-papermc) for more info.
+Geary is an Entity Component System (ECS) written in Kotlin. The engine design is inspired by [flecs](https://github.com/SanderMertens/flecs). Core parts of the engine like system iteration and entity creation are quite optimized, the main exception being our observer system. We use Geary internally for our Minecraft plugins, see [geary-papermc](https://github.com/MineInAbyss/geary-papermc) for more info.
 
 ## Features
+- Archetype based engine optimized for many entities with similar components
+- Type safe systems, queries, and event listeners
 - Null safe component access
 - Flecs-style entity relationships `alice.addRelation<FriendsWith>(bob)`
-- Fully type safe system definition
+- Observers for listening to component changes and custom events
 - Prefabs that reuse components across entities
 - Persistent components and loading prefabs from files thanks to [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization/)
 - Addon system to use only what you need
 
-## Example
+## Usage
+
+Read our [Quickstart guide](https://wiki.mineinabyss.com/geary/quickstart/) to see Geary in action, here's an excerpt, a simple velocity system:
+
 
-A simple ssytem that iterates over all entities with a position and velocity, updating the position every engine tick.
 ```kotlin
 data class Position(var x: Double, var y: Double)
 data class Velocity(var x: Double, var y: Double)
 
-class UpdatePositionSystem : TickingSystem(interval = 20.milliseconds) {
-    // Specify all components we want (Geary also supports branched AND/OR/NOT statements for selection)
-    val Pointer.position by get<Position>()
-    val Pointer.velocity by get<Velocity>()
-
-    override fun Pointer.tick() {
+fun GearyModule.updatePositionSystem() = system(query<Position, Velocity>())
+    .every(interval = 20.milliseconds)
+    .exec { (position, velocity) ->
         // We can access our components like regular variables!
         position.x += velocity.x
         position.y += velocity.y
     }
-}
+
 
 fun main() {
     // Set up geary
     geary(ArchetypeEngineModule) {
-        // configure engine here
+        // example engine configuration
         install(Prefabs)
     }
 
-    geary.pipeline.addSystem(UpdatePositionSystem())
+    val posSystem = geary.updatePositionSystem()
 
     // 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
+    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 }
 }
 
 ```
-## Usage
-
-A WIP wiki can be found at [wiki.mineinabyss.com](https://wiki.mineinabyss.com/geary/)
 
 ### Gradle
 ```kotlin
@@ -76,5 +79,4 @@ dependencies {
 As the project matures, our primary goal is to make it useful to more people. Here are a handful of features we hope to achieve:
 - Multiplatform support, with js, jvm, and native targets
 - Publish numbers for benchmarks and cover more parts of the engine with them
-- Component data migrations
-- Complex queries (including relations like parent/child)
+- Relation queries, ex. entities with a parent that has X component.

addons/geary-autoscan/build.gradle.kts

@@ -5,8 +5,8 @@ plugins {
 }
 
 dependencies {
-    compileOnly(project(":geary-core"))
-    compileOnly(project(":geary-serialization"))
+    implementation(project(":geary-core"))
+    implementation(project(":geary-serialization"))
 
     implementation(idofrontLibs.reflections)
     implementation(idofrontLibs.kotlin.reflect)

addons/geary-autoscan/src/main/kotlin/com/mineinabyss/geary/autoscan/AutoScanner.kt

@@ -4,31 +4,28 @@ import co.touchlab.kermit.Severity
 import com.mineinabyss.geary.addons.GearyPhase
 import com.mineinabyss.geary.addons.dsl.GearyAddonWithDefault
 import com.mineinabyss.geary.modules.geary
-import com.mineinabyss.geary.systems.System
 import com.mineinabyss.idofront.di.DI
 import kotlin.reflect.KClass
-import kotlin.reflect.full.createInstance
+import kotlin.reflect.KFunction
 
 val autoScanner by DI.observe<AutoScanner>()
 
 interface AutoScanner {
     val scannedComponents: MutableSet<KClass<*>>
-    val scannedSystems: MutableSet<KClass<*>>
+    val scannedSystems: MutableSet<KFunction<*>>
 
     fun installSystems()
 
     companion object Addon : GearyAddonWithDefault<AutoScanner> {
         override fun default() = object : AutoScanner {
             private val logger get() = geary.logger
             override val scannedComponents = mutableSetOf<KClass<*>>()
-            override val scannedSystems = mutableSetOf<KClass<*>>()
+            override val scannedSystems = mutableSetOf<KFunction<*>>()
 
             override fun installSystems() {
                 scannedSystems.asSequence()
-                    .mapNotNull { it.objectInstance ?: runCatching { it.createInstance() }.getOrNull() }
-                    .filterIsInstance<System>()
-                    .onEach { geary.pipeline.addSystem(it) }
-                    .map { it::class.simpleName }
+                    .onEach { it.call(geary) }
+                    .map { it.name }
                     .let {
                         if (logger.config.minSeverity <= Severity.Verbose)
                             logger.i("Autoscan loaded singleton systems: ${it.joinToString()}")

addons/geary-autoscan/src/main/kotlin/com/mineinabyss/geary/autoscan/AutoScannerDSL.kt

@@ -4,9 +4,9 @@ import co.touchlab.kermit.Severity
 import com.mineinabyss.geary.addons.dsl.GearyDSL
 import com.mineinabyss.geary.datatypes.Component
 import com.mineinabyss.geary.modules.GearyConfiguration
+import com.mineinabyss.geary.modules.GearyModule
 import com.mineinabyss.geary.modules.geary
 import com.mineinabyss.geary.serialization.dsl.serialization
-import com.mineinabyss.geary.systems.System
 import kotlinx.serialization.*
 import kotlinx.serialization.modules.polymorphic
 import org.reflections.Reflections
@@ -15,7 +15,8 @@ import org.reflections.util.ConfigurationBuilder
 import org.reflections.util.FilterBuilder
 import kotlin.reflect.KClass
 import kotlin.reflect.full.hasAnnotation
-import kotlin.reflect.full.isSubclassOf
+import kotlin.reflect.jvm.kotlinFunction
+import kotlin.reflect.typeOf
 
 @GearyDSL
 fun GearyConfiguration.autoscan(
@@ -37,6 +38,7 @@ class AutoScannerDSL(
             ConfigurationBuilder()
                 .apply { limitTo.forEach { forPackage(it, classLoader) } }
                 .filterInputsBy(FilterBuilder().apply { limitTo.forEach { includePackage(it) } })
+                .setScanners(Scanners.SubTypes, Scanners.TypesAnnotated, Scanners.MethodsAnnotated)
         )
     }
 
@@ -96,10 +98,9 @@ class AutoScannerDSL(
      */
     fun systems() {
         val scanned = reflections
-            .get(Scanners.TypesAnnotated.with(AutoScan::class.java).asClass<Class<*>>(classLoader))
-            .asSequence()
-            .map { it.kotlin }
-            .filter { !it.hasAnnotation<ExcludeAutoScan>() && it.isSubclassOf(System::class) }
+            .get(Scanners.MethodsAnnotated.with(AutoScan::class.java))
+            .mapNotNull { reflections.forMethod(it, classLoader)?.kotlinFunction }
+            .filter { it.parameters.singleOrNull()?.type == typeOf<GearyModule>() }
 
         autoScanner.scannedSystems += scanned
     }

addons/geary-autoscan/src/main/kotlin/com/mineinabyss/geary/autoscan/AutoscanAnnotations.kt

@@ -1,8 +1,7 @@
 package com.mineinabyss.geary.autoscan
 
+import com.mineinabyss.geary.observers.Observer
 import com.mineinabyss.geary.systems.GearySystem
-import com.mineinabyss.geary.systems.Listener
-import com.mineinabyss.geary.systems.RepeatingSystem
 import com.mineinabyss.geary.systems.query.GearyQuery
 
 /**
@@ -12,7 +11,7 @@ import com.mineinabyss.geary.systems.query.GearyQuery
 annotation class ExcludeAutoScan
 
 /**
- * Indicates this [GearySystem], such as [RepeatingSystem], [Listener], or [GearyQuery] be registered automatically
+ * Indicates this [GearySystem], such as [RepeatingSystem], [Observer], or [GearyQuery] be registered automatically
  * on startup by the AutoScanner.
  */
 annotation class AutoScan

addons/geary-prefabs/build.gradle.kts

@@ -5,19 +5,13 @@ plugins {
 }
 
 kotlin {
-    targets {
-
-    }
     sourceSets {
         val commonMain by getting {
             dependencies {
-                compileOnly(libs.okio)
-                compileOnly(libs.uuid)
-                compileOnly(idofrontLibs.kotlinx.serialization.json)
-                compileOnly(idofrontLibs.kotlinx.serialization.cbor)
+                implementation(project(":geary-core"))
+                implementation(project(":geary-serialization"))
 
-                compileOnly(project(":geary-core"))
-                compileOnly(project(":geary-serialization"))
+                implementation(libs.uuid)
                 implementation(idofrontLibs.idofront.di)
             }
         }