KiltMC / Kilt

A Fabric mod that brings Forge mods into the Fabric ecosystem.
GNU Lesser General Public License v2.1
253 stars 16 forks source link

Proposal: Wiki/Install Instructions. #8

Open rotgruengelb opened 1 year ago

rotgruengelb commented 1 year ago

Consider enabling a Wiki to document the API/config if there are/will be any.

For a "How to install" Sections, this is my Proposal:

How to Install

  1. Click on the Actions Tab.
  2. Click on Gradle CI on the side under All workflows.
  3. Click on the most recent/top most result.
  4. Scroll down to Artifacts and click Kilt Alpha Build.
  5. Extract the .zip file that is downloaded.
  6. The (Kilt-x.x.x.x+mc1.xx.x) .jar file is the file you need to put in your mods folder.
  7. Alongside, you should also install:
BluSpring commented 1 year ago

I may add a wiki later on to document how to update Kilt for newer versions as well as how to set it up in a developer environment for contributors. As for configs, the only kind of configuration that would be available to end users is under Forge's configs, anything else Kilt-specific would be toggled via JVM flags, as they would be specifically for debugging purposes.

I do plan to add a "How to Install" section at some point in the future, however this is not a priority for me at the moment as Kilt is currently still in a very early alpha stage. Once I know that Kilt will definitely work with most mods, I will add this section. That would probably be around the same time as when Kilt is released onto Modrinth.

rotgruengelb commented 1 year ago

Alright Keep it up