Skip to content

Document badge_shader in metadata #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nh6574 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document badge_shader in metadata #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Mod-Metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The (new) standard way to specify your mod's metadata is in a separate JSON file
"priority": -20, // [default: 0] ! Mods are loaded in order from lowest to highest priority value.
"badge_colour": "FF230A", // [default: 666665] ! Background colour for your mod badge. Must be a valid hex color with 6 or 8 digits (RRGGBB or RRGGBBAA)
"badge_text_colour": "ABC123", // [default: FFFFFF] ! Text colour for your mod badge.
"badge_shader": "modprefix_shaderkey", // ! Key to the SMODS.Shader to use for the badge if any
"display_name": "YM", // [default: <name>] ! Displayed text on your mod badge.
"no_marquee": true, // ! [default: false] Disable the marquee scrolling effect on your mod badge and display the whole text at once.
"icon_path": "path.png", // ! Path to the mod's icon in the Mods menu. Must be located in both assets/1x and assets/2x. *(Added in 1531zeebee)*
Expand Down