BlossomLib
Library mod for Blossom-series Fabric mods
📖About BlossomLib
BlossomLib
BlossomLib is a Minecraft Fabric library mod build for the Blossom-series mods.
Table of contents
Dependencies
- Fabric API
(CurseForge
/ Modrinth),
or Quilt Standard Libraries (Modrinth)
if using Quilt - fabric-permissions-api / LuckPerms /
etc. (Optional) - server-translations-api (Embedded)
Config
This library's config file can be found at config/BlossomMods/BlossomLib.json, after running the server with
the mod at least once.
logging: LoggingConfig - settings to do with BlossomMods loggingbaseTeleportation: TeleportationConfig - default teleportation settingscolors: Colors - text colorsdimNameOverrides: Map<String, String> - a map of dimension name overrides, for example set to{ "minecraft:the_nether": "The Underworld" } to display The Nether as The UnderworldenableMC124177Fix: boolean - Enable a fix for MC-124177 / CrossDimTPFix
LoggingConfig
consoleLogLevel: String (OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL) - BlossomMods logging level
for the console outputfileLogLevel: String (OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL) - BlossomMods logging level
for the file outputfileLogPath: String - where to put the BlossomMods log filefileLogAppend: boolean - whether to keep the old BlossomMods logs on server startupdisableCustomLogger: boolean - whether to completely bypass the custom logger in case of a mod incompatibility
TeleportationConfig
bossBar: BossBar - settings altering the boss bartitleMessage: TitleMessage - settings altering the title messageactionBarMessageEnabled: boolean - whether to show a message in the action bar when counting downfovEffectBefore: CubicBezierCurve - FOV animation before the teleportationfovEffectAfter: CubicBezierCurve - FOV animation after the teleportationcancelOnMove: boolean - whether to cancel the countdown if the player movesparticleAnimation: ParticleAnimation - which particle animation to use
BossBar
enabled: boolean - whether the boss bar is enabledcolor: String (pink, blue, red, green, yellow, purple, white) - the color of the boss bartextColor: String (valid text color) - the color of the boss bar name
TitleMessage
titleCounting: TitleConfig* - settings altering the display of the counting TitlesubtitleCounting: TitleConfig* - settings altering the display of the counting SubtitletitleDone: TitleConfig - settings altering the display of the done TitlesubitleDone: TitleConfig - settings altering the display of the done Subtitle
TitleConfig
color: String (valid text color) - color of the title / subtitlemodifiers: String - characters b - bold, i - italics, u - underline, o - obfuscated, s - strikethrough, can
appear in any order
*counterColor: String (valid text color) - color of the counter in the title / subtitle
CubicBezierCurve
enabled: boolean - whether to even play the animation at allvalues: float[4] - 4 values defining the cubic-bezier curve; 1st & 3rd values must be between 1 and 0, weird
things will happen if they're not!start: float - beginning valueend: float - final valuestepCount: int - how many steps the animation should generate
Colors
These colors will be only applied to Blossom mods chat responses
base: String - the text color in which most text responses will bewarn: String - the text color in which warning messages will beerror: String - the text color in which error messages will besuccess: String - the text color in which success messages will bevariable: String - the text color in which variables will beplayer: String - the text color in which player names will becommand: String - the text color in which commands will becommandDescription: String - the text color in which command descriptions will be
Commands & their permissions
/tpcancel- cancel any ongoing teleport / countdown
Permission:blossom.tpcancel(default: true)/blossomlib- library specific commands
Permission:blossom.lib.base-command(default: OP level 2)reload-config- reload and apply config from the config file
Permissionblossom.lib.base-command.reload-config(default: OP level 3)clear-countdowns [<player>]- clear all or specific players countdowns
Permissionblossom.lib.base-command.clear.countdowns(default: OP level 2)clear-cooldowns [<player>] [<type>]- clear all or specific players specific type cooldowns
Permissionblossom.lib.base-command.clear.cooldowns(default: OP level 2)debug- debug commands
Permissionblossom.lib.base-command.debug(default: OP level 4)countdown <standStill>- create an arbitrary countdownteleport <standStill> [<cooldown>] <pos> <rot>- create an arbitrary teleportfov <multiplier>- set player FOV
Translation keys
only keys with available arguments are shown, for full list, please seesrc/main/resources/data/blossom/lang/en_us.json
blossom.countdown.boss_bar.name: 1 argument - seconds remainingblossom.countdown.action_bar.counting: 1 argument - seconds remainingblossom.countdown.title.counting.title: 1 argument - seconds remainingblossom.countdown.title.counting.subtitle: 1 argument - seconds remainingblossom.clear-countdowns.one: 1 argument - player whose countdown was clearedblossom.clear-cooldowns.one: 1 argument - player whose cooldown was clearedblossom.clear-cooldowns.type: 2 arguments - player whose cooldown was cleared, type of cleared cooldownblossom.debug.countdown.start: 1 argument - standstill timeblossom.debug.teleport.no-cooldown: 1 argument - standstill timeblossom.debug.teleport.cooldown: 2 arguments - standstill time, cooldown timeblossom.config-reload: 1 argument - module nameblossom.text.command.display: 1 argument - display textblossom.text.command.plain: 1 argument - display text/command runblossom.text.command.description: 2 arguments - display text/command run, description
zh_cn (Chinese, Simplified), zh_tw (Chinese, Traditional) - added by @BackWheelko_kr (Korean) - added by @biryeongtraines_mx (Spanish, Mexico) - added by @FabrizioCoderfr_fr (French) - added by @WalTho