Skip to content

Latest commit

 

History

History
184 lines (134 loc) · 8.87 KB

CONTRIBUTING.md

File metadata and controls

184 lines (134 loc) · 8.87 KB

How to Contribute

This is a technical guide that helps Kotlin and Java developers understand how SkyHanni works, and provides the first steps for new Forge developers to take.

Development Environment Setup

When making changes to the code, it is recommended to use an IDE for live debugging and testing. This tutorial explains how to set up the development environment for SkyHanni. We use IntelliJ as an example.

Download IntelliJ

  • Download IntelliJ from the JetBrains Website.
    • Use the Community Edition. (Scroll down a bit.)

Cloning the project

  • Create an account on GitHub
    • Go to https://github.com/hannibal002/SkyHanni
    • Click on the fork button to create a fork.
      • Leave the settings unchanged
      • Click on create fork
    • Open IntelliJ
      • Link the GitHub account with IntelliJ.
      • Install Git in IntelliJ.
      • In IntelliJ, go to new → project from version control.
      • Select SkyHanni from the list.
      • Open the project.

Setting up IntelliJ

SkyHanni's Gradle configuration is very similar to the one used in NotEnoughUpdates, just follow their guide.

Creating a Pull Request

If you are not very familiar with git, you might want to try this out: https://learngitbranching.js.org/.

_An explanation how to use intellij and branches will follow here soon.

Please use a prefix for the name of the PR (E.g. Feature, Fix, Backend, Change).

You can write in the description of the pr the wording for the changelog as well (optional).

If your PR relies on another PR, please include this information at the beginning of the description. Consider using a format like "- #821" to illustrate the dependency.

Coding Styles and Conventions

  • Follow the Hypixel Rules.
  • Use the coding conventions for Kotlin and Java.
  • Do not copy features from other mods. Exceptions:
    • Mods that are paid to use.
    • Mods that have reached their end of life. (Rip SBA, Dulkir and Soopy).
      • The mod has, according to Hypixel rules, illegal features ("cheat mod/client").
      • If you can improve the existing feature in a meaningful way.
  • All new classes should be written in Kotlin, with a few exceptions:
    • Config files in at.hannibal2.skyhanni.config.features
    • Mixin classes in at.hannibal2.skyhanni.mixins.transformers
  • New features should be made in Kotlin objects unless there is a specific reason for it not to.
    • If the feature needs to use forge events or a repo pattern, annotate it with @SkyHanniModule
    • This will automatically register it to the forge event bus and load the repo patterns
  • Avoid using deprecated functions.
    • These functions are marked for removal in future versions.
    • If you're unsure why a function is deprecated or how to replace it, please ask for guidance.
  • Future JSON data objects should be made in kotlin and placed in the directory at.hannibal2.skyhanni.data.jsonobjects
    • Config files should still be made in Java.
  • Please use the existing event system, or expand on it. Do not use Forge events.
    • (We inject the calls with Mixin)
  • Please use existing utils methods.
  • We try to avoid calling the NEU code too often.
    • (We plan to remove NEU as a dependency in the future.)
  • We try not to use Forge-specific methods if possible.
    • (We plan to switch to Fabric and Minecraft 1.20 in the future.)
  • Please try to avoid using System.currentTimeMillis(). Use our own class SimpleTimeMark instead.
  • Try to avoid using Kotlin's !! (catch if not null) feature.
    • Replace it with ?: (if null return this).
    • This will most likely not be possible to avoid when working with objects from java.
  • Don't forget to add @FeatureToggle to new standalone features (not options to that feature) in the config.
  • Do not use e.printStackTrace(), use CopyErrorCommand.logError(e, "explanation for users") instead.
  • Do not use MinecraftForge.EVENT_BUS.post(event), use event.postAndCatch() instead.
  • Do not use toRegex() or toPattern(), use RepoPattern instead.
    • See RepoPattern.kt for more information and usages.
    • The pattern variables are named in the scheme variableNamePattern
  • Please use Regex instead of String comparison when it is likely Hypixel will change the message in the future.
  • Do not use fixedRateTimer when possible and instead use SecondPassedEvent to safely execute the repeating event on the main thread.

Software Used in SkyHanni

Basics

SkyHanni is a Forge mod for Minecraft 1.8.9, written in Kotlin and Java.

We use a Gradle configuration to build the mod, written in Kotlin DSL: build.gradle.kts

This start script will automatically download all required libraries.

NotEnoughUpdates

SkyHanni requires NEU. We use NEU to get auction house and bazaar price data for items and to read the NEU Item Repo for item internal names, display names and recipes.

For more information, see https://github.com/NotEnoughUpdates/NotEnoughUpdates

Config

SkyHanni stores the config (settings and user data) as a json object in a single text file. For rendering the /sh config (categories, toggles, search, etc.), SkyHanni uses MoulConfig, the same config system as NotEnoughUpdates.

For more information, see https://github.com/NotEnoughUpdates/MoulConfig

Elite Farmers API

SkyHanni utilizes the Elite API (view the public site here) for some farming features.

This includes features relating to Farming Weight, as well as syncing jacob contests amongst players for convenience. All data sent is anonymized and opt-in.

Mixin

A system to inject code into the original Minecraft code. This library is not part of SkyHanni or Forge, but we bundle it.

It allows to easily modify methods in Minecraft itself, without conflicting with other mods.

For more information, see https://github.com/SpongePowered/Mixin or our existing mixins.

When creating new Mixins, try to keep the code inside the mixin as small as possible, and calling a hook as soon as possible.

Repo

SkyHanni uses a repo system to easily change static variables without the need for a mod update. The repo is located at https://github.com/hannibal002/SkyHanni-REPO. A copy of all json files is stored on the computer under .minecraft\config\skyhanni\repo. On every game start, the copy gets updated (if outdated and if not manually disabled). If you add stuff to the repo make sure it gets serialised. See the jsonobjects folder for how to properly do this. You also may have to disable repo auto update in game.

Discord IPC

DiscordIPC is a service that SkyHanni uses to send information from SkyBlock to Discord in Rich Presence.
For info on usage, look at DiscordRPCManager.kt

Auto Updater

We use the auto update library from nea89.

Additional Useful Development Tools

DevAuth

DevAuth is a tool that allows logging in to a Minecraft account while debugging in IntelliJ. This is very useful for coding live on Hypixel without the need to compile a jar.

  • The library is already downloaded by Gradle.
  • SkyHanni will automatically set up DevAuth.
  • Start Minecraft inside IntelliJ normally.
    • Click on the link in the console and verify with a Microsoft account.
    • The verification process will reappear every few days (after the session token expires).

Hot Swap

Hot Swap allows reloading edited code while debugging, removing the need to restart the whole game every time.

We use dcevm and the IntelliJ Plugin HotSwap Agent to quickly reload code changes.

Follow this tutorial.