You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# GodotInk
|
|
|
|
An [ink](https://github.com/inkle/ink) integration for [Godot Engine 4](https://github.com/godotengine/godot).
|
|
|
|
If you use and like this project, please consider buying me a coffee.
|
|
[](https://ko-fi.com/E1E53SKZF)
|
|
|
|
## Usage
|
|
|
|
You'll find a quick-start guide, and the general documentation on the project's
|
|
[wiki](https://github.com/paulloz/godot-ink/wiki).
|
|
|
|
### Installation
|
|
|
|
The following instructions assume that you have a working Godot and .NET installation. If not, please refer to the
|
|
official [engine documentation](https://docs.godotengine.org/).
|
|
|
|
1. [Download](https://github.com/paulloz/godot-ink/releases/latest) and extract the code at the root of your project.
|
|
You should see a new `addons/GodotInk/` folder in your project's directory.
|
|
|
|
1. Add the following line in your `.csproj` file (before the closing `</Project>` tag).
|
|
```xml
|
|
<Import Project="addons\GodotInk\GodotInk.props" />
|
|
```
|
|
If you don't have a `.csproj` file, click the **Create C# Solution** button in the editor's
|
|
**Project/Tools** menu.
|
|
|
|
1. Build your project once.
|
|
|
|
1. Enable **GodotInk** in your project settings.
|
|
|
|
## License
|
|
|
|
*GodotInk* is released under MIT license (see the [LICENSE](/LICENSE) file for more information).
|