SI Wiki - Configuration

With help of our Configuration API, other mods that depend on SI: Essentials have access to all configurations of SI: Essentials, thus allowing them to work with global values.

Cnfg Location

The main configuration of SI: Essentials is located in /mcRoot/config/si/es/general.cnfg.

Raw `general.cnfg`

# general.cnfg
# Generated by the SI: Essentials Configuration System
# Cnfg Type: COMMON

#    _____ _____     ______                    _   _       _
#   / ____|_   _|_  |  ____|                  | | (_)     | |
#  | (___   | | (_) | |__   ___ ___  ___ _ __ | |_ _  __ _| |___
#   \___ \  | |     |  __| / __/ __|/ _ \ '_ \| __| |/ _` | / __|
#   ____) |_| |_ _  | |____\__ \__ \  __/ | | | |_| | (_| | \__ \
#  |_____/|_____(_) |______|___/___/\___|_| |_|\__|_|\__,_|_|___/
#
# ---------------------------------------------------------------
# All settings support the MiniMessage Format:
# https://docs.papermc.io/adventure/minimessage/format/
# ---------------------------------------------------------------
#                     <= General Settings =>
# ---------------------------------------------------------------
# Whether the debug mode should be enabled (This will show debug logs in the console)
debug_enabled = false

# The prefix of the mod that is added in front of each message. Can be left emtpy.
prefix = "<bold><white>[</white><gradient:#2F97DD:#026DCA>SI: Essentials</gradient><white>]</white></bold> "

# ---------------------------------------------------------------
#                  <= Sound Feedback Settings =>
# ---------------------------------------------------------------
# Whether sound feedback for various actions should be enabled. Can be compared to haptic feedback on phones but with sounds.
enable_sound_feedback = true

# What sound should be played when an action succeeds. Requires 'enable_sound_feedback'.
# You can find a list of all sound IDs here: https://www.soncresity.industries/utils/mc-registry
sound_feedback_success_id = "entity.player.levelup"

# What volume the success sound should have.
sound_feedback_success_volume = 0.5

# What pitch the success sound should have.
sound_feedback_success_pitch = 0.1

# What sound should be played when you click a button from SI: Essentials or other mods using it. Requires 'enable_sound_feedback'.
# You can find a list of all sound IDs here: https://www.soncresity.industries/utils/mc-registry
sound_feedback_click_id = "block.lever.click"

# What volume the click sound should have.
sound_feedback_click_volume = 0.8

# What pitch the click sound should have.
sound_feedback_click_pitch = 1.0

# What sound should be played when an action fails. Requires 'enable_sound_feedback'.
# You can find a list of all sound IDs here: https://www.soncresity.industries/utils/mc-registry
sound_feedback_fail_id = "block.note_block.bass"

# What volume the fail sound should have.
sound_feedback_fail_volume = 1.0

# What pitch the fail sound should have.
sound_feedback_fail_pitch = 0.1

General Settings

`debug_enabled`

Whether the debug mode should be enabled. This will make debug logging visible in your game logs.

Important notice

Debug logs will always be logged in the dedicated /<world>/si/es/logs/<log>.log file, regardless of this setting.
This is especially useful for developers when trying to find errors in their code.

Type: Boolean
Default Value: false

`modPrefix`

The Mod prefix. This String will be prepended to all messages the mod outputs that can be seen in the chat.

Message Formatting

This value supports MiniMessage Formatting, a more advanced way to style messages.

Type: String
Default Value: <bold><white>[</white><gradient:#2F97DD:#026DCA>SI: Essentials</gradient><white>]</white></bold>

Sound Feedback Settings

Message Formatting

This section is for sound feedback. As the name suggests, it is similar to haptic feedback, like you probably know it from mobile phones, but with sound.
Mods that depend on SI: Essentials also have access to these settings so they can be used as globally.

`enable_sound_feedback`

Whether sound feedback should be enabled.

Type: Boolean
Default Value: true

`sound_feedback_success_id`

What sound should be played when an action succeeds. (Defaults to entity.player.levelup if a sound can't be parsed)

Sound ID List

You can find a list of all Sound IDs here: Minecraft Registry - Soncresity Industries

Type: String
Default Value: entity.player.levelup
Requires: enable_sound_feedback = true

`sound_feedback_success_volume`

What volume the success sound should have.

Type: Float
Default Value: 0.5
Requires: enable_sound_feedback = true

`sound_feedback_success_pitch`

What pitch the success sound should have.

Type: Float
Default Value: 0.1
Requires: enable_sound_feedback = true

`sound_feedback_click_id`

What sound should be played when you click a button from SI: Essentials or other mods using it. (Defaults to block.lever.click if a sound can't be parsed)

Sound ID List

You can find a list of all Sound IDs here: Minecraft Registry - Soncresity Industries