diff --git a/backend/src/main/resources/config.yml b/backend/src/main/resources/config.yml index 762bcee..846065a 100644 --- a/backend/src/main/resources/config.yml +++ b/backend/src/main/resources/config.yml @@ -8,103 +8,75 @@ metrics: true update-checker: true # Forces a specific locale (e.g., zh_cn) force-locale: '' -# Module Settings -# Modifying these modules may result in distorted images. If this occurs, reinstall the newly generated resource pack. + +# Module Settings: Enable or disable specific features. modules: - nameplates: true - backgrounds: true - bubbles: true - bossbars: true - actionbars: true - images: true -# Plugin Integrations + nameplates: true # Enable nameplate display + backgrounds: true # Enable background images for nameplates + bubbles: true # Enable bubble text display + bossbars: true # Enable bossbars + actionbars: true # Enable actionbars + images: true # Enable image displays + +# Plugin Integrations: Integrate resource packs and chat plugins with other plugins. integrations: - # Should Nameplates merge resource packs with these plugins during reload? resource-pack: - ItemsAdder: false - ItemsAdder-old-method: false - Oraxen: false - # Some chats, such as staff chats or menu inputs, may need to be excluded from capture. - # Supported chat plugins are listed below, which allow blacklist channels and /ignore functionality to work correctly. + ItemsAdder: false # Integration with ItemsAdder + ItemsAdder-old-method: false # Old method for ItemsAdder + Oraxen: false # Integration with Oraxen chat: - TrChat: false - VentureChat: false - HuskChat: false - CarbonChat: false - AdvancedChat: false - Essentials: false -# Resource Pack Generation Settings + TrChat: false # Integration with TrChat + VentureChat: false # Integration with VentureChat + HuskChat: false # Integration with HuskChat + CarbonChat: false # Integration with CarbonChat + AdvancedChat: false # Integration with AdvancedChat + Essentials: false # Integration with Essentials chat + +# Resource Pack Generation Settings: Configure resource pack generation behavior. resource-pack: - # Disables resource pack generation at server startup - disable-generation-on-start: false - # Namespace identifier - namespace: "nameplates" - # Font selection - font: "default" - # The starting character for custom fonts - # This character is used, but it won't affect normal Korean characters during chat, as they belong to the "minecraft:default" font. - initial-char: '뀁' - # Specify directories for PNG file generation. - # This helps maintain an organized resource pack structure. - image-path: - nameplates: 'font/nameplates/' - backgrounds: 'font/backgrounds/' - images: 'font/images/' - bubbles: 'font/bubbles/' - space-split: 'font/base/' - # Shader Settings + disable-generation-on-start: false # Allow resource pack generation at server start + namespace: "nameplates" # Namespace for the resource pack + font: "default" # Default font used + initial-char: '뀁' # Starting character for custom fonts (won't affect Korean characters in chat) + image-path: # Paths for different assets + nameplates: 'font/nameplates/' # Path for nameplates assets + backgrounds: 'font/backgrounds/' # Path for background images + images: 'font/images/' # Path for other images + bubbles: 'font/bubbles/' # Path for bubble text images + space-split: 'font/base/' # Path for base font images shader: - # Enables shader generation - enable: true - # Hides scoreboard numbers (1.20.4- requires shader to remove that) - hide-scoreboard-number: false - # Enables support for animated text shaders - animated-text: false - # Enables ItemsAdder text effect support - ItemsAdder-text-effects: false - # Bossbar transparency settings + enable: true # Enable shader generation + hide-scoreboard-number: false # Hiding of scoreboard numbers + animated-text: false # Animated text shaders + ItemsAdder-text-effects: false # ItemsAdder text effects support transparent-bossbar: - # Specify the color of the bossbar to hide - color: YELLOW - # Generate transparent bossbars for Minecraft 1.20.2+ - "1_20_2+": true - # Generate transparent bossbars for Minecraft 1.17-1.20.1 - "1_17-1_20_1": true - # Legacy Unicode support for Minecraft 1.20+ clients, as these images were removed in 1.20, affecting the creation of decent texts. - # Enabling this increases your resource pack size by approximately 900KB. - legacy-unicodes: true -# Additional Settings + color: YELLOW # BossBar color to remove + "1_20_2+": true # Enable transparent bossbar for Minecraft 1.20.2+ + "1_17-1_20_1": true # Enable transparent bossbar for Minecraft 1.17-1.20.1 + legacy-unicodes: true # Enable legacy Unicode support for Minecraft 1.20+ (increases resource pack size by 900KB) + +# Additional Settings: Extra options to control behavior and performance. other-settings: - # It is recommended to use the MiniMessage format. If you prefer legacy color codes using "&", enable this support. - # Disabling it will improve color formatting performance. - legacy-color-code-support: true - # Set a delay for actionbar/bossbar to prevent compatibility issues - send-delay: 0 - # Determines whether CustomNameplates should capture actionbars from other plugins - catch-other-plugin-actionbar: true - # Should the plugin listen for chat canceled events by unknown chat plugins? - unsafe-chat-event: false - # Set the default condition refresh interval - default-condition-refresh-interval: 1 - # Set the default placeholder refresh interval - default-placeholder-refresh-interval: 1 - # Set the refresh interval for better performance (Especially for those heavy placeholders) - placeholder-refresh-interval: + legacy-color-code-support: true # Enable support for legacy color codes using & + send-delay: 0 # Set actionbar/bossbar send delay + catch-other-plugin-actionbar: true # Capture actionbars from other plugins + unsafe-chat-event: false # Listen for canceled(unsafe) chat events from unknown plugins + default-condition-refresh-interval: 1 # Set default condition refresh interval + default-placeholder-refresh-interval: 1 # Set default placeholder refresh interval + placeholder-refresh-interval: # Custom placeholder refresh intervals for performance optimization "%player_name%": 100 - "%vault_prefix%": 1 - # CustomNameplates provides some templates for reading the default Minecraft fonts - # You can replace the files under /font or add new configuration to let the plugin get these templates. - # Templates can be used in advance-data.yml + "%vault_prefix%": 20 + # Font Templates: Define different fonts and their settings. font-templates: space: space: - " ": 4 - "\\u200c": 0 + " ": 4 # Define space width as 4 units + "\\u200c": 0 # Define zero-width non-joiner as 0 width unihex: unifont: - file: unifont.zip - generate: false - size_overrides: + file: unifont.zip # Load font from unifont.zip + generate: false # Don't include font in the generated resource pack + size_overrides: # Override size for specific Unicode ranges - from: "\\u3001" to: "\\u30FF" left: 0 @@ -142,10 +114,10 @@ other-settings: left: 0 right: 15 unifont_jp: - file: unifont_jp.zip - generate: false + file: unifont_jp.zip # Load Japanese unifont + generate: false # Don't generate in the resource pack filter: - "jp": true + "jp": true # Apply to Japanese characters only size_overrides: - from: "\\u3200" to: "\\u9FFF" @@ -157,10 +129,10 @@ other-settings: right: 15 bitmap: ascii: - codepoints: ascii - file: ascii.png - height: 8 - custom: false # Is this a non-default Minecraft font? If enabled, plugin will create a new font image in the generated resource pack + codepoints: ascii # Define ASCII bitmap font + file: ascii.png # Use ascii.png file for the font + height: 8 # Font height is 8 units + custom: false # Not a custom font (default Minecraft) ascii_sga: codepoints: ascii_sga file: ascii_sga.png @@ -183,22 +155,20 @@ other-settings: custom: false legacy_unicode: legacy_unicode: - file: unicode_page_%02x.png - height: 8 + file: unicode_page_%02x.png # Legacy Unicode characters page file + height: 8 # Set height to 8 units custom: false unicode: unicode: - file: unicode_page_%02x.png - sizes: glyph_sizes.bin + file: unicode_page_%02x.png # Default Unicode characters + sizes: glyph_sizes.bin # Glyph size configuration ttf: example: - generate: false - file: example.ttf - size: 10.0 - oversample: 8.0 - skip: [] - # If the font is a bitmap font, the number represents the ascent - # If the font is a ttf font, the number represents the Y shift + generate: false # Should this TTF file be included in the generated pack + file: example.ttf # Define the TTF file to load the font from + size: 10.0 # Set font size + oversample: 8.0 # Oversample rate for TTF rendering + skip: [] # Skipped characters in list format shift-fonts: shift_0: - space diff --git a/backend/src/main/resources/configs/actionbar.yml b/backend/src/main/resources/configs/actionbar.yml index 2224f63..a7d1dee 100644 --- a/backend/src/main/resources/configs/actionbar.yml +++ b/backend/src/main/resources/configs/actionbar.yml @@ -1,24 +1,13 @@ -# Important: Players can only see one actionbar at any given moment, no overlap allowed! +# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/config/actionbar.yml actionbar: - # Players need this permission to display the actionbar, the conditions can be customized conditions: condition_1: type: permission - refresh-interval: 20 # Refresh rate, in ticks, to recheck the permission status + refresh-interval: 20 value: - actionbar.show text-display-order: 1: - # Duration of the text display, measured in ticks (20 ticks = 1 second) - # -1 means the text will stay on the screen forever! duration: -1 - # The message to be shown in the actionbar text: '%np_conditional_actionbar%' - # Optional settings for finer control: - # When enabling conditions, make sure at least one valid actionbar is displayed to the player, - # or it may lead to an endless loop with nothing visible. - # If the player doesn't meet the condition, this actionbar will simply be skipped. - # The condition is only checked once per cycle, until the next time it comes around. - conditions: {} - #2: ... - #3: ... \ No newline at end of file + conditions: {} \ No newline at end of file diff --git a/backend/src/main/resources/configs/advance-data.yml b/backend/src/main/resources/configs/advance-data.yml index d08d829..895fc00 100644 --- a/backend/src/main/resources/configs/advance-data.yml +++ b/backend/src/main/resources/configs/advance-data.yml @@ -1,15 +1,13 @@ +# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/config/advance-data.yml # namespace:font minecraft:default: - # default advance default: 9.0 - # Sets the loading sequence of the templates template-loading-sequence: - unifont - nonlatin_european - accented - ascii - space - # The values here would override the same character in the template values: 默: 9.0 diff --git a/backend/src/main/resources/configs/bossbar.yml b/backend/src/main/resources/configs/bossbar.yml index 42aeae3..2c5980c 100644 --- a/backend/src/main/resources/configs/bossbar.yml +++ b/backend/src/main/resources/configs/bossbar.yml @@ -1,37 +1,25 @@ -# You can create as many bossbar sections as you'd like +# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/config/bossbar.yml bossbar_1: - # Choose the color of the bossbar (Options: BLUE, GREEN, PINK, PURPLE, RED, WHITE, YELLOW) color: YELLOW - # Decide how the progress bar looks (Options: "progress", "notched_6", "notched_10", "notched_12", "notched_20") overlay: PROGRESS conditions: condition_1: type: permission - refresh-interval: 20 # How often, in ticks, to check if the player still has the required permission + refresh-interval: 20 value: - bossbar.show - # The bossbar will cycle through the text in this exact order: text-display-order: 1: - # Time (in ticks) this text stays on the screen (100 ticks = 5 seconds) duration: 100 - # What message to display in the bossbar text: '%np_background_hello%' 2: - # Display for 10 seconds duration: 200 text: '%np_background_time% %np_background_location% %np_background_weather%' 3: - # Show for 5 seconds duration: 100 text: '%np_background_update%' - # Optional extra control: - # Make sure at least one bossbar message is shown, or else it could result in an endless cycle with nothing visible! - # If the player doesn’t meet the condition, this message will be skipped. - # Conditions are only checked once per cycle until it comes back around. conditions: - permission: nameplates.admin # Only players with this permission will see this specific message + permission: nameplates.admin equals: - # Compare two values and act based on the result value1: '%np_is-latest%' - value2: 'false' # Only display if the value is "false" \ No newline at end of file + value2: 'false' \ No newline at end of file diff --git a/backend/src/main/resources/configs/bubble.yml b/backend/src/main/resources/configs/bubble.yml index a312444..8ddb9f6 100644 --- a/backend/src/main/resources/configs/bubble.yml +++ b/backend/src/main/resources/configs/bubble.yml @@ -1,34 +1,19 @@ -# Requirements for sending the bubble +# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/config/bubble.yml sender-requirements: permission: bubbles.send potion-effect: "INVISIBILITY<0" - viewer-requirements: permission: bubbles.see - -# blacklist channels blacklist-channels: - Private - Staff - -# ALL: all the players can see the bubble -# JOINED: players in the same channel can see each other's bubble -# CAN_JOIN: players that have permission to certain channels would see the bubble in that channel channel-mode: ALL - -# Default bubble to display if player's bubble is "none" default-bubble: 'chat' - -# Y offset from the highest nameplate y-offset: 0.1 - view-range: 0.5 - -# Bubble display time (in ticks) stay-duration: 150 appear-duration: 4 disappear-duration: 2 - bubble-settings: chat: display-name: "White Bubbles" diff --git a/backend/src/main/resources/configs/custom-placeholders.yml b/backend/src/main/resources/configs/custom-placeholders.yml index 668d898..8f3e0a8 100644 --- a/backend/src/main/resources/configs/custom-placeholders.yml +++ b/backend/src/main/resources/configs/custom-placeholders.yml @@ -34,7 +34,7 @@ conditional-text: weather: - thunder -# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/custom-placeholders/bubble-text +# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/custom-placeholders/background-nameplate-bubble-text bubble-text: chat: bubble: chat_1 @@ -42,7 +42,7 @@ bubble-text: left-margin: 1 right-margin: 1 -# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/custom-placeholders/nameplate-text +# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/custom-placeholders/background-nameplate-bubble-text nameplate-text: halloween: nameplate: halloween @@ -50,7 +50,7 @@ nameplate-text: left-margin: 1 right-margin: 1 -# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/custom-placeholders/background-text +# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/custom-placeholders/background-nameplate-bubble-text background-text: location: background: bedrock_1 diff --git a/backend/src/main/resources/configs/nameplate.yml b/backend/src/main/resources/configs/nameplate.yml index 6014a76..ab5a9e3 100644 --- a/backend/src/main/resources/configs/nameplate.yml +++ b/backend/src/main/resources/configs/nameplate.yml @@ -1,25 +1,11 @@ -# Duration (in seconds) for which the nameplate preview will be displayed. +# https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customnameplates/config/nameplate.yml preview-duration: 5 - -# Default nameplate shown when a player's nameplate is set to "none." default-nameplate: 'none' - -# Whether to make the nameplate always visible to the player always-show: false - -# Configuration for nameplate behavior and appearance. nameplate: - # Prefix to be displayed before the player's name. - # The prefix here will become part of the nameplate prefix: '%np_switch_nameplate_color_prefix%' - # Placeholder for the player's name - # The default configuration uses shift to ensure that the player name not affected by the clientside `force-unicode-font` setting. player-name: '%np_shift_player_name%' - # Suffix to be displayed after the player's name. - # The suffix here will become part of the nameplate suffix: '%np_switch_nameplate_color_suffix%' - -# Configuration for Unlimited tags. unlimited: tag_1: text: '%np_tag-image%'