AppleSkin

https://github.com/squeek502/appleskin
Admin
AppleSkin is a Minecraft mod that adds food-related HUD improvements including food value tooltips,...
Tokens:1,135
Snippets:13
Trust Score:9.7
License:Unlicense
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example AppleSkin Event Handler

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

An example implementation of an AppleSkin event handler. This specific handler cancels the tooltip for regular apples. Refer to the 'squeek.appleskin.api.event' package for other available events.

```java
public class AppleSkinEventHandler
{
	@SubscribeEvent
	public void onPreTooltipEvent(TooltipOverlayEvent.Pre event) {
		// hide the tooltip for regular apples
		if (event.itemStack.getItem() == Items.APPLE) {
			event.setCanceled(true);
		}
	}
}
```

--------------------------------

### Registering AppleSkin Event Handlers

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

Example of how to register an event handler for AppleSkin events, ensuring it only registers if AppleSkin is loaded.

```APIDOC
## Registering AppleSkin Event Handlers

In your `@Mod` annotated class:

```java
private void clientInit(final FMLClientSetupEvent event) {
    if (ModList.get().isLoaded("appleskin")) {
        MinecraftForge.EVENT_BUS.register(new AppleSkinEventHandler());
    }
}
```

and the `AppleSkinEventHandler` class:

```java
public class AppleSkinEventHandler
{
	@SubscribeEvent
	public void onPreTooltipEvent(TooltipOverlayEvent.Pre event) {
		// hide the tooltip for regular apples
		if (event.itemStack.getItem() == Items.APPLE) {
			event.setCanceled(true);
		}
	}
}
```

(see the `squeek.appleskin.api.event` package for all the possible events that can be registered)
```

--------------------------------

### Build AppleSkin Mod

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

Execute this command in the project's root directory to build the mod. Use the -Pversion flag to specify a version number.

```bash
gradlew build
```

```bash
gradlew build -Pversion=<version>
```

--------------------------------

### Including AppleSkin for Development Testing

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

Instructions on how to include the full AppleSkin mod in your development environment for testing purposes.

```APIDOC
## Including AppleSkin for Development Testing

Note: if you want to test with the full AppleSkin mod in your development environment, you can also add the following to your `dependencies`:

```groovy
runtimeOnly fg.deobf("squeek.appleskin:appleskin-forge:<version>")
```

while replacing `<version>` with the appropriate version.
```

--------------------------------

### Compile Against AppleSkin API

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

Add this dependency to your build.gradle to compile against the AppleSkin API. Replace <version> with the appropriate version number.

```groovy
compileOnly fg.deobf("squeek.appleskin:appleskin-forge:<version>:api")
```

--------------------------------

### Include Full AppleSkin Mod for Development

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

Add this dependency to your build.gradle to include the full AppleSkin mod in your development environment. Replace <version> with the appropriate version number.

```groovy
runtimeOnly fg.deobf("squeek.appleskin:appleskin-forge:<version>")
```

--------------------------------

### Add AppleSkin Repository to build.gradle

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

Include this repository configuration in your project's build.gradle file to allow Gradle to find AppleSkin artifacts.

```groovy
repositories {
	maven {
		url "https://maven.ryanliptak.com/"
	}
}
```

--------------------------------

### Adding AppleSkin as a Dependency

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

Instructions on how to add AppleSkin as a compile-only dependency to your mod's build.gradle file, allowing you to compile against the AppleSkin API.

```APIDOC
## Adding AppleSkin as a Dependency

To compile against the AppleSkin API, include the following in your `build.gradle`:

```groovy
repositories {
	maven {
		url "https://maven.ryanliptak.com/"
	}
}
```

and add this to your `dependencies` block:

```groovy
compileOnly fg.deobf("squeek.appleskin:appleskin-forge:<version>:api")
```

where `<version>` is replaced by the appropriate version found here:

https://maven.ryanliptak.com/squeek/appleskin/appleskin-forge
```

--------------------------------

### Register AppleSkin Event Handler Conditionally

Source: https://github.com/squeek502/appleskin/blob/1.16-forge/README.md

In your @Mod annotated class, check if 'appleskin' is loaded before registering an AppleSkin event handler. This ensures compatibility if AppleSkin is not present.

```java
private void clientInit(final FMLClientSetupEvent event) {
    if (ModList.get().isLoaded("appleskin")) {
        MinecraftForge.EVENT_BUS.register(new AppleSkinEventHandler());
    }
}
```
Tokens:
Raw