diff --git a/README.md b/README.md index 4a5ce7b..208fa95 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ [![](http://cf.way2muchnoise.eu/better-ping-display-fabric.svg)](https://curseforge.com/minecraft/mc-mods/better-ping-display-fabric) [![](http://cf.way2muchnoise.eu/versions/better-ping-display-fabric.svg)](https://curseforge.com/minecraft/mc-mods/better-ping-display-fabric) -A [Fabric](https://fabricmc.net/) mod for Minecraft to display each player's ping in the player list as a number. There is also a config file -for changing the text color and format. +A [Fabric](https://fabricmc.net/) mod for Minecraft to display each player's ping in the player list as a number. Go [**here**](https://github.com/vladmarica/better-ping-display) for the Minecraft Forge edition of this mod. @@ -11,9 +10,19 @@ Go [**here**](https://github.com/vladmarica/better-ping-display) for the Minecra This is a client-side mod. The server doesn't need to have it installed. It works even when playing on vanilla servers. +## Configuration +This mod's config file is `betterpingdisplay.json`. It contains the following options: + +| Option | Default Value | Description | +|---|---|---| +| autoColorPingText | `true` | Whether to color a player's ping based on their latency. E.g, low latency = green, high latency = red | +| renderPingBars | `false` | Whether to also draw the default Minecraft ping bars | +| pingTextColor | `#A0A0A0` | The ping text color to use. Only works whens `autoColorPingText` is false | +| pingTextFormatString | `%dms` | The format string for ping text. Must include a `%d`, which will be replaced dynamically by the actual ping value. + ## Supported Minecraft Versions * **1.15.x** - +* **1.16.x** ## Requirements * [Fabric](https://fabricmc.net/)