chore: housekeeping (fixing issues) (#574)

* fix: #487, #526

* feat: contextual social icons

* fix: rewrite internals page

* feat: add missing configuration values

* chore: more forgotten changes

* fix: ItemStack roadmap

* fix: #356

* chore: turn off TOCs for index pages

* chore: turn off TOCs for index pages

* fix: prevent expressive-code from removing leading comments

* refactor: use Starlight FileTree to describe file trees

Author: zlataovce

CONTRIBUTING.md

@@ -128,11 +128,21 @@ There are quite a few constants you may want to use in your pages, such as the l
 These constants can be imported and used in MDX, like so:
 
 ```mdxjs
-import { LATEST_MC_RELEASE, LATEST_PAPER_RELEASE, LATEST_VELOCITY_RELEASE } from "/src/utils/versions";
+import {
+  LATEST_MC_RELEASE,
+  LATEST_PAPER_RELEASE,
+  LATEST_VELOCITY_RELEASE,
+  LATEST_FOLIA_RELEASE,
+  LATEST_WATERFALL_RELEASE,
+  LATEST_USERDEV_RELEASE,
+} from "/src/utils/versions";
 
 Latest Paper version is {LATEST_PAPER_RELEASE}.
 Latest Velocity version is {LATEST_VELOCITY_RELEASE}.
 Latest Minecraft version is {LATEST_MC_RELEASE}.
+Latest Folia version is {LATEST_FOLIA_RELEASE}.
+Latest Waterfall version is {LATEST_WATERFALL_RELEASE}.
+Latest `paperweight-userdev` version is {LATEST_USERDEV_RELEASE}.
 ```
 
 If you want to perform these replacements in code blocks, you need to use a special `replace` meta property.

astro.config.ts

@@ -47,6 +47,7 @@ export default defineConfig({
         Banner: "./src/components/overrides/Banner.astro",
         TableOfContents: "./src/components/overrides/TableOfContents.astro",
         MobileTableOfContents: "./src/components/overrides/MobileTableOfContents.astro",
+        SocialIcons: "./src/components/overrides/SocialIcons.astro",
       },
       plugins: [
         starlightLinksValidator({
@@ -382,6 +383,9 @@ export default defineConfig({
         ),
       ],
       expressiveCode: {
+        frames: {
+          extractFileNameFromCode: false,
+        },
         emitExternalStylesheet: false,
       },
     }),

src/components/PageCards.astro

@@ -39,7 +39,7 @@ const pages: Page[] = (await getCollection(Astro.locals.starlightRoute.entry.col
   {
     pages.map((p) => (
       <LinkCard
-        title={p.title}
+        title={(p.group ? "🗃️ " : "") + p.title}
         description={p.description ?? (p.group ? "(documentation group)" : undefined)}
         href={p.href}
       />

src/components/overrides/SocialIcons.astro

@@ -0,0 +1,52 @@
+---
+import config from "virtual:starlight/user-config";
+import { Icon } from "@astrojs/starlight/components";
+import { LATEST_RELEASES } from "../../utils/versions";
+
+const { isPageWithTopic, topics } = Astro.locals.starlightSidebarTopics;
+const currentTopic = isPageWithTopic ? topics.find((t) => t.isCurrent) : null;
+
+const links = (config.social || []).map((link) => {
+  const project = currentTopic?.label?.toLowerCase();
+  if (!project) {
+    return link;
+  }
+
+  const version = LATEST_RELEASES[project];
+  if (!version) {
+    return link;
+  }
+
+  switch (link.label) {
+    case "Javadoc":
+      return { ...link, href: `${link.href}/${project}/${version}` };
+    case "GitHub":
+      return { ...link, href: `${link.href}/${project}` };
+  }
+  return link;
+});
+---
+
+{
+  links.length > 0 && (
+    <>
+      {links.map(({ label, href, icon }) => (
+        <a {href} rel="me" class="sl-flex">
+          <span class="sr-only">{label}</span>
+          <Icon name={icon} />
+        </a>
+      ))}
+    </>
+  )
+}
+
+<style>
+  a {
+    color: var(--sl-color-text-accent);
+    padding: 0.5em;
+    margin: -0.5em;
+  }
+  a:hover {
+    opacity: 0.66;
+  }
+</style>

src/config/paper/paper-global.yml

@@ -57,6 +57,20 @@ block-updates:
       Disabling block updates leads to tripwires no longer updating their block
       state, allowing for technically invalid tripwires to remain in the world,
       which might be useful for mapmakers.
+  disable-chorus-plant-updates:
+    default: "false"
+    description: >-
+      Whether to disable any form of block updates for chorus plants on the
+      server. Disabling block updates leads to chorus plants no longer updating their block
+      state, allowing for technically invalid chorus plant configurations to remain in the world,
+      which might be useful for mapmakers.
+  disable-mushroom-block-updates:
+    default: "false"
+    description: >-
+      Whether to disable any form of block updates for mushroom blocks on the
+      server. Disabling block updates leads to mushroom blocks no longer updating their block
+      state, allowing for technically invalid mushroom block configurations to remain in the world,
+      which might be useful for mapmakers.
 chunk-loading-advanced:
   auto-config-send-distance:
     default: "true"
@@ -523,6 +537,9 @@ unsupported-settings:
       This setting controls if equipment should be updated when handling certain player
       actions. If set to false this will allow players to exploit attributes by e.g.
       switching equipment before using it.
+  simplify-remote-item-matching:
+    default: "false"
+    description: Only checks an item's amount and type instead of its full data during inventory desync checks.
 watchdog:
   early-warning-delay:
     default: "10000"

src/config/paper/paper-world-defaults.yml

@@ -249,6 +249,11 @@ entities:
       vanilla: "false"
       default: "true"
       description: "Prevents phantoms from attacking players who have slept "
+    player-insomnia-start-ticks:
+      default: "72000"
+      description: |
+        Number of ticks a player must stay awake before phantoms can start spawning.
+        Default (72000) is 3 Minecraft days, -1 disables phantom spawning.
     piglins-guard-chests:
       default: "true"
       description: If piglins should attempt to guard chests when angered
@@ -357,6 +362,42 @@ entities:
       description: >-
         The rate, in ticks, at which arrows shot from players in creative mode
         are despawned
+    ticks-per-spawn:
+      ambient:
+        default: "-1"
+        description: |
+          Determines how many ticks there are between attempts to spawn ambient mobs (bats).
+          Default (-1) uses Vanilla spawn rate.
+      axolotls:
+        default: "-1"
+        description: |
+          Determines how many ticks there are between attempts to spawn axolotls.
+          Default (-1) uses Vanilla spawn rate.
+      creature:
+        default: "-1"
+        description: |
+          Determines how many ticks there are between attempts to spawn passive creatures (animals).
+          Default (-1) uses Vanilla spawn rate.
+      monster:
+        default: "-1"
+        description: |
+          Determines how many ticks there are between attempts to spawn hostile monsters.
+          Default (-1) uses Vanilla spawn rate.
+      underground_water_creature:
+        default: "-1"
+        description: |
+          Determines how many ticks there are between attempts to spawn underground water creatures (glow squid).
+          Default (-1) uses Vanilla spawn rate.
+      water_ambient:
+        default: "-1"
+        description: |
+          Determines how many ticks there are between attempts to spawn ambient water mobs (tropical fish).
+          Default (-1) uses Vanilla spawn rate.
+      water_creature:
+        default: "-1"
+        description: |
+          Determines how many ticks there are between attempts to spawn water creatures (squid, dolphins).
+          Default (-1) uses Vanilla spawn rate.
     despawn-range-shape:
       default: ELLIPSOID
       description: >-
@@ -1026,6 +1067,18 @@ tick-rates:
     description: >-
       How often mob spawners should tick to calculate available spawn areas and
       spawn new entities into the world. A value of -1 will disable all spawners
+  dry-farmland:
+    default: "1"
+    description: |
+      Controls how frequently dry farmland blocks are ticked.
+      Higher values slow down the rate at which farmland checks for moisture updates.
+      Default (1) uses Vanilla behavior, -1 disables dry farmland random ticks.
+  wet-farmland:
+    default: "1"
+    description: |
+      Controls how frequently wet farmland blocks are ticked.
+      Higher values slow down the rate at which farmland checks for moisture updates.
+      Default (1) uses Vanilla behavior, -1 disables wet farmland random ticks.
   sensor:
     villager:
       secondarypoisensor:

src/config/paper/server-properties.yml

@@ -229,6 +229,11 @@ sync-chunk-writes:
 text-filtering-config:
   default: ""
   description: "The path to the text filtering configuration file. Leave blank to disable text filtering."
+text-filtering-version:
+  default: "0"
+  description: |
+    The version of the configuration format used for [`text-filtering-config`](#text_filtering_config).
+    Valid values are 0 and 1.
 use-native-transport:
   default: "true"
   description: "Provides a performance boost for Linux servers."

src/config/paper/spigot.yml

@@ -39,6 +39,9 @@ commands:
   silent-commandblock-console:
     default: "false"
     description: Whether to log Vanilla command feedback to the Console.
+  enable-spam-exclusions:
+    default: "false"
+    description: Whether to apply spam exclusions from [`commands.spam-exclusions`](#commands_spam_exclusions).
   spam-exclusions:
     default: "[/skill]"
     description: >-

src/content/docs/folia/admin/index.mdx

@@ -1,10 +1,13 @@
 ---
 title: Administration
+tableOfContents: false
 ---
 
 import PageCards from "/src/components/PageCards.astro";
 
 Welcome to the Folia administration guide! This guide includes information and tutorials
 regarding the administration of a Folia server.
 
-<PageCards />
+#### Reference
+
+<PageCards path="src/content/docs/folia/admin/reference/index.mdx" />

src/content/docs/folia/admin/reference/index.mdx

@@ -1,5 +1,6 @@
 ---
 title: Reference
+tableOfContents: false
 ---
 
 import PageCards from "/src/components/PageCards.astro";