add spigot.yml docs

config/sidebar.paper.ts

@@ -58,6 +58,7 @@ const paper: SidebarsConfig = {
                 "admin/reference/configuration/global-configuration",
                 "admin/reference/configuration/world-configuration",
                 "admin/reference/configuration/server-properties",
+                "admin/reference/configuration/spigot-configuration",
               ],
             },
             "admin/reference/system-properties",

docs/paper/admin/reference/configuration/spigot-configuration.mdx

@@ -0,0 +1,298 @@
+---
+slug: /reference/server-configuration
+---
+
+# Spigot Configuration
+
+import React from 'react';
+import Config from '@site/src/components/Config';
+
+:::info
+
+The below YAML shows you the structure and default values for `spigot.yml`
+
+Click on a leaf node to view the description for that setting.
+
+:::
+
+<Config data={`
+advancements:
+  disable-saving:
+    default: "false"
+    description: prevents saving of advancements
+  disabled:
+    default: '[minecraft:story/disabled]'
+    description: |
+      a list of strings that are either:
+        fully qualified advancement resource locations
+        the literal "*"
+        an resource location namespace i.e. "minecraft"
+      if an advancement is disabled, without disabling any children, console errors occur on load
+commands:
+  log:
+    default: true
+    description: whether to log commands executed by players in chat or on signs
+  replace-commands:
+    default: "[setblock,summon,testforblock,tellraw]"
+    description: list of vanilla commands that should override any plugin commands
+  send-namespaced:
+    default: true
+    description: "whether to send namespaced commands to the client:"
+  silent-commandblock-console:
+    default: "false"
+    description: "whether to log vanilla command command feedback to console"
+  spam-exclusions:
+    default: "[/skill]"
+    description: |
+      List of commands starting with "/", or chat prefixes,
+      that if a command / chat message starts with it,
+      doesnt count towards the built in spam filter
+  tab-complete:
+    default: "0"
+    description: |
+      how many characters need to be typed before tab completion works
+      < 0 tabcompletion is disabled
+      =0 always tabcompletes all avalible commands
+      >0 only tabcompletes after n characters are types.
+      LIMITATIONS: since the list of commands are all sent at once to the client,
+      this is only effective for fully disabling (or maybe with older clients?.
+messages:
+  outdated-client:
+    default: Outdated client! Please use {0}
+    description: | # TODO when auto-versioned stuff (#212) is merged
+      the disconnect message for the player when they are unable to join
+      due to the server version being newer than the client version
+      replaces {0} with 1.20.1 (current server version)
+  outdated-server:
+    default: Outdated server! I'm still on {0}
+    description: |
+      the disconnect message for the player when they are unable to join
+      due to the server version being older than the client version
+      replaces {0} with 1.20.1 (current server version)
+  restart:
+    default: Server is restarting
+    description: |
+      the disconnect message for when
+      the player tries to join while the server is restarting
+      the player is logged on while the server starts restarting
+  server-full:
+    default: The server is full!
+    description: |
+      the disconnect message for the player when they are unable to join
+      due to the server not having any space (currentplayers >= max players)
+      formated with legacy "&" formatting, and "\\n" for newlines
+  unknown-command:
+    default: Unknown command. Type "/help" for help.
+    description: |
+      default message sent to player when a command is not found by the server
+      formated with legacy "&" formatting, and "\\n" for newlines
+  whitelist:
+    default: You are not whitelisted on this server!
+    description: |
+      the disconnect message of the player when:
+      the player fails to join while the whitelist is active
+      the player was kicked due to being removed from the whitelist with enforce-whitelist enabled
+      the player was kicked due to the whitelist enabling with enforce-whitelist enabled
+      formated with legacy "&" formatting, and "\\n" for newlines
+players: # TODO
+  disable-saving: false
+settings:
+  attribute:
+    attackDamage:
+      max:
+        default: 2048.0
+        description: overrides the maximum for the attackDamage attribute
+    maxHealth:
+      max:
+        default: 2048.0
+        description: overrides the maximum for the maxHealth attribute
+    movementSpeed:
+      max:
+        default: 2048.0
+        description: overrides the maximum for the movementSpeed attribute
+  bungeecord:
+    default: "false"
+    description: |
+      enabled proxy-online mode
+      support for unix domain socket binding,
+      support for bungee ip-forwarding
+  debug:
+    default: "false"
+    description: |
+      if enabled, sets log level to ALL
+  log-named-deaths:
+    default: true
+    description: whether to log deaths of entities with custom names to console and latest.log
+  log-villager-deaths:
+    default: true
+    description: whether to log villager deaths + lightning strikes to console and latest.log
+  moved-too-quickly-multiplier:
+    default: 10.0
+    description: unknown # TODO
+  moved-wrongly-threshold:
+    default: 0.0625
+    description: unknown # TODO
+  netty-threads:
+    default: 4
+    description: |
+      instructs netty how many threads to use for the eventloop
+  player-shuffle:
+    default: "0"
+    description: |
+      This prevents players from 'gaming' the server, and strategically relogging to increase their position in the tick order
+      <=0 = disable
+      >0 = every n ticks, the connections list is shuffled.
+      this can have a performance impact if enabled
+  restart-on-crash:
+    default: true
+    description: |
+      whether to call restart-script when the server is killed by the watchdog
+      doesnt affect if it gets externally killed (OOM/similar)
+  restart-script:
+    default: ./start.sh
+    description: |
+      file that is called with:
+        "cmd /c start {restart-script}" (windows)
+        "sh {restart-script}" (linux/macos)
+      see [this gist](https://gist.github.com/Prof-Bloodstone/6367eb4016eaf9d1646a88772cdbbac5) if you have issues with the server starting in the background
+  sample-count:
+    default: 12
+    description: |
+      Server Ping Player Sample Count
+      how many players to display in the client side-hover text in the server list
+  save-user-cache-on-stop-only:
+    default: "false"
+    description: if false it saves the user-cache on every update
+  timeout-time:
+    default: 60
+    description: |
+      set how long before the watchdog says the server has stopped responding, and restarts
+  user-cache-size:
+    default: 1000
+    description: how many players to keep in the user cache
+stats:
+  disable-saving:
+    default: "false"
+    description: prevent saving stats
+  forced-stats:
+    default: "{}"
+    description: | # TODO test with non-custom stats (registries like block/item), test expected key/format
+      <namespacedkey>: <int>
+world-settings: # TODO
+  default:
+    arrow-despawn-rate: 1200
+    below-zero-generation-in-existing-chunks: true
+    dragon-death-sound-radius: 0
+    enable-zombie-pigmen-portal-spawns: true
+    end-portal-sound-radius: 0
+    entity-activation-range:
+      animals: 32
+      flying-monsters: 32
+      ignore-spectators: false
+      misc: 16
+      monsters: 32
+      raiders: 48
+      tick-inactive-villagers: true
+      villagers: 32
+      villagers-active-for-panic: true
+      villagers-work-immunity-after: 100
+      villagers-work-immunity-for: 20
+      wake-up-inactive:
+        animals-every: 1200
+        animals-for: 100
+        animals-max-per-tick: 4
+        flying-monsters-every: 200
+        flying-monsters-for: 100
+        flying-monsters-max-per-tick: 8
+        monsters-every: 400
+        monsters-for: 100
+        monsters-max-per-tick: 8
+        villagers-every: 600
+        villagers-for: 100
+        villagers-max-per-tick: 4
+      water: 16
+    entity-tracking-range:
+      animals: 48
+      display: 128
+      misc: 32
+      monsters: 48
+      other: 64
+      players: 48
+    growth:
+      bamboo-modifier: 100
+      beetroot-modifier: 100
+      cactus-modifier: 100
+      cane-modifier: 100
+      carrot-modifier: 100
+      cavevines-modifier: 100
+      cocoa-modifier: 100
+      glowberry-modifier: 100
+      kelp-modifier: 100
+      melon-modifier: 100
+      mushroom-modifier: 100
+      netherwart-modifier: 100
+      pitcherplant-modifier: 100
+      potato-modifier: 100
+      pumpkin-modifier: 100
+      sapling-modifier: 100
+      sweetberry-modifier: 100
+      torchflower-modifier: 100
+      twistingvines-modifier: 100
+      vine-modifier: 100
+      weepingvines-modifier: 100
+      wheat-modifier: 100
+    hanging-tick-frequency: 100
+    hopper-amount: 1
+    hopper-can-load-chunks: false
+    hunger:
+      combat-exhaustion: 0.1
+      jump-sprint-exhaustion: 0.2
+      jump-walk-exhaustion: 0.05
+      other-multiplier: 0.0
+      regen-exhaustion: 6.0
+      sprint-multiplier: 0.1
+      swim-multiplier: 0.01
+    item-despawn-rate: 6000
+    max-tick-time:
+      entity: 50
+      tile: 50
+    max-tnt-per-tick: 100
+    merge-radius:
+      exp: 3.0
+      item: 2.5
+    mob-spawn-range: 8
+    nerf-spawner-mobs: false
+    seed-ancientcity: 20083232
+    seed-buriedtreasure: 10387320
+    seed-desert: 14357617
+    seed-endcity: 10387313
+    seed-fossil: 14357921
+    seed-igloo: 14357618
+    seed-jungle: 14357619
+    seed-mansion: 10387319
+    seed-mineshaft: default
+    seed-monument: 10387313
+    seed-nether: 30084232
+    seed-ocean: 14357621
+    seed-outpost: 165745296
+    seed-portal: 34222645
+    seed-shipwreck: 165745295
+    seed-slime: 987234911
+    seed-stronghold: default
+    seed-swamp: 14357620
+    seed-trailruins: 83469867
+    seed-village: 10387312
+    simulation-distance: default
+    thunder-chance: 100000
+    ticks-per:
+      hopper-check: 1
+      hopper-transfer: 8
+    trident-despawn-rate: 1200
+    verbose: false
+    view-distance: default
+    wither-spawn-sound-radius: 0
+    zombie-aggressive-towards-villager: true
+config-version:
+  default: 12
+  description: "do not touch"
+`}></Config>

src/components/Config.tsx

@@ -180,7 +180,7 @@ const renderYamlData = (data, parentKey, root = false, separator) => {
 
     for (const [key, value] of Object.entries(data)) {
         if (typeof value === 'object') {
-            if ('default' in value || 'description' in value) {
+            if (('default' in value && typeof value.default !== 'object') || ('description' in value && typeof value.description !== 'object')) {
                 renderedNodes.push(<YamlNodeWithDescription key={key} name={key} parentKey={parentKey} node={value} root={root} separator={separator} />);
             } else {
                 renderedNodes.push(YamlTreeNode({ root, key, parentKey, value, separator }));