Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mineinabyss/geary
ECS framework made for Kotlin
https://github.com/mineinabyss/geary
ecs entity-component-system kotlinx-serialization minecraft spigot
Last synced: 7 days ago
JSON representation
ECS framework made for Kotlin
- Host: GitHub
- URL: https://github.com/mineinabyss/geary
- Owner: MineInAbyss
- License: mit
- Created: 2020-10-21T17:05:13.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T21:47:25.000Z (about 2 months ago)
- Last Synced: 2024-10-29T23:47:46.057Z (about 2 months ago)
- Topics: ecs, entity-component-system, kotlinx-serialization, minecraft, spigot
- Language: Kotlin
- Homepage: https://docs.mineinabyss.com/geary/
- Size: 2.12 MB
- Stars: 49
- Watchers: 5
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Geary
[](https://repo.mineinabyss.com/#/releases/com/mineinabyss/geary-core)
[](https://repo.mineinabyss.com/#/snapshots/com/mineinabyss/geary-core)
[](https://docs.mineinabyss.com/geary)
[](https://docs.mineinabyss.com/contribute)
## 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 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(bob)`
- 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
## Usage
Read our [Quickstart guide](https://docs.mineinabyss.com/geary/quickstart/) to see Geary in action, here's an excerpt, a simple velocity system:
```kotlin
data class Position(var x: Double, var y: Double)
data class Velocity(var x: Double, var y: Double)
fun Geary.updatePositionSystem() = system(query())
.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) {
// example engine configuration
install(Prefabs)
}
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 = posSystem.map { (pos) -> pos }
}
```
### Gradle
```kotlin
repositories {
maven("https://repo.mineinabyss.com/releases")
}
dependencies {
val gearyVersion = "x.y.z"
implementation("com.mineinabyss:geary-core:$gearyVersion")
implementation("com.mineinabyss:geary-:$gearyVersion")
}
```
### Version catalog entries
```toml
[versions]
geary = "x.y.z"
[libraries]
geary-core = { module = "com.mineinabyss:geary-autoscan", version.ref = "geary" }
geary-actions = { module = "com.mineinabyss:geary-actions", version.ref = "geary" }
geary-autoscan = { module = "com.mineinabyss:geary-autoscan", version.ref = "geary" }
geary-prefabs = { module = "com.mineinabyss:geary-prefabs", version.ref = "geary" }
geary-serialization = { module = "com.mineinabyss:geary-serialization", version.ref = "geary" }
geary-uuid = { module = "com.mineinabyss:geary-uuid", version.ref = "geary" }
```
## Roadmap
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
- Relation queries, ex. entities with a parent that has X component.