https://github.com/stashingco/sound-categories

Allows mods to add more sound categories that are adjustable in the Minecraft sound settings.
https://github.com/stashingco/sound-categories

fabric minecraft-mod

Last synced: about 1 month ago
JSON representation

Allows mods to add more sound categories that are adjustable in the Minecraft sound settings.

• Host: GitHub
• URL: https://github.com/stashingco/sound-categories
• Owner: stashingco
• License: apache-2.0
• Created: 2021-12-15T10:54:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-02T09:51:46.000Z (12 months ago)
• Last Synced: 2024-02-07T10:10:55.452Z (5 months ago)
• Topics: fabric, minecraft-mod
• Language: Java
• Homepage:
• Size: 290 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-fabric - Sound Categories - Allows mods to add more sound categories, and modifies the Minecraft sound settings menu to fit as many categories as required. ([Wiki](https://github.com/stashingco/sound-categories/blob/main/README.md)) `Apache-2.0` (Uncategorized / Uncategorized)

README

        
# Sound Categories

Fabric library that allows mods to add more sound categories, and modifies the Minecraft sound settings menu to fit as

many categories as required.

## Adding to your project

The build artifact is hosted on [my personal Maven server](https://repo.stashy.dev). Add the following to your

repositories block:

```groovy

maven {

    name = "stashymane's repo"

    url = "https://repo.stashy.dev/releases"

}

```

And the following to your dependencies:

```groovy

include("dev.stashy:sound-categories:${project.soundcategories_version}")

```

Then add the mod version to your gradle.properties. Make sure to `include()` to embed the library into your mod, as otherwise the user will have to download

it separately.

## Adding a category

Classes that contain sound categories must implement `CategoryLoader` so that they are picked up by the loader. Every

SoundCategory you define must have the `Register` annotation - they will have the category reference injected once it is

created.

Example class:

```java

import dev.stashy.soundcategories.CategoryLoader;

import net.minecraft.sound.SoundCategory;

public class CustomCategories implements CategoryLoader

{

    @Register(master = true)

    public static SoundCategory MOD_MAIN;

    @Register

    public static SoundCategory SUBCATEGORY;

    @Register(name = "your_custom_name")

    public static SoundCategory CUSTOM_NAME;

    @Register(defaultLevel = 0f)

    public static SoundCategory OFF_BY_DEFAULT;

}

```

The register annotation has a few attributes:

* `master` will group all categories defined underneath it under one, accessible with a button next to the master

  category's slider.

* `name` allows you to set a custom name the category will be created under - useful if you want to have a

  simple `MASTER` variable set and not conflict with Minecraft's own master category.

* `defaultLevel`, quite obviously, is used as the default level the game creates your category with.

After implementing the loader, make sure you add the class as an entrypoint for `sound-categories` in

your `fabric.mod.json`.

## Localization

The newly added category needs language definitions to show any name, apart from its key. You can do so in your `lang`

folder. For an example, you can check the

[ExtraSounds](https://github.com/stashymane/extra-sounds/) language files.