You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improving Documentation: Fixing Name Convetions and Formatting (#576)
* Small title nitpick fixes and using JetBrains MonoSpace code font
* Small grammar fixes and improvements
* fix entry gen entries
* standardize file names using kebab case
* fix name casing
* fix link in index page
* revamps 'settin-up' page
* switch to kotlin-ish theme color
This is a **Kotlin** language binding for the [**Godot**](https://godotengine.org/) game engine. It is built as a module (like the C# binding) to interact with **Godot**'s core internally. The binding provides you Godot API's as Kotlin classes, so you can write your game logic completely in Kotlin. Your code will be compiled into a .jar which is then executed by an embedded JVM, so you don't have to worry that your users have Java installed. It's already embedded in your game executable.
12
-
You also don't have to worry about any binding logic. Just write your game scripts like you would for [GDScript](https://docs.godotengine.org/en/3.1/getting_started/scripting/gdscript/gdscript_basics.html) or [C#](https://docs.godotengine.org/en/3.1/getting_started/scripting/c_sharp/) but with all the syntactic sugar of Kotlin.
10
+
This is a [**Kotlin**](https://kotlinlang.org) language binding for the [**Godot**](https://godotengine.org/) game engine.
11
+
It is built as a module (like the C# binding) to interact with **Godot**'s core internally.
12
+
13
+
The binding provides you Godot API's as [Kotlin classes](https://godot-kotl.in/en/stable/getting-started/your-first-class/),
14
+
so you can write your game logic completely in Kotlin.
15
+
16
+
### Code Distribution
17
+
18
+
There are two methods for distributing JVM bytecode produced by the Kotlin compiler:
19
+
20
+
1. A classic JAR file: your code will be packed into a `.jar` file, which is then executed by an embedded JVM.
21
+
So the developer does not have to worry about their user installing a JRE. The JVM is already embedded in your game executable.
22
+
2. Dynamic Library using GraalVM Native Image: please read more about this in our [documentation page](https://godot-kotl.in/en/stable/user-guide/advanced/graal-vm-native-image/).
23
+
24
+
Just write your game scripts like you would for [GDScript](https://docs.godotengine.org/en/4.2/getting_started/scripting/gdscript/gdscript_basics.html)
25
+
or for [C#](https://docs.godotengine.org/en/3.1/getting_started/scripting/c_sharp/) but with all the syntactic sugar of Kotlin.
This version of the binding is currently **Alpha**!
31
+
This version of the binding is currently **Alpha**! This means that the bindings are not
32
+
production-ready. However, if you are curious in using Kotlin in Godot, this is a good opportunity
33
+
to help us in improving the project!
19
34
20
35
## Documentation
21
-
The documentation can be found [here](https://godot-kotl.in)
22
36
23
-
## Developer discussion
37
+
The documentation can be found [here](https://godot-kotl.in). It's a work in progress, and we would love your input to
38
+
make it even better!
39
+
40
+
## Developer Discussion & Contribution
24
41
25
-
Ask questions and collaborate on [Discord](https://discord.gg/zpb5Ru7v9x)
42
+
Join us on our [Discord](https://discord.gg/zpb5Ru7v9x) server to ask questions and work together
43
+
with a friendly community.
26
44
27
-
## Contribution
28
-
If you want to contribute to the project, please read through the contribution guidlines and getting started sections [here](https://godot-kotl.in/en/stable/contribution/guidelines/)
45
+
If you want to contribute to the project, please read through the [contribution guidelines](https://godot-kotl.in/en/stable/contribution/guidelines/)
46
+
and the [setup](https://godot-kotl.in/en/stable/contribution/setup/) sections.
29
47
30
48
## Partners
31
-
Jetbrains is helping us to develop this project by providing development tools to maintainers.
32
-
Intellij IDEA is our IDE of choice for Kotlin development and we strongly recommend using it.
49
+
50
+
JetBrains is helping us to develop this project by providing development tools to maintainers.
51
+
Intellij IDEA is our IDE of choice for Kotlin development and we strongly recommend using it.
0 commit comments