Skip to content

Commit 759a92c

Browse files
committed
Rename "mappings" preference to "paper-spigot" and use that on the config page
1 parent 7408d7e commit 759a92c

File tree

3 files changed

+22
-36
lines changed

3 files changed

+22
-36
lines changed

docs/.vitepress/theme/preference/PreferenceSwitch.vue

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ onMounted(() => {
122122
/>
123123
<label class="groovy-label prefer-label-right" @click="toggleGradleDsl(true)">.gradle</label>
124124
</div>
125-
<div v-if="preferencesToDisplay.includes('mapping')" class="switch-container">
125+
<div v-if="preferencesToDisplay.includes('paper-spigot')" class="switch-container">
126126
<label class="mojmap-label prefer-label-left" @click="toggleMapping(false)">Paper</label>
127127
<VTSwitch
128128
class="mapping-switch"
@@ -272,19 +272,19 @@ onMounted(() => {
272272
<style>
273273
.maven,
274274
.groovy,
275-
.reobf {
275+
.spigot {
276276
display: none;
277277
}
278278
279279
.prefer-maven .gradle,
280280
.prefer-groovy .kts,
281-
.prefer-reobf .mojmap {
281+
.prefer-reobf .paper {
282282
display: none;
283283
}
284284
285285
.prefer-maven .maven,
286286
.prefer-groovy .groovy,
287-
.prefer-reobf .reobf {
287+
.prefer-reobf .spigot {
288288
display: initial;
289289
}
290290
@@ -319,8 +319,8 @@ onMounted(() => {
319319
.tip .groovy,
320320
.tip .kts,
321321
.tip .maven,
322-
.tip .mojmap,
323-
.tip .reobf {
322+
.tip .paper,
323+
.tip .spigot {
324324
color: var(--vt-c-text-code);
325325
/* transition: color 0.5s; */
326326
font-weight: 600;

docs/en/dev-setup/shading.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
order: 2
3-
preferences: ["build-system", "mapping"]
3+
preferences: ["build-system", "paper-spigot"]
44
authors:
55
- JorelAli
66
- DerEchtePilz
@@ -117,7 +117,7 @@ To shade the CommandAPI into a maven project, you'll need to use the `commandapi
117117

118118
Add the CommandAPI shade dependency:
119119

120-
<div class="reobf">
120+
<div class="spigot">
121121

122122
```xml
123123
<dependencies>
@@ -130,7 +130,7 @@ Add the CommandAPI shade dependency:
130130
```
131131

132132
</div>
133-
<div class="mojmap">
133+
<div class="paper">
134134

135135
```xml
136136
<dependencies>
@@ -230,7 +230,7 @@ repositories {
230230
Next, we declare our dependencies:
231231

232232
<div class="groovy">
233-
<div class="reobf">
233+
<div class="spigot">
234234

235235
```groovy
236236
dependencies {
@@ -239,7 +239,7 @@ dependencies {
239239
```
240240

241241
</div>
242-
<div class="mojmap">
242+
<div class="paper">
243243

244244
```groovy
245245
dependencies {
@@ -250,7 +250,7 @@ dependencies {
250250
</div>
251251
</div>
252252
<div class="kts">
253-
<div class="reobf">
253+
<div class="spigot">
254254

255255
```kotlin
256256
dependencies {
@@ -259,7 +259,7 @@ dependencies {
259259
```
260260

261261
</div>
262-
<div class="mojmap">
262+
<div class="paper">
263263

264264
```kotlin
265265
dependencies {

docs/en/user-setup/config.md

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
order: 2
3+
preferences: ["paper-spigot"]
34
authors:
45
- DerEchtePilz
56
- JorelAli
@@ -16,8 +17,8 @@ The default `config.yml` is shown below:
1617

1718
::: details **config.yml**
1819

19-
:::tabs
20-
===Paper
20+
<div class="paper">
21+
2122
```yaml
2223
# Verbose outputs (default: false)
2324
# If "true", outputs command registration and unregistration logs in the console
@@ -65,7 +66,10 @@ other-commands-to-convert: []
6566
# plugin to this list.
6667
skip-sender-proxy: []
6768
```
68-
===Spigot
69+
70+
</div>
71+
<div class="spigot">
72+
6973
```yaml
7074
# Verbose outputs (default: false)
7175
# If "true", outputs command registration and unregistration logs in the console
@@ -119,6 +123,8 @@ other-commands-to-convert: []
119123
# plugin to this list.
120124
skip-sender-proxy: []
121125
```
126+
127+
</div>
122128
:::
123129
124130
## Configuration settings
@@ -238,26 +244,6 @@ be-lenient-for-minor-versions: false
238244
be-lenient-for-minor-versions: true
239245
```
240246

241-
### `hook-paper-reload`
242-
243-
Controls whether the CommandAPI hooks into the Paper-exclusive `ServerResourcesReloadedEvent` when available.
244-
245-
When the CommandAPI detects it is running on a Paper-based server, this config option controls if the CommandAPI hooks into the `ServerResourcesReloadedEvent`, which triggers when `/minecraft:reload` is run. During this event, the CommandAPI runs a custom datapack reloading sequence that helps commands registered with the CommandAPI work within datapacks. See [Reloading datapacks](../internal/internal#reloading-datapacks) for more information on this process.
246-
247-
By default, this value is set to `false` and the CommandAPI will not hook into the `ServerResourcesReloadedEvent`. If you want, you can set this to `true`, and the CommandAPI will hook into this event.
248-
249-
**Default value**
250-
251-
```yaml
252-
hook-paper-reload: false
253-
```
254-
255-
**Example value**
256-
257-
```yaml
258-
hook-paper-reload: true
259-
```
260-
261247
### `skip-initial-datapack-reload`
262248

263249
Controls whether the CommandAPI should perform its initial datapack reload when the server has finished loading.

0 commit comments

Comments
 (0)