-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
32 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,54 @@ | ||
# What The Hell Is That? | ||
[![License](https://img.shields.io/badge/license-CC%20BY--NC--SA%204.0-blue.svg)](https://bit.ly/cc-by-nc-sa-40) | ||
|
||
##### **WTHIT** - a fork of [HWYLA](https://minecraft.curseforge.com/projects/hwyla) by [TehNut](https://www.curseforge.com/members/tehnut) - a fork of [WAILA](https://minecraft.curseforge.com/projects/waila) by [ProfMobius](https://minecraft.curseforge.com/members/ProfMobius). | ||
##### **WTHIT** - a fork of [HWYLA](https://minecraft.curseforge.com/projects/hwyla) by [TehNut](https://www.curseforge.com/members/tehnut) which is a fork of [WAILA](https://minecraft.curseforge.com/projects/waila) by [ProfMobius](https://minecraft.curseforge.com/members/ProfMobius). | ||
|
||
###### *This fork is permitted under the [CC BY-NC-SA 4.0](LICENSE.md) license. Usage of this mod is permitted in all modpacks.* | ||
|
||
##### A full list of significant changes since this fork's creation can be found in the **[CHANGES.md](CHANGES.md)** document. | ||
|
||
--- | ||
|
||
### Information For Developers | ||
|
||
##### To use this fork in your workspace, add the following to your `build.gradle`: | ||
**To use this fork in your workspace, add the following to your `build.gradle`** | ||
|
||
```groovy | ||
repositories { | ||
maven { url "https://jitpack.io" } | ||
// blame github for requiring an auth for accessing artifacts | ||
maven { url "https://gitlab.com/api/v4/projects/25106863/packages/maven" } | ||
} | ||
dependencies { | ||
modImplementation 'com.github.badasintended:wthit:VERSION' | ||
// fabric | ||
modImplementation "mcp.mobius.waila:wthit-fabric:${wthit_version}" | ||
// forge | ||
implementation fg.deobf("mcp.mobius.waila:wthit-forge:${wthit_version}") | ||
} | ||
``` | ||
[![](https://jitpack.io/v/badasintended/wthit.svg)](https://jitpack.io/#badasintended/wthit) | ||
|
||
As of Fabric Loader 0.4.0, Waila plugins are discovered from the `fabric.mod.json` file. Simply add a `custom` object field | ||
to that file with the following data: | ||
|
||
```json | ||
{ | ||
"waila:plugins": { | ||
"id": "mymod:my_plugin", | ||
"initializer": "foo.bar.Baz" | ||
} | ||
**Make a class that implements `IWailaPlugin`** | ||
```java | ||
public class ExamplePlugin implements IWailaPlugin { | ||
} | ||
``` | ||
|
||
`waila:plugins` can also be an array of objects instead of a singular object. | ||
|
||
A `required` field can be added to specify mods required for that plugin to be loaded. It can either be a single string | ||
or an array of strings. | ||
**Register the plugin** | ||
- **Fabric** | ||
Add `custom` object on `fabric.mod.json` with following data | ||
```json | ||
{ | ||
"waila:plugins": { | ||
"id": "mymod:my_plugin", | ||
"initializer": "com.example.ExamplePlugin" | ||
} | ||
} | ||
``` | ||
`waila:plugins` can also be an array of objects instead of a singular object. | ||
A `required` field can be added to specify mod ids required. It can either be a string or an array of strings. | ||
- **Forge** | ||
Annotate your plugin class with `WailaForgePlugin` | ||
```java | ||
@WailaForgePlugin("mymod:my_plugin") | ||
public class ExamplePlugin implements IWailaPlugin | ||
``` | ||
`@WailaPlugin` was deprecated to make a value id mandatory and make `requires` accepts an array. |