# Dimension Viewer A highly customizable server-side Minecraft mod for viewing what dimension players are currently in from the tab list.

> Now supporting Fabric, Forge & NeoForge! > > Fabric version requires Fabric API ([CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabric-api) or [Modrinth](https://modrinth.com/mod/fabric-api)) ## Compatibility Dimension Viewer should be compatible with all dimensions. There may be some cases where the mod name shown on hover is not formatted correctly due to the use of the modid to get which mod a dimension is from. Mods that make changes to the tab list name format (or even the regular display name) will likely cause issues with this mod but at the moment I cannot think of any to test with. If you find any issues, please [leave an issue](https://github.com/Ewan-Selkirk/Dimension-Viewer/issues/new)! Thank you!

## Features Modded dimensions can now be coloured independently.

**New in version 1.4.0** Dimension names can now be aliased to something else, allowing you to modify the name displayed per dimension.

**New in version 2.1.0** Configure the mod without touching the config file with slash commands!

## Configuration By modifying the config file, you can change the colour* of the text on a per-dimension basis, allow showing the dimension in chat messages and change the overall format of the dimension with the ability to use Minecraft text formatting such as underlining, bold and italic fonts. The config file is located in `[Server Folder]/config/dimensionviewer-common.toml` for (Neo)Forge or `[Server Folder]/config/dimensionviewer.json` for Fabric. Any changes made will be applied as soon as the config file is saved. See below for an example config:

Example Configurations & Settings

### Settings and What They Do ___ - `listFormat` - String - The format that will be used to display the dimension in the player list or chat name. It supports a few tokens to tweak the layout. - `%d` - Dimension (required) - `%i` - Italic - `%b` - Bold - `%u` - Underlined - `%s` - Strikethrough - `%o` - Obfuscate text - `%%` - Literal % - Any character following a `%` will be interpreted as a token and removed, so use `%%` if you want a percentage sign in the name - `dimensionPosition` - String - Sets the position the dimension is shown in relation to the players name. - `PREPEND` - Before the player name - `APPEND` - After the player name - `defaultColor` - String - Sets the default font colour to use if `PER_DIM_COLOR` is false or is a custom dimension that is not defined in `MODDED_DIMS` - Accepts any vanilla text colour: `DARK_RED`, `RED`, `GOLD`, `YELLOW`, `DARK_GREEN`, `GREEN`, `AQUA`, `DARK_AQUA`, `DARK_BLUE`, `BLUE`, `LIGHT_PURPLE`, `DARK_PURPLE`, `WHITE`, `GRAY`, `DARK_GRAY`, `BLACK` - Also accepts the name of any custom colours defined in `CUSTOM_COLORS` - The names must be UPPERCASE - `overworldColor`, `netherColor` & `endColor` - String - Used to change the colors of vanilla dimensions when `perDimColor` is set to `true` - Accepts the same inputs as `defaultColor` - `perDimColor` - Boolean - Used to enable individual dimension colouring. Disabling this will display all dimensions the same colour as defined in `DEFAULT_COLOR` - `dimInChatName` - Boolean - Used to toggle showing the dimension in a players name when sending chat messages - When turned off, the players chat name will be unaffected and only the tab list name will show the players current dimension - `enableAliases` - Boolean - Used to toggle whether custom dimension names should be used. - When enabled, any dimensions that match items in `DIM_ALIASES` will have their display names swapped for the aliased name. - `moddedDimensions` - Array of Strings - Used to change the colors of custom modded dimensions - Uses the format `modid:dim_id color` - For example, Twilight Forest in Gold would be `twilightforest:twilight_forest GOLD` - `dimensionAliases` - Array of Strings - Used to show a custom name for a given dimension - Uses the format `modid:dim_id New Name` (Spaces allowed) - For example, to replace `Overworld` with `The Grasslands` you would use `minecraft:overworld The Grasslands` - Has no effect if `ENABLE_ALIASES` is false - [VERSION 2.0.0+] Allows the use of tokens in the alias (see `listFormat`) - Make only the overworld text bold with `minecraft:overworld %b%d` - `customColors` [VERSION 2.0.0+] - Array of Strings - Used to define custom font colors in either HEX format or RGB format. - Uses the format `COLOR_NAME #HEX` for hexadecimal colours or `COLOR_NAME r000 g000 b000` for RGB colors. - The name of the color must be UPPERCASE - Hexadecimal numbers must be 6 characters long. Truncated hex values and hex w/ alpha values are not supported at this moment. - For example, a custom pink hex color would be `HOT_PINK #C62F75` - Another example, a custom purple RGB color would be `FUTURE_PURPLE r152 g154 b255`

(Neo)Forge Example

The (Neo)Forge configuration file contains comments for every setting and the valid options available for the setting. ```toml #Customization Settings [customization] #The color to use for the dimension font if perDimColorPath is false. #(In the event of a modded dimension being entered, this color will be used as a fallback) fontColor = "DARK_AQUA" #Global toggle for dimension aliases. Requires aliases to be set below. enableAliases = true #Format that will be used to display the dimension in the tab list with the use of tokens: # %d - Dimension Name # %i - Italic font # %b - Bold font # %u - Underline font # %o - Obfuscated font # %s - Strikethrough font listFormat = "%i<%d>" #Whether the dimension should be placed before or after the player name #Allowed Values: PREPEND, APPEND dimensionPosition = "APPEND" #Should each dimension have its own color? perDimColor = true #Per-Dimension Customization [customization.dimension] #Color to use for the Overworld #Allowed Values: DARK_RED, RED, GOLD, YELLOW, DARK_GREEN, GREEN, AQUA, DARK_AQUA, DARK_BLUE, BLUE, LIGHT_PURPLE, DARK_PURPLE, WHITE, GRAY, DARK_GRAY, BLACK overworldColor = "DARK_GREEN" #Color to use for the Nether #Allowed Values: DARK_RED, RED, GOLD, YELLOW, DARK_GREEN, GREEN, AQUA, DARK_AQUA, DARK_BLUE, BLUE, LIGHT_PURPLE, DARK_PURPLE, WHITE, GRAY, DARK_GRAY, BLACK netherColor = "DARK_RED" #Color to use for the End #Allowed Values: DARK_RED, RED, GOLD, YELLOW, DARK_GREEN, GREEN, AQUA, DARK_AQUA, DARK_BLUE, BLUE, LIGHT_PURPLE, DARK_PURPLE, WHITE, GRAY, DARK_GRAY, BLACK endColor = "FUTURE_PURPLE" #Chat-related Customization [customization.chat] #Should a users' current dimension be added to chat messages? dimInChatName = true #Add a hover effect in chat that will display which mod added the dimension #Requires 'dimInChatName' to be set to true chatDimHover = true #Modded Dimension Customization [customization.modded] #A list of aliases to use instead of the original dimension ID. #Uses the format 'modid:dim_id New Name'. #For example, to replace 'Overworld' with 'Grasslands' you would use 'minecraft:overworld Grasslands' dimensionAliases = ["minecraft:the_end ULTIMA THULE"] #A list of modded dimension resource IDs and a color in the format of "modid:dim_id color" #For example, Twilight Forest in Gold would be "twilightforest:twilight_forest GOLD" #Will throw an exception if the color is not valid #Allowed Values: DARK_RED, RED, GOLD, YELLOW, DARK_GREEN, GREEN, AQUA, DARK_AQUA, DARK_BLUE, BLUE, LIGHT_PURPLE, DARK_PURPLE, WHITE, GRAY, DARK_GRAY, BLACK moddedDimensionIds = ["twilightforest:twilight_forest GOLD"] #Extra Customization [customization.extra] #Custom colors can be defined here. #Uses the format 'COLOR_NAME #HEX' or 'COLOR_NAME r000 g000 b000' #If a custom color of the same name already exists the server will reject the newest one. #The name must be uppercase and can only contain letters and underscores. custom_colors = ["HOT_PINK #C62F75", "FUTURE_PURPLE r152 g154 b255"] ```

Fabric Configuration

The Fabric configuration is stored and laid out differently to the (Neo)Forge configuration file due to having to write the saving and loading functions manually. Everything is the same in terms of settings, but there are no comments, unfortunately. This is something that I will try to change in the future. ```json { "listFormat": "%i<%d>", "dimensionPosition": "APPEND", "defaultColor": "HOT_PINK", "overworldColor": "DARK_GREEN", "netherColor": "FUTURE_PURPLE", "endColor": "HOT_PINK", "perDimColor": true, "dimInChatName": true, "chatDimHover": true, "enableAliases": true, "moddedDimensions": ["twilightforest:twilight_forest GOLD"], "dimensionAliases": ["minecraft:overworld %bThe Grasslands", "minecraft:the_nether %u%d", "minecraft:the_end %oEnd"], "customColors": ["HOT_PINK #C62F75", "FUTURE_PURPLE r152 g154 b255"] } ```

## Changelog ____

View Changelog

Version 2.1.0

Added slash commands!
Most (if not all) settings can now be changed without going to the config file with slash commands!
Fixed an issue with certain modid

Version 2.0.0

Now supports Fabric!
Now supports custom RGB and Hex font colours!
Simplified the format configuration
Dimension aliases now support tokens, allowing specific dimensions to be bold or italic, or both!

Version 1.4.0

Added support for dimension aliases! (Custom dimension names)

Version 1.3.1

Fixed a regex bug causing modids with underscores to not be valid.

Version 1.3.0

Added support for colouring individual modded dimensions!
Changed command 'refreshPlayerList' to 'refreshplayerlist' to fit better with vanilla command styling.

Version 1.2.0

Initial release!

Sick_Stick_10

Dimension Viewer