path: root/README.md

# Fabric Example Mod - Kotlin

## Setup

0. Create a new mod repository by pressing the "Use this template" button and clone the created repository.

1. Edit build.gradle and mod.json to suit your needs.
    * The "mixins" object can be removed from mod.json if you do not need to use mixins.
    * Please replace all occurences of "modid" with your own mod ID - sometimes, a different string may also suffice.
2. Run the following command:

```
./gradlew idea
```

## License

This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.