Skip to content

TPS ​

Module info
Configurationtps in config.yml
ManagerTPSManager
Support1.8+
Free versionâś”
Proxy-configurable❌

This module allows players to check the server's current TPS and offers custom placeholders. It is possible to configure ranges to colorize the TPS based on its value.

Setup ​

The following snippet of code represents and explains the TPS's configuration.

yaml
# ...ping's settings...
tps: 
  update-timeout-ms: 5000 # timeout between updates, in milliseconds
  20-tps-cap:
    enabled: false # whether to cap TPS to 20.0
    add-wildcard: false # whether to add * before the number if it exceeds 20.0
  enable-command: true # whether to override Spigot's /tps (not applicable on Sponge)
  qualities:
    excellent: 19.5 # first quality's minimum TPS (19.5+)
    great: 19 # second quality's minimum TPS (19.0-19.4Ě…9)
    good: 18
    poor: 17
    bad: 16 # ... (16.0-16.Ě…9)
    unplayable: 15 # ... (0-15.Ě…9)
# ...vanish's settings...

The first and last qualities determine the first and last TPS ranges (19.5+, 0-15.Ě…9).

Adding qualities ​

To add a new quality or range, you just need to specify its ID and its minimum TPS.

yaml
# ...TPS's settings...
  qualities: 
    new-quality: 19.7
    # ...default qualities...
# ...vanish's settings...

NOTE

Order does matter in the configuration above: make sure to insert new qualities in the correct place; example: 19.7 > 19.5, so put it first.

Once done, open messages.yml and any custom messages files present and insert the new quality's ID, color and text at tps-qualities:

yaml
# ...ping's messages...
tps-qualities: 
  # ...default qualities...
  new-quality: '&9' # new quality's ID and color
# ...vanish's messages...

/tps command ​

It is possible to check the server's current TPS using the /tps command:

/tps example

Refer to the Getting started/Commands/Misc page for more info.

ChatPlugin - A complete yet lightweight plugin which handles just too many features!
© 2024  Remigio07
This wiki is currently updated to version 1.9.4.
Please report any errors, mistakes and misspellings as described at Home/Reporting issues.

Remigio07.me - built w/ VitePress