0.1.0

Author: radstevee

docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axi-docs",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "Documentation for axi",
   "scripts": {
     "dev": "vitepress dev",

docs/src/core-apis/ecs.md

@@ -96,3 +96,32 @@ we can:
 - Get the component, or put it if it does not exist
 - Set the component
 - Obtain a delegating property to the component
+
+## Creating a system
+
+To create a system, you will need to implement the `System`
+interface and provide component archetypes this system filters:
+
+```kt
+object ExampleSystem : System {
+  override val archetypes: Sequence<KClass<out Any>> = sequenceOf(Position::class)
+  
+  override suspend fun tick(tick: Int, attachable: Attachable) {
+    // This will not be null because of our [archetypes] filter.
+    val position = attachable.get<Position>()!!
+    println("Attachable ${attachable.identity} is at position $position!")
+  }
+}
+```
+
+Now, we can start and stop ticking this system using the
+`System#start` and `System#stop` functions:
+
+```kt
+class ExamplePlugin : AxiPlugin() {
+  override suspend fun enable() {
+    // ...
+    ExampleSystem.start()
+  }
+}
+```

docs/src/getting-started/examples.md

@@ -1,4 +1,3 @@
 # Examples
 
-For an example, see 🔗 [**axi-example
-**](https://github.com/radstevee/axi/tree/master/example)
+For an example, see 🔗 [**axi-example**](https://github.com/radstevee/axi/tree/master/example).

docs/src/getting-started/quickstart.md

@@ -45,7 +45,7 @@ plugins {
 }
 
 dependencies {
-  axi.modules("core")
+  axi.modules("core") // [!code focus]
 }
 ```
 :::
@@ -83,7 +83,7 @@ And of course don't forget to add your `plugin.yml`:
 
 ```yml
 name: my-plugin
-version: 0.0.0
+version: 0.1.0
 api-version: 1.21.4
 main: my.axi.plugin.MyPlugin
 ```
@@ -96,9 +96,9 @@ If you need a dependency in your plugin, you can use paper's
 library loading feature by adding the dependency using the
 `axi.runtime` function:
 
-```kt
+```kts
 dependencies {
-  axi.runtime("...")
+  axi.runtime("...") // [!code focus]
 }
 ```
 

docs/src/ui/installation.md

@@ -1,25 +1,14 @@
 # Installation
 
-To install the UI module, you need to add it to your dependencies:
+To install the UI module, simply add it to your `dependencies`
+block in your buildscript:
 
 ::: code-group
-
-```kts{4} [build.gradle.kts]
-dependencies {
-  implementation(platform("net.radstevee.axi:axi-bom:VERSION"))
-  implementation("net.radstevee.axi:axi-core")
-  implementation("net.radstevee.axi:axi-ui")
-}
-```
-
-```groovy{4} [build.gradle]
+```kts [build.gradle.kts]
 dependencies {
-  implementation platform('net.radstevee.axi:axi-bom:VERSION')
-  implementation 'net.radstevee.axi:axi-core'
-  implementation 'net.radstevee.axi:axi-ui'
+  axi.modules("core", "ui") // [!code focus]
 }
 ```
-
 :::
 
 And now it is installed and will automatically be loaded!

example/build.gradle.kts

@@ -6,7 +6,7 @@ plugins {
 }
 
 group = "net.radstevee.axi.example"
-version = "0.0.0"
+version = rootProject.version
 
 dependencies {
   // We're not using the axi plugin here because

example/src/main/resources/plugin.yml

@@ -1,4 +1,4 @@
 name: axi-example
-version: 0.0.0
+version: 0.1.0
 main: net.radstevee.axi.example.ExampleAxiPlugin
 api-version: 1.21.4

gradle-plugin/gradle.properties

@@ -6,4 +6,4 @@ org.gradle.configuration-cache=true
 org.gradle.parallel=true
 org.gradle.vfs.watch=false
 
-version=0.0.0-SNAPSHOT
+version=0.1.0

gradle.properties

@@ -7,4 +7,4 @@ org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
 org.gradle.parallel=true
 org.gradle.vfs.watch=false
 
-version=0.0.0-SNAPSHOT
+version=0.1.0