CONTRIBUTING.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# How to Contribute

This tutorial explains how to set up a development environment to work on SkyHanni. We use [IntelliJ](https://www.jetbrains.com/idea/) as an example.

## Basics
SkyHanni is a 1.8.9 Forge mod, written in [Kotlin](https://kotlinlang.org/) and [Java](https://www.java.com/en/).
We use a [gradle config](https://gradle.org/) to build the mod, 
written in [Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html).

This development environment uses [DevAuth](https://github.com/DJtheRedstoner/DevAuth) to allow connecting to Hypixel while debugging in IntelliJ.

## Setup

### Download IntelliJ
- Download IntelliJ from [JetBrains Website](https://www.jetbrains.com/idea/download/).
- Use Community Edition.
- ![image](https://github.com/hannibal002/SkyHanni/assets/24389977/68b9044c-42d0-44ba-85f7-9848a35a27b2)

In Progress - more later