direct people to YouHaveTrouble's guide

3 years ago · f67a9b8e3d
2 changed files with 66 additions and 66 deletions
--- a/cogs/timings.py
+++ b/cogs/timings.py
@ -27,7 +27,7 @@ class Timings(commands.Cog):
 async def analyze_timings(self, message):
 words = message.content.replace("\n", " ").split(" ")
 timings_url = ""
- embed_var = discord.Embed(title=self.TIMINGS_TITLE)
+ embed_var = discord.Embed(title=self.TIMINGS_TITLE, description="These are not magic values. Many of these settings have real consequences on your server's mechanics. See [YouHaveTrouble's guide](https://github.com/YouHaveTrouble/minecraft-optimization/blob/main/README.md) for detailed information on the functionality of each setting.")
 embed_var.set_footer(text=f"Requested by {message.author.name}#{message.author.discriminator}", icon_url=message.author.avatar_url)

 for word in words:
@ -267,12 +267,12 @@ class Timings(commands.Cog):
 if ntvd <= tvd and tvd >= 5:
 if spigot["world-settings"]["default"]["view-distance"] == "default":
 embed_var.add_field(name="❌ no-tick-view-distance",
- value=f"Set in [paper.yml](http://bit.ly/paperconf). Recommended: {tvd}. "
- f"And reduce view-distance from default ({tvd}) in [spigot.yml](http://bit.ly/spiconf). Recommended: 4.")
+ value=f"Set in paper.yml. Recommended: {tvd}. "
+ f"And reduce view-distance from default ({tvd}) in spigot.yml. Recommended: 4.")
 else:
 embed_var.add_field(name="❌ no-tick-view-distance",
- value=f"Set in [paper.yml](http://bit.ly/paperconf). Recommended: {tvd}. "
- f"And reduce view-distance from {tvd} in [spigot.yml](http://bit.ly/spiconf). Recommended: 4.")
+ value=f"Set in paper.yml. Recommended: {tvd}. "
+ f"And reduce view-distance from {tvd} in spigot.yml. Recommended: 4.")
 break
 except KeyError as key:
 logging.info("Missing: " + str(key))
--- a/cogs/timings_check.yml
+++ b/cogs/timings_check.yml
@ -123,7 +123,7 @@ plugins:
 prefix: "❌"
 value: |-
 You probably don't need PhantomSMP as Paper already has its features.
- Enable phantoms-only-attack-insomniacs in [paper.yml](http://bit.ly/paperconf).
+ Enable phantoms-only-attack-insomniacs in paper.yml.
 tuinity:
 PacketLimiter:
 prefix: "❌"
@ -142,7 +142,7 @@ plugins:
 prefix: "❌"
 value: |-
 You probably don't need VillagerLobotomizatornator as Purpur already adds its features. 
- Enable villager.lobotomize.enabled in [purpur.yml](http://bit.ly/purpurc).
+ Enable villager.lobotomize.enabled in purpur.yml.
 config:
 server.properties:
 online-mode:
@ -151,239 +151,239 @@ config:
 - spigot["settings"]["bungeecord"] == "false"
 - paper["settings"]["velocity-support"]["online-mode"] == "false" or paper["settings"]["velocity-support"]["enabled"] == "false"
 prefix: "❌"
- value: "Enable this in [server.properties](http://bit.ly/servprop) for security."
+ value: "Enable this in server.properties for security."
 network-compression-threshold:
 - expressions:
 - int(server_properties["network-compression-threshold"]) <= 256
 - spigot["settings"]["bungeecord"] == "false"
 prefix: "❌"
- value: "Increase this in [server.properties](http://bit.ly/servprop). Recommended: 512."
+ value: "Increase this in server.properties. Recommended: 512."
 bukkit:
 chunk-gc.period-in-ticks:
 - expressions:
 - int(bukkit["chunk-gc"]["period-in-ticks"]) >= 600
 prefix: "❌"
- value: "Decrease this in [bukkit.yml](https://bukkit.gamepedia.com/Bukkit.yml).\nRecommended: 400."
+ value: "Decrease this in bukkit.yml.\nRecommended: 400."
 ticks-per.monster-spawns:
 - expressions:
 - int(bukkit["ticks-per"]["monster-spawns"]) == 1
 prefix: "❌"
- value: "Increase this in [bukkit.yml](https://bukkit.gamepedia.com/Bukkit.yml).\nRecommended: 4."
+ value: "Increase this in bukkit.yml.\nRecommended: 4."
 spawn-limits.monsters:
 - expressions:
 - int(bukkit["spawn-limits"]["monsters"]) >= 70
 prefix: "❌"
- value: "Decrease this in [bukkit.yml](https://bukkit.gamepedia.com/Bukkit.yml).\nRecommended: 15."
+ value: "Decrease this in bukkit.yml.\nRecommended: 15."
 spawn-limits.water-ambient:
 - expressions:
 - int(bukkit["spawn-limits"]["water-ambient"]) >= 20
 prefix: "❌"
- value: "Decrease this in [bukkit.yml](https://bukkit.gamepedia.com/Bukkit.yml).\nRecommended: 5."
+ value: "Decrease this in bukkit.yml.\nRecommended: 5."
 spawn-limits.ambient:
 - expressions:
 - int(bukkit["spawn-limits"]["ambient"]) >= 15
 prefix: "❌"
- value: "Decrease this in [bukkit.yml](https://bukkit.gamepedia.com/Bukkit.yml).\nRecommended: 1."
+ value: "Decrease this in bukkit.yml.\nRecommended: 1."
 spawn-limits.animals:
 - expressions:
 - int(bukkit["spawn-limits"]["animals"]) >= 10
 prefix: "❌"
- value: "Decrease this in [bukkit.yml](https://bukkit.gamepedia.com/Bukkit.yml).\nRecommended: 5."
+ value: "Decrease this in bukkit.yml.\nRecommended: 5."
 spawn-limits.water-animals:
 - expressions:
 - int(bukkit["spawn-limits"]["water-animals"]) >= 15
 prefix: "❌"
- value: "Decrease this in [bukkit.yml](https://bukkit.gamepedia.com/Bukkit.yml).\nRecommended: 5."
+ value: "Decrease this in bukkit.yml.\nRecommended: 5."
 spigot:
 view-distance:
 - expressions:
 - int(server_properties["view-distance"]) >= 10
 - spigot["world-settings"]["default"]["view-distance"] == "default"
 prefix: "❌"
- value: "Decrease this from default (10) in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 4."
+ value: "Decrease this from default (10) in spigot.yml.\nRecommended: 4."
 entity-activation-range.animals:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["animals"]) >= 32
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 16."
+ value: "Decrease this in spigot.yml.\nRecommended: 16."
 entity-activation-range.monsters:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["monsters"]) >= 32
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 16."
+ value: "Decrease this in spigot.yml.\nRecommended: 16."
 entity-activation-range.misc:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["misc"]) >= 16
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 12."
+ value: "Decrease this in spigot.yml.\nRecommended: 12."
 entity-activation-range.water:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["water"]) >= 16
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 12."
+ value: "Decrease this in spigot.yml.\nRecommended: 12."
 entity-activation-range.villagers:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["villagers"]) >= 32
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 16."
+ value: "Decrease this in spigot.yml.\nRecommended: 16."
 entity-activation-range.tick-inactive-villagers:
 - expressions:
 - spigot["world-settings"]["default"]["entity-activation-range"]["tick-inactive-villagers"] == "true"
 prefix: "❌"
- value: "Disable this in [spigot.yml](http://bit.ly/spiconf)."
+ value: "Disable this in spigot.yml."
 entity-activation-range.wake-up-inactive.villagers-for:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["villagers-max-per-tick"]) >= 1
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["villagers-for"]) >= 100
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 20."
+ value: "Decrease this in spigot.yml.\nRecommended: 20."
 entity-activation-range.wake-up-inactive.flying-monsters-for:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["flying-monsters-max-per-tick"]) >= 1
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["flying-monsters-for"]) >= 100
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 60."
+ value: "Decrease this in spigot.yml.\nRecommended: 60."
 entity-activation-range.wake-up-inactive.villagers-max-per-tick:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["villagers-max-per-tick"]) >= 4
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 1."
+ value: "Decrease this in spigot.yml.\nRecommended: 1."
 entity-activation-range.wake-up-inactive.animals-for:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["animals-max-per-tick"]) >= 1
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["animals-for"]) >= 100
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 40."
+ value: "Decrease this in spigot.yml.\nRecommended: 40."
 entity-activation-range.wake-up-inactive.monsters-max-per-tick:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["monsters-max-per-tick"]) >= 8
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 4."
+ value: "Decrease this in spigot.yml.\nRecommended: 4."
 entity-activation-range.wake-up-inactive.flying-monsters-max-per-tick:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["flying-monsters-max-per-tick"]) >= 8
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 1."
+ value: "Decrease this in spigot.yml.\nRecommended: 1."
 entity-activation-range.wake-up-inactive.animals-max-per-tick:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["animals-max-per-tick"]) >= 4
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 2."
+ value: "Decrease this in spigot.yml.\nRecommended: 2."
 entity-activation-range.wake-up-inactive.monsters-for:
 - expressions:
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["monsters-max-per-tick"]) >= 1
 - int(spigot["world-settings"]["default"]["entity-activation-range"]["wake-up-inactive"]["monsters-for"]) >= 100
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 60."
+ value: "Decrease this in spigot.yml.\nRecommended: 60."
 arrow-despawn-rate:
 - expressions:
 - int(spigot["world-settings"]["default"]["arrow-despawn-rate"]) >= 1200
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 300."
+ value: "Decrease this in spigot.yml.\nRecommended: 300."
 merge-radius.item:
 - expressions:
 - float(spigot["world-settings"]["default"]["merge-radius"]["item"]) <= 2.5
 prefix: "❌"
- value: "Increase this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 4.0."
+ value: "Increase this in spigot.yml.\nRecommended: 4.0."
 merge-radius.exp:
 - expressions:
 - float(spigot["world-settings"]["default"]["merge-radius"]["exp"]) <= 3.0
 prefix: "❌"
- value: "Increase this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 6.0."
+ value: "Increase this in spigot.yml.\nRecommended: 6.0."
 max-entity-collisions:
 - expressions:
 - int(spigot["world-settings"]["default"]["max-entity-collisions"]) >= 8
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: 2."
+ value: "Decrease this in spigot.yml.\nRecommended: 2."
 mob-spawn-range:
 - expressions:
 - spigot["world-settings"]["default"]["view-distance"] == "default"
 - int(spigot["world-settings"]["default"]["mob-spawn-range"]) >= 8
 - int(server_properties["view-distance"]) <= 6
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: {int(server_properties[\"view-distance\"]) - 1}."
+ value: "Decrease this in spigot.yml.\nRecommended: {int(server_properties[\"view-distance\"]) - 1}."
 - expressions:
 - int(spigot["world-settings"]["default"]["mob-spawn-range"]) >= 8
 - spigot["world-settings"]["default"]["view-distance"] != "default"
 - int(spigot["world-settings"]["default"]["view-distance"]) <= 6
 prefix: "❌"
- value: "Decrease this in [spigot.yml](http://bit.ly/spiconf).\nRecommended: {int(spigot[\"world-settings\"][\"default\"][\"view-distance\"]) - 1}."
+ value: "Decrease this in spigot.yml.\nRecommended: {int(spigot[\"world-settings\"][\"default\"][\"view-distance\"]) - 1}."
 paper:
 max-auto-save-chunks-per-tick:
 - expressions:
 - int(paper["world-settings"]["default"]["max-auto-save-chunks-per-tick"]) >= 24
 prefix: "❌"
- value: "Decrease this in [paper.yml](http://bit.ly/paperconf).\nRecommended: 6."
+ value: "Decrease this in paper.yml.\nRecommended: 6."
 optimize-explosions:
 - expressions:
 - paper["world-settings"]["default"]["optimize-explosions"] == "false"
 prefix: "❌"
- value: "Enable this in [paper.yml](http://bit.ly/paperconf)."
+ value: "Enable this in paper.yml."
 mob-spawner-tick-rate:
 - expressions:
 - int(paper["world-settings"]["default"]["mob-spawner-tick-rate"]) == 1
 prefix: "❌"
- value: "Increase this in [paper.yml](http://bit.ly/paperconf).\nRecommended: 2."
+ value: "Increase this in paper.yml.\nRecommended: 2."
 game-mechanics.disable-chest-cat-detection:
 - expressions:
 - paper["world-settings"]["default"]["game-mechanics"]["disable-chest-cat-detection"] == "false"
 prefix: "❌"
- value: "Enable this in [paper.yml](http://bit.ly/paperconf)"
+ value: "Enable this in paper.yml"
 container-update-tick-rate:
 - expressions:
 - int(paper["world-settings"]["default"]["container-update-tick-rate"]) == 1
 prefix: "❌"
- value: "Increase this in [paper.yml](http://bit.ly/paperconf).\nRecommended: 3."
+ value: "Increase this in paper.yml.\nRecommended: 3."
 grass-spread-tick-rate:
 - expressions:
 - int(paper["world-settings"]["default"]["grass-spread-tick-rate"]) == 1
 prefix: "❌"
- value: "Increase this in [paper.yml](http://bit.ly/paperconf).\nRecommended: 4."
+ value: "Increase this in paper.yml.\nRecommended: 4."
 despawn-ranges.soft:
 - expressions:
 - int(paper["world-settings"]["default"]["despawn-ranges"]["soft"]) >= 32
 prefix: "❌"
- value: "Decrease this in [paper.yml](http://bit.ly/paperconf).\nRecommended: 28."
+ value: "Decrease this in paper.yml.\nRecommended: 28."
 despawn-ranges.hard:
 - expressions:
 - int(paper["world-settings"]["default"]["despawn-ranges"]["hard"]) >= 128
 prefix: "❌"
- value: "Decrease this in [paper.yml](http://bit.ly/paperconf).\nRecommended: 96."
+ value: "Decrease this in paper.yml.\nRecommended: 96."
 hopper.disable-move-event:
 - expressions:
 - paper["world-settings"]["default"]["hopper"]["disable-move-event"] == "false"
 prefix: "❌"
- value: "Enable this in [paper.yml](http://bit.ly/paperconf)"
+ value: "Enable this in paper.yml"
 non-player-arrow-despawn-rate:
 - expressions:
 - int(paper["world-settings"]["default"]["non-player-arrow-despawn-rate"]) == -1
 prefix: "❌"
- value: "Set a value in [paper.yml](http://bit.ly/paperconf).\nRecommended: 60"
+ value: "Set a value in paper.yml.\nRecommended: 60"
 creative-arrow-despawn-rate:
 - expressions:
 - int(paper["world-settings"]["default"]["creative-arrow-despawn-rate"]) == -1
 prefix: "❌"
- value: "Set a value in [paper.yml](http://bit.ly/paperconf).\nRecommended: 60"
+ value: "Set a value in paper.yml.\nRecommended: 60"
 prevent-moving-into-unloaded-chunks:
 - expressions:
 - paper["world-settings"]["default"]["prevent-moving-into-unloaded-chunks"] == "false"
 prefix: "❌"
- value: "Enable this in [paper.yml](http://bit.ly/paperconf)."
+ value: "Enable this in paper.yml."
 use-faster-eigencraft-redstone:
 - expressions:
 - paper["world-settings"]["default"]["use-faster-eigencraft-redstone"] == "false"
 prefix: "❌"
- value: "Enable this in [paper.yml](http://bit.ly/paperconf)."
+ value: "Enable this in paper.yml."
 fix-climbing-bypassing-cramming-rule:
 - expressions:
 - paper["world-settings"]["default"]["fix-climbing-bypassing-cramming-rule"] == "false"
 prefix: "❌"
- value: "Enable this in [paper.yml](http://bit.ly/paperconf)."
+ value: "Enable this in paper.yml."
 armor-stands-do-collision-entity-lookups:
 - expressions:
 - paper["world-settings"]["default"]["armor-stands-do-collision-entity-lookups"] == "true"
 prefix: "❌"
- value: "Disable this in [paper.yml](http://bit.ly/paperconf)."
+ value: "Disable this in paper.yml."
 armor-stands-tick:
 - expressions:
 - paper["world-settings"]["default"]["armor-stands-tick"] == "true"
@ -391,71 +391,71 @@ config:
 - '"BlockBalls" not in plugins'
 - '"ArmorStandTools" not in plugins'
 prefix: "❌"
- value: "Disable this in [paper.yml](http://bit.ly/paperconf)."
+ value: "Disable this in paper.yml."
 per-player-mob-spawns:
 - expressions:
 - paper["world-settings"]["default"]["per-player-mob-spawns"] == "false"
 prefix: "❌"
- value: "Enable this in [paper.yml](http://bit.ly/paperconf)."
+ value: "Enable this in paper.yml."
 alt-item-despawn-rate.enabled:
 - expressions:
 - paper["world-settings"]["default"]["alt-item-despawn-rate"]["enabled"] == "false"
 prefix: "❌"
- value: "Enable this in [paper.yml](http://bit.ly/paperconf)."
+ value: "Enable this in paper.yml."
 entity-per-chunk-save-limit.experience_orb:
 - expressions:
 - int(paper["world-settings"]["default"]["entity-per-chunk-save-limit"]["experience_orb"]) == -1
 prefix: "❌"
- value: "Set a value in [paper.yml](https://github.com/PaperMC/Paper/pull/4792). Recommended: 16."
+ value: "Set a value in paper.yml. Recommended: 16."
 entity-per-chunk-save-limit.snowball:
 - expressions:
 - int(paper["world-settings"]["default"]["entity-per-chunk-save-limit"]["snowball"]) == -1
 prefix: "❌"
- value: "Set a value in [paper.yml](https://github.com/PaperMC/Paper/pull/4792). Recommended: 16."
+ value: "Set a value in paper.yml. Recommended: 16."
 entity-per-chunk-save-limit.ender_pearl:
 - expressions:
 - int(paper["world-settings"]["default"]["entity-per-chunk-save-limit"]["ender_pearl"]) == -1
 prefix: "❌"
- value: "Set a value in [paper.yml](https://github.com/PaperMC/Paper/pull/4792). Recommended: 16."
+ value: "Set a value in paper.yml. Recommended: 16."
 entity-per-chunk-save-limit.arrow:
 - expressions:
 - int(paper["world-settings"]["default"]["entity-per-chunk-save-limit"]["arrow"]) == -1
 prefix: "❌"
- value: "Set a value in [paper.yml](https://github.com/PaperMC/Paper/pull/4792). Recommended: 16."
+ value: "Set a value in paper.yml. Recommended: 16."
 purpur:
 settings.use-alternate-keepalive:
 - expressions:
 - purpur["settings"]["use-alternate-keepalive"] == "false"
 - '"TCPShield" not in plugins'
 prefix: "❌"
- value: "Enable this in [purpur.yml](http://bit.ly/purpurc)."
+ value: "Enable this in purpur.yml."
 - expressions:
 - purpur["settings"]["use-alternate-keepalive"] == "true"
 - '"TCPShield" in plugins'
 prefix: "❌"
- value: "Disable this in [purpur.yml](http://bit.ly/purpurc). It can cause issues with TCPShield"
+ value: "Disable this in purpur.yml. It can cause issues with TCPShield"
 settings.dont-send-useless-entity-packets:
 - expressions:
 - purpur["settings"]["dont-send-useless-entity-packets"] == "false"
 prefix: "❌"
- value: "Enable this in [purpur.yml](http://bit.ly/purpurc)."
+ value: "Enable this in purpur.yml."
 mobs.villager.brain-ticks:
 - expressions:
 - int(purpur["world-settings"]["default"]["mobs"]["villager"]["brain-ticks"]) == 1
 prefix: "❌"
- value: "Increase this in [purpur.yml](http://bit.ly/purpurc).\nRecommended: 4."
+ value: "Increase this in purpur.yml.\nRecommended: 4."
 mobs.villager.spawn-iron-golem.radius:
 - expressions:
 - int(purpur["world-settings"]["default"]["mobs"]["villager"]["spawn-iron-golem"]["radius"]) == 0
 prefix: "❌"
- value: "Increase this in [purpur.yml](http://bit.ly/purpurc).\nRecommended: 5."
+ value: "Increase this in purpur.yml.\nRecommended: 5."
 mobs.zombie.aggressive-towards-villager-when-lagging:
 - expressions:
 - purpur["world-settings"]["default"]["mobs"]["zombie"]["aggressive-towards-villager-when-lagging"] == "true"
 prefix: "❌"
- value: "Disable this in [purpur.yml](http://bit.ly/purpurc)."
+ value: "Disable this in purpur.yml."
 gameplay-mechanics.player.teleport-if-outside-border:
 - expressions:
 - purpur["world-settings"]["default"]["gameplay-mechanics"]["player"]["teleport-if-outside-border"] == "false"
 prefix: "❌"
- value: "Enable this in [purpur.yml](http://bit.ly/purpurc)."
+ value: "Enable this in purpur.yml."