Skip to content

Commit 369b71f

Browse files
authored
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
1 parent ebe5a79 commit 369b71f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+677
-304
lines changed

README.md

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,53 @@
1-
# Godot Kotlin JVM
2-
3-
# Kotlin/JVM binding for the Godot Game Engine
1+
# Godot Kotlin/JVM
2+
## Kotlin/JVM binding for the Godot Game Engine
43

54
<p align="center">
65
<img src=".README/logo.png" width="30%" height="30%">
76
</p>
87

98
## Overview
109

11-
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.
1326

1427
[![GitHub](https://img.shields.io/github/license/utopia-rise/godot-kotlin-jvm?style=flat-square)](LICENSE)
1528

16-
## Important notes
29+
## Important Notes
1730

18-
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!
1934

2035
## Documentation
21-
The documentation can be found [here](https://godot-kotl.in)
2236

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
2441

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.
2644

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.
2947

3048
## 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.
52+
3353
[![jblogo](.README/jetbrains.svg)](https://www.jetbrains.com/)

docs/mkdocs.yml

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,26 @@ theme:
88
name: material
99
favicon: assets/img/favicon.ico
1010
palette:
11-
- scheme: default
11+
- media: "(prefers-color-scheme)"
12+
primary: deep purple
1213
toggle:
13-
icon: material/toggle-switch-off-outline
14+
icon: material/brightness-auto
15+
name: Switch to light mode
16+
- media: "(prefers-color-scheme: light)"
17+
scheme: default
18+
primary: deep purple
19+
toggle:
20+
icon: material/brightness-7
1421
name: Switch to dark mode
15-
- scheme: slate
22+
- media: "(prefers-color-scheme: dark)"
23+
scheme: slate
24+
primary: deep purple
1625
toggle:
17-
icon: material/toggle-switch
18-
name: Switch to light mode
26+
icon: material/brightness-4
27+
name: Switch to system preference
1928
logo: assets/img/logo.png
29+
font:
30+
code: JetBrains Mono
2031
features:
2132
- navigation.tabs
2233
- navigation.expand
@@ -35,6 +46,7 @@ markdown_extensions:
3546
- pymdownx.highlight
3647
- pymdownx.superfences
3748
- pymdownx.tabbed
49+
- pymdownx.details
3850
- admonition
3951
- meta
4052

@@ -46,10 +58,10 @@ extra_css:
4658

4759
nav:
4860
- Home: index.md
49-
- Getting started:
61+
- Getting Started:
5062
- Requirements: getting-started/requirements.md
51-
- Setting up: getting-started/setting-up.md
52-
- Your first class: getting-started/your-first-class.md
63+
- Setting-up: getting-started/setting-up.md
64+
- Your first Kotlin class: getting-started/your-first-class.md
5365
- User guide:
5466
- API differences: user-guide/api-differences.md
5567
- Classes: user-guide/classes.md
@@ -63,13 +75,13 @@ nav:
6375
- Versioning: user-guide/versioning.md
6476
- Supported platforms: user-guide/supported-platforms.md
6577
- Advanced:
66-
- Abstract Classes: user-guide/advanced/abstract_classes.md
67-
- Custom src dirs: user-guide/advanced/custom-src-dirs.md
68-
- Custom gradle wrapper path: user-guide/advanced/custom_gradle_wrapper_path.md
78+
- Abstract classes: user-guide/advanced/abstract-classes.md
79+
- Custom source directories: user-guide/advanced/custom-src-dirs.md
80+
- Custom gradle wrapper path: user-guide/advanced/custom-gradle-wrapper-path.md
6981
- Gradle plugin configuration: user-guide/advanced/gradle-plugin-configuration.md
70-
- Commandline args: user-guide/advanced/commandline-args.md
82+
- Command-line arguments: user-guide/advanced/commandline-args.md
7183
- Kotlin singletons: user-guide/advanced/kotlin-singleton.md
72-
- GraalVM native-image: user-guide/advanced/graal-vm-native-image.md
84+
- GraalVM Native Image: user-guide/advanced/graal-vm-native-image.md
7385
- Develop libraries:
7486
- Introduction: develop-libraries/introduction.md
7587
- Setup: develop-libraries/setup.md
@@ -79,9 +91,9 @@ nav:
7991
- Guidelines: contribution/guidelines.md
8092
- Setup: contribution/setup.md
8193
- Build with C# support: contribution/build-with-csharp-support.md
82-
- Support for other jvm based languages: contribution/support_for_other_jvm_based_languages.md
94+
- Support for other JVM-based languages: contribution/support-for-other-jvm-based-languages.md
8395
- Knowledge base:
8496
- Artefact differentiation: contribution/knowledge-base/artefact-differentiation.md
8597
- Entry generation: contribution/knowledge-base/entry-generation.md
8698
- Shared buffer: contribution/knowledge-base/shared-buffer.md
87-
- Memory Management: contribution/knowledge-base/memory-management.md
99+
- Memory management: contribution/knowledge-base/memory-management.md
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/src/doc/assets/img/wizard_1.png

-26.6 KB
Binary file not shown.

0 commit comments

Comments
 (0)