Skip to content

Commit a4c5385

Browse files
committed
Update doc with example projects
1 parent 2041444 commit a4c5385

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ It is built as a module (like the C# binding) to interact with **Godot**'s core
1313
The binding provides you Godot API's as [Kotlin classes](https://godot-kotl.in/en/stable/getting-started/your-first-class/),
1414
so you can write your game logic completely in Kotlin.
1515

16+
You can find project examples in those repositories:
17+
18+
- [Minimal project template](https://github.com/utopia-rise/godot-kotlin-project-template)
19+
- [GDQuest 3D demo converted to Kotlin](https://github.com/utopia-rise/godot-kotlin-3d-demo)
20+
21+
1622
### Code Distribution
1723

1824
There are two methods for distributing JVM bytecode produced by the Kotlin compiler:

docs/src/doc/getting-started/setting-up.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,10 @@ and paste the following content:
119119
The snippet above uses our Gradle plugin. Without the plugin, the user has to manually define all needed
120120
dependencies, manually register the classes, signals, properties, functions and manually create and copy
121121
the needed JAR's to the appropriate locations.
122+
123+
## Examples
124+
125+
If you want to examples of what a JVM Godot project looks like, you can check the following repositories:
126+
127+
- [Minimal project template](https://github.com/utopia-rise/godot-kotlin-project-template)
128+
- [GDQuest 3D demo converted to Kotlin](https://github.com/utopia-rise/godot-kotlin-3d-demo)

docs/src/doc/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ If you are looking for the documentation for Godot Kotlin/Native; you can find i
1414

1515
This project is in alpha, it is by no means production ready.
1616

17+
## Project templates and demos
18+
19+
- [Minimal project template](https://github.com/utopia-rise/godot-kotlin-project-template)
20+
- [GDQuest 3D demo converted to Kotlin](https://github.com/utopia-rise/godot-kotlin-3d-demo)
21+
1722
### What's not working
1823

1924
The items in this list are explicitly mentioned here as these will be implemented in future versions.

0 commit comments

Comments
 (0)