Skip to content

Commit 14bb604

Browse files
zlataovcezlataovce
authored
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
1 parent 3d96a7b commit 14bb604

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+501
-191
lines changed

‎CONTRIBUTING.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,21 @@ There are quite a few constants you may want to use in your pages, such as the l
128128
These constants can be imported and used in MDX, like so:
129129

130130
```mdxjs
131-
import { LATEST_MC_RELEASE, LATEST_PAPER_RELEASE, LATEST_VELOCITY_RELEASE } from "/src/utils/versions";
131+
import {
132+
LATEST_MC_RELEASE,
133+
LATEST_PAPER_RELEASE,
134+
LATEST_VELOCITY_RELEASE,
135+
LATEST_FOLIA_RELEASE,
136+
LATEST_WATERFALL_RELEASE,
137+
LATEST_USERDEV_RELEASE,
138+
} from "/src/utils/versions";
132139
133140
Latest Paper version is {LATEST_PAPER_RELEASE}.
134141
Latest Velocity version is {LATEST_VELOCITY_RELEASE}.
135142
Latest Minecraft version is {LATEST_MC_RELEASE}.
143+
Latest Folia version is {LATEST_FOLIA_RELEASE}.
144+
Latest Waterfall version is {LATEST_WATERFALL_RELEASE}.
145+
Latest `paperweight-userdev` version is {LATEST_USERDEV_RELEASE}.
136146
```
137147

138148
If you want to perform these replacements in code blocks, you need to use a special `replace` meta property.

‎astro.config.ts

+4
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ export default defineConfig({
4747
Banner: "./src/components/overrides/Banner.astro",
4848
TableOfContents: "./src/components/overrides/TableOfContents.astro",
4949
MobileTableOfContents: "./src/components/overrides/MobileTableOfContents.astro",
50+
SocialIcons: "./src/components/overrides/SocialIcons.astro",
5051
},
5152
plugins: [
5253
starlightLinksValidator({
@@ -382,6 +383,9 @@ export default defineConfig({
382383
),
383384
],
384385
expressiveCode: {
386+
frames: {
387+
extractFileNameFromCode: false,
388+
},
385389
emitExternalStylesheet: false,
386390
},
387391
}),

‎src/components/PageCards.astro

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const pages: Page[] = (await getCollection(Astro.locals.starlightRoute.entry.col
3939
{
4040
pages.map((p) => (
4141
<LinkCard
42-
title={p.title}
42+
title={(p.group ? "🗃️ " : "") + p.title}
4343
description={p.description ?? (p.group ? "(documentation group)" : undefined)}
4444
href={p.href}
4545
/>

‎src/components/overrides/SocialIcons.astro

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
import config from "virtual:starlight/user-config";
3+
import { Icon } from "@astrojs/starlight/components";
4+
import { LATEST_RELEASES } from "../../utils/versions";
5+
6+
const { isPageWithTopic, topics } = Astro.locals.starlightSidebarTopics;
7+
const currentTopic = isPageWithTopic ? topics.find((t) => t.isCurrent) : null;
8+
9+
const links = (config.social || []).map((link) => {
10+
const project = currentTopic?.label?.toLowerCase();
11+
if (!project) {
12+
return link;
13+
}
14+
15+
const version = LATEST_RELEASES[project];
16+
if (!version) {
17+
return link;
18+
}
19+
20+
switch (link.label) {
21+
case "Javadoc":
22+
return { ...link, href: `${link.href}/${project}/${version}` };
23+
case "GitHub":
24+
return { ...link, href: `${link.href}/${project}` };
25+
}
26+
return link;
27+
});
28+
---
29+
30+
{
31+
links.length > 0 && (
32+
<>
33+
{links.map(({ label, href, icon }) => (
34+
<a {href} rel="me" class="sl-flex">
35+
<span class="sr-only">{label}</span>
36+
<Icon name={icon} />
37+
</a>
38+
))}
39+
</>
40+
)
41+
}
42+
43+
<style>
44+
a {
45+
color: var(--sl-color-text-accent);
46+
padding: 0.5em;
47+
margin: -0.5em;
48+
}
49+
a:hover {
50+
opacity: 0.66;
51+
}
52+
</style>

‎src/config/paper/paper-global.yml

+17
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,20 @@ block-updates:
5757
Disabling block updates leads to tripwires no longer updating their block
5858
state, allowing for technically invalid tripwires to remain in the world,
5959
which might be useful for mapmakers.
60+
disable-chorus-plant-updates:
61+
default: "false"
62+
description: >-
63+
Whether to disable any form of block updates for chorus plants on the
64+
server. Disabling block updates leads to chorus plants no longer updating their block
65+
state, allowing for technically invalid chorus plant configurations to remain in the world,
66+
which might be useful for mapmakers.
67+
disable-mushroom-block-updates:
68+
default: "false"
69+
description: >-
70+
Whether to disable any form of block updates for mushroom blocks on the
71+
server. Disabling block updates leads to mushroom blocks no longer updating their block
72+
state, allowing for technically invalid mushroom block configurations to remain in the world,
73+
which might be useful for mapmakers.
6074
chunk-loading-advanced:
6175
auto-config-send-distance:
6276
default: "true"
@@ -523,6 +537,9 @@ unsupported-settings:
523537
This setting controls if equipment should be updated when handling certain player
524538
actions. If set to false this will allow players to exploit attributes by e.g.
525539
switching equipment before using it.
540+
simplify-remote-item-matching:
541+
default: "false"
542+
description: Only checks an item's amount and type instead of its full data during inventory desync checks.
526543
watchdog:
527544
early-warning-delay:
528545
default: "10000"

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

+53
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,11 @@ entities:
249249
vanilla: "false"
250250
default: "true"
251251
description: "Prevents phantoms from attacking players who have slept "
252+
player-insomnia-start-ticks:
253+
default: "72000"
254+
description: |
255+
Number of ticks a player must stay awake before phantoms can start spawning.
256+
Default (72000) is 3 Minecraft days, -1 disables phantom spawning.
252257
piglins-guard-chests:
253258
default: "true"
254259
description: If piglins should attempt to guard chests when angered
@@ -357,6 +362,42 @@ entities:
357362
description: >-
358363
The rate, in ticks, at which arrows shot from players in creative mode
359364
are despawned
365+
ticks-per-spawn:
366+
ambient:
367+
default: "-1"
368+
description: |
369+
Determines how many ticks there are between attempts to spawn ambient mobs (bats).
370+
Default (-1) uses Vanilla spawn rate.
371+
axolotls:
372+
default: "-1"
373+
description: |
374+
Determines how many ticks there are between attempts to spawn axolotls.
375+
Default (-1) uses Vanilla spawn rate.
376+
creature:
377+
default: "-1"
378+
description: |
379+
Determines how many ticks there are between attempts to spawn passive creatures (animals).
380+
Default (-1) uses Vanilla spawn rate.
381+
monster:
382+
default: "-1"
383+
description: |
384+
Determines how many ticks there are between attempts to spawn hostile monsters.
385+
Default (-1) uses Vanilla spawn rate.
386+
underground_water_creature:
387+
default: "-1"
388+
description: |
389+
Determines how many ticks there are between attempts to spawn underground water creatures (glow squid).
390+
Default (-1) uses Vanilla spawn rate.
391+
water_ambient:
392+
default: "-1"
393+
description: |
394+
Determines how many ticks there are between attempts to spawn ambient water mobs (tropical fish).
395+
Default (-1) uses Vanilla spawn rate.
396+
water_creature:
397+
default: "-1"
398+
description: |
399+
Determines how many ticks there are between attempts to spawn water creatures (squid, dolphins).
400+
Default (-1) uses Vanilla spawn rate.
360401
despawn-range-shape:
361402
default: ELLIPSOID
362403
description: >-
@@ -1026,6 +1067,18 @@ tick-rates:
10261067
description: >-
10271068
How often mob spawners should tick to calculate available spawn areas and
10281069
spawn new entities into the world. A value of -1 will disable all spawners
1070+
dry-farmland:
1071+
default: "1"
1072+
description: |
1073+
Controls how frequently dry farmland blocks are ticked.
1074+
Higher values slow down the rate at which farmland checks for moisture updates.
1075+
Default (1) uses Vanilla behavior, -1 disables dry farmland random ticks.
1076+
wet-farmland:
1077+
default: "1"
1078+
description: |
1079+
Controls how frequently wet farmland blocks are ticked.
1080+
Higher values slow down the rate at which farmland checks for moisture updates.
1081+
Default (1) uses Vanilla behavior, -1 disables wet farmland random ticks.
10291082
sensor:
10301083
villager:
10311084
secondarypoisensor:

‎src/config/paper/server-properties.yml

+5
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,11 @@ sync-chunk-writes:
229229
text-filtering-config:
230230
default: ""
231231
description: "The path to the text filtering configuration file. Leave blank to disable text filtering."
232+
text-filtering-version:
233+
default: "0"
234+
description: |
235+
The version of the configuration format used for [`text-filtering-config`](#text_filtering_config).
236+
Valid values are 0 and 1.
232237
use-native-transport:
233238
default: "true"
234239
description: "Provides a performance boost for Linux servers."

‎src/config/paper/spigot.yml

+3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ commands:
3939
silent-commandblock-console:
4040
default: "false"
4141
description: Whether to log Vanilla command feedback to the Console.
42+
enable-spam-exclusions:
43+
default: "false"
44+
description: Whether to apply spam exclusions from [`commands.spam-exclusions`](#commands_spam_exclusions).
4245
spam-exclusions:
4346
default: "[/skill]"
4447
description: >-

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

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
---
22
title: Administration
3+
tableOfContents: false
34
---
45

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

78
Welcome to the Folia administration guide! This guide includes information and tutorials
89
regarding the administration of a Folia server.
910

10-
<PageCards />
11+
#### Reference
12+
13+
<PageCards path="src/content/docs/folia/admin/reference/index.mdx" />

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

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Reference
3+
tableOfContents: false
34
---
45

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

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
---
22
title: Folia Documentation
3+
tableOfContents: false
34
---
45

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

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

910
<CardGrid>
10-
<LinkCard title="Administration" href="/folia/admin" />
11+
<LinkCard
12+
title="Administration"
13+
description="Information and tutorials regarding the administration of a Folia server."
14+
href="/folia/admin"
15+
/>
1116
</CardGrid>

‎src/content/docs/misc/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Miscellaneous
3+
tableOfContents: false
34
---
45

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

‎src/content/docs/misc/tools/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Tools
3+
tableOfContents: false
34
---
45

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

‎src/content/docs/paper/admin/getting-started/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Getting started
3+
tableOfContents: false
34
---
45

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

‎src/content/docs/paper/admin/how-to/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: How-to guides
3+
tableOfContents: false
34
---
45

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

‎src/content/docs/paper/admin/index.mdx

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,25 @@
11
---
22
title: Administration
3+
tableOfContents: false
34
---
45

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

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

10-
<PageCards />
11+
#### Getting started
12+
13+
<PageCards path="src/content/docs/paper/admin/getting-started/index.mdx" />
14+
15+
#### How-to guides
16+
17+
<PageCards path="src/content/docs/paper/admin/how-to/index.mdx" />
18+
19+
#### Reference
20+
21+
<PageCards path="src/content/docs/paper/admin/reference/index.mdx" />
22+
23+
#### Miscellaneous
24+
25+
<PageCards path="src/content/docs/paper/admin/misc/index.mdx" />

‎src/content/docs/paper/admin/misc/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Miscellaneous
3+
tableOfContents: false
34
---
45

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

‎src/content/docs/paper/admin/reference/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Reference
3+
tableOfContents: false
34
---
45

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

‎src/content/docs/paper/admin/reference/system-properties.md

+10
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,11 @@ It also remaps plugin CB calls to remove the version information.
224224
- **default**: `false`
225225
- **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.
226226

227+
#### paper.disableGameRuleLimits
228+
229+
- **default**: `false`
230+
- **description**: Disables limits on certain game rule values, e.g. `minecartMaxSpeed` and `spawnChunkRadius`.
231+
227232
#### minecraft.api.session.host
228233

229234
- **default**: `https://sessionserver.mojang.com`
@@ -234,6 +239,11 @@ It also remaps plugin CB calls to remove the version information.
234239
- **default**: `https://api.minecraftservices.com`
235240
- **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.
236241

242+
#### com.mojang.eula.agree
243+
244+
- **default**: `false`
245+
- **description**: Setting this to true indicates that you have agreed with [Mojang's EULA](https://aka.ms/MinecraftEULA), skipping `eula.txt` checks.
246+
237247
## List of environment variables
238248

239249
#### PAPER_VELOCITY_SECRET

0 commit comments

Comments
 (0)