Skip to content

chore: housekeeping (fixing issues) #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Apr 22, 2025
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down Expand Up @@ -382,6 +383,9 @@ export default defineConfig({
),
],
expressiveCode: {
frames: {
extractFileNameFromCode: false,
},
emitExternalStylesheet: false,
},
}),
Expand Down
2 changes: 1 addition & 1 deletion src/components/PageCards.astro
Original file line number Diff line number Diff line change
Expand Up @@ -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}
/>
Expand Down
52 changes: 52 additions & 0 deletions src/components/overrides/SocialIcons.astro
Original file line number Diff line number Diff line change
@@ -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>
17 changes: 17 additions & 0 deletions src/config/paper/paper-global.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down
53 changes: 53 additions & 0 deletions src/config/paper/paper-world-defaults.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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: >-
Expand Down Expand Up @@ -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:
Expand Down
5 changes: 5 additions & 0 deletions src/config/paper/server-properties.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
3 changes: 3 additions & 0 deletions src/config/paper/spigot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: >-
Expand Down
5 changes: 4 additions & 1 deletion src/content/docs/folia/admin/index.mdx
Original file line number Diff line number Diff line change
@@ -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" />
1 change: 1 addition & 0 deletions src/content/docs/folia/admin/reference/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Reference
tableOfContents: false
---

import PageCards from "/src/components/PageCards.astro";
Expand Down
7 changes: 6 additions & 1 deletion src/content/docs/folia/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
---
title: Folia Documentation
tableOfContents: false
---

import { CardGrid, LinkCard } from "@astrojs/starlight/components";

Folia is a fork of Paper which adds regionized multithreading to the dedicated server.

<CardGrid>
<LinkCard title="Administration" href="/folia/admin" />
<LinkCard
title="Administration"
description="Information and tutorials regarding the administration of a Folia server."
href="/folia/admin"
/>
</CardGrid>
1 change: 1 addition & 0 deletions src/content/docs/misc/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Miscellaneous
tableOfContents: false
---

import PageCards from "/src/components/PageCards.astro";
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/misc/tools/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Tools
tableOfContents: false
---

import PageCards from "/src/components/PageCards.astro";
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/paper/admin/getting-started/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Getting started
tableOfContents: false
---

import PageCards from "/src/components/PageCards.astro";
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/paper/admin/how-to/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: How-to guides
tableOfContents: false
---

import PageCards from "/src/components/PageCards.astro";
Expand Down
17 changes: 16 additions & 1 deletion src/content/docs/paper/admin/index.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
---
title: Administration
tableOfContents: false
---

import PageCards from "/src/components/PageCards.astro";

Welcome to the Paper administration guide! This guide includes information and tutorials
regarding the administration of a Paper server.

<PageCards />
#### Getting started

<PageCards path="src/content/docs/paper/admin/getting-started/index.mdx" />

#### How-to guides

<PageCards path="src/content/docs/paper/admin/how-to/index.mdx" />

#### Reference

<PageCards path="src/content/docs/paper/admin/reference/index.mdx" />

#### Miscellaneous

<PageCards path="src/content/docs/paper/admin/misc/index.mdx" />
1 change: 1 addition & 0 deletions src/content/docs/paper/admin/misc/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Miscellaneous
tableOfContents: false
---

import PageCards from "/src/components/PageCards.astro";
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/paper/admin/reference/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Reference
tableOfContents: false
---

import PageCards from "/src/components/PageCards.astro";
Expand Down
10 changes: 10 additions & 0 deletions src/content/docs/paper/admin/reference/system-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,11 @@ It also remaps plugin CB calls to remove the version information.
- **default**: `false`
- **description**: Disables the folder walk and symlink validation when loading a world. Significantly improves world loading speed on massive worlds (>1TB). This does not disable symlink verification of datapacks.

#### paper.disableGameRuleLimits

- **default**: `false`
- **description**: Disables limits on certain game rule values, e.g. `minecartMaxSpeed` and `spawnChunkRadius`.

#### minecraft.api.session.host

- **default**: `https://sessionserver.mojang.com`
Expand All @@ -234,6 +239,11 @@ It also remaps plugin CB calls to remove the version information.
- **default**: `https://api.minecraftservices.com`
- **description**: Allows specifying of a custom services API URL e.g. for caching. [`minecraft.api.session.host`](#minecraftapisessionhost) needs to be set too for this to apply.

#### com.mojang.eula.agree

- **default**: `false`
- **description**: Setting this to true indicates that you have agreed with [Mojang's EULA](https://aka.ms/MinecraftEULA), skipping `eula.txt` checks.

## List of environment variables

#### PAPER_VELOCITY_SECRET
Expand Down
Loading