Skip to content

Commit eddd469

Browse files
author
Jakub Łobos
committed
update gallery addons documentation
1 parent f1d2a64 commit eddd469

File tree

2 files changed

+118
-94
lines changed

2 files changed

+118
-94
lines changed

‎docs/en-US/gallery-addons.md‎

Lines changed: 59 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,22 @@ Check the required dependencies if your package needs them. By default, we will
167167
- `Require paper=1.21.5` – requires package `paper` in exactly version `1.21.5`
168168
- `No requirements` – your package has no dependencies and can operate standalone
169169

170+
#### Automatic Dependency Installation
171+
172+
Some packages, like Paper, may require Java, which will be installed on the user's server.
173+
174+
- **Automatic Java Installation:**
175+
If you select Paper, the system will automatically install the appropriate Java version required by Paper.
176+
177+
- **Java Versions:**
178+
Paper may require Java in a range, e.g., **11–17**. By default, the **latest available version in this range** will be installed (e.g., Java 17). Another compatible version may be installed if another package on the user's server already requires Java in a range, e.g., **11–14**. In this case, **Java 14** will be installed.
179+
180+
- **Adding a Custom Java Version:**
181+
If you want to use a different Java version (override it), you can do so by adding an **advanced selector**, e.g.:
182+
```bash
183+
java~11
184+
```
185+
170186
---
171187

172188
### 🔎 What’s the difference between `^`, `=`, and `~`?
@@ -224,7 +240,7 @@ For more information, see [documentation](https://github.com/Masterminds/semver?
224240
<br/>
225241

226242
| Key | Sample value | Description |
227-
|-----------------------------------------------|-------------------------|---------------------------------------------------------------------|
243+
| --------------------------------------------- | ----------------------- | ------------------------------------------------------------------- |
228244
| `"craftserve.com/game"` | `"minecraft-java"` | The game for which the addon is intended (here: Minecraft Java) |
229245
| `"craftserve.com/type"` | `"plugin"` | Package type (e.g. `plugin`, `mod`) |
230246
| `"craftserve.com/package/time"` | `"2025-04-11 15:25:15"` | Package creation date and time |
@@ -239,52 +255,48 @@ For more information, see [documentation](https://github.com/Masterminds/semver?
239255

240256
```json
241257
{
242-
"manifestVersion":"v3",
243-
"ManifestHash":"sha256-5f5f4ce426d77a86581d7e5bd2109981eba1c64df0c226b39684a5f970a228e0",
244-
"subdir":"marketplace/paper/sha256-5f5f4ce426d77a86581d7e5bd2109981eba1c64df0c226b39684a5f970a228e0",
245-
"name":"paper",
246-
"packageVersion":"1.21.8-11",
247-
"contentVersion":"1.21.8-11",
248-
"dependencies":[
249-
"java>=17 <=21"
250-
],
251-
"provides":[
252-
"game-engine",
253-
"minecraft-java-server=1.21.8",
254-
"paper-api=1.21.8",
255-
"spigot-api=1.21.8",
256-
"bukkit-api=1.21.8",
257-
"paper=1.21.8"
258-
],
259-
"suggestedDependencies":[
260-
"java~21"
261-
],
262-
"set-env":[
263-
{
264-
"key":"MINECRAFT_VERSION",
265-
"value":"1.21.8"
266-
}
267-
],
268-
"labels":{
269-
"craftserve.com/game":"minecraft-java",
270-
"craftserve.com/minecraft-java/version":"1.21.8",
271-
"craftserve.com/mod-loader":"paper",
272-
"craftserve.com/package/time":"2025-07-23 00:17:40.965514",
273-
"craftserve.com/release/time":"2025-07-22 08:54:27.185000",
274-
"craftserve.com/require-empty-workspace":"yes",
275-
"craftserve.com/suggested-selector":"paper~1.21.8-11",
276-
"craftserve.com/type":"mod_loader",
277-
"craftserve.com/version-group":"1.21"
278-
},
279-
"fileshash":"k1:1488116ffdc37691af21a53e7d0eeb9cb1468c9aca3a41b0084705195ad41789",
280-
"downloadfiles":[
281-
{
282-
"name":"minecraft_server.jar",
283-
"url":"https://api.papermc.io/v2/projects/paper/versions/1.21.8/builds/11/downloads/paper-1.21.8-11.jar",
284-
"hash":"sha256-9457d1279efcc2094e818cacb2f17670d9479e5f6b4ea2517eb93a6a3face51f",
285-
"size":0
286-
}
287-
]
258+
"manifestVersion": "v3",
259+
"ManifestHash": "sha256-5f5f4ce426d77a86581d7e5bd2109981eba1c64df0c226b39684a5f970a228e0",
260+
"subdir": "marketplace/paper/sha256-5f5f4ce426d77a86581d7e5bd2109981eba1c64df0c226b39684a5f970a228e0",
261+
"name": "paper",
262+
"packageVersion": "1.21.8-11",
263+
"contentVersion": "1.21.8-11",
264+
"dependencies": ["java>=17 <=21"],
265+
"provides": [
266+
"game-engine",
267+
"minecraft-java-server=1.21.8",
268+
"paper-api=1.21.8",
269+
"spigot-api=1.21.8",
270+
"bukkit-api=1.21.8",
271+
"paper=1.21.8"
272+
],
273+
"suggestedDependencies": ["java~21"],
274+
"set-env": [
275+
{
276+
"key": "MINECRAFT_VERSION",
277+
"value": "1.21.8"
278+
}
279+
],
280+
"labels": {
281+
"craftserve.com/game": "minecraft-java",
282+
"craftserve.com/minecraft-java/version": "1.21.8",
283+
"craftserve.com/mod-loader": "paper",
284+
"craftserve.com/package/time": "2025-07-23 00:17:40.965514",
285+
"craftserve.com/release/time": "2025-07-22 08:54:27.185000",
286+
"craftserve.com/require-empty-workspace": "yes",
287+
"craftserve.com/suggested-selector": "paper~1.21.8-11",
288+
"craftserve.com/type": "mod_loader",
289+
"craftserve.com/version-group": "1.21"
290+
},
291+
"fileshash": "k1:1488116ffdc37691af21a53e7d0eeb9cb1468c9aca3a41b0084705195ad41789",
292+
"downloadfiles": [
293+
{
294+
"name": "minecraft_server.jar",
295+
"url": "https://api.papermc.io/v2/projects/paper/versions/1.21.8/builds/11/downloads/paper-1.21.8-11.jar",
296+
"hash": "sha256-9457d1279efcc2094e818cacb2f17670d9479e5f6b4ea2517eb93a6a3face51f",
297+
"size": 0
298+
}
299+
]
288300
}
289301
```
290302

‎docs/pl-PL/gallery-addons.md‎

Lines changed: 59 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,22 @@ Zaznacz wymagane zależności, jeśli Twoja paczka ich potrzebuje. Domyślnie po
167167
- `Nie wymagaj`
168168
– Twoja paczka nie ma żadnych zależności i może działać samodzielnie
169169

170+
#### Automatyczne instalowanie zależności:
171+
172+
Niektóre paczki jak np. Paper mogą wymagać Javy, która zostanie zainstalowana na serwerze użytkownika.
173+
174+
- **Automatyczna instalacja Javy:**
175+
Jeśli zaznaczysz Paper, system automatycznie zainstaluje odpowiednią wersję Javy wymaganą przez Paper.
176+
177+
- **Wersje Javy:**
178+
Paper może wymagać Javy w zakresie np. **11–17**. Domyślnie instalowana jest **najnowsza dostępna wersja w tym zakresie** (np. Java 17). Zainstalowana może zostać inna kompatybilna wersja jeśli na serwerze użytkownika jest już jakaś paczka wymagająca javy w zakresie np. **11–14**. Wtedy zainstalowana zostanie **Java 14**.
179+
180+
- **Dodanie niestandardowej wersji Javy:**
181+
Jeśli chcesz użyć innej wersji Javy (nadpisać ją), możesz to zrobić, dodając **zaawansowany selector**, np.:
182+
```bash
183+
java~11
184+
```
185+
170186
---
171187

172188
### 🔎 Czym się różni `^`, `=`, i `~`?
@@ -222,7 +238,7 @@ Aby dowiedzieć się więcej na ten temat skorzystaj z
222238
<br/>
223239

224240
| Klucz | Przykładowa wartość | Opis |
225-
|-----------------------------------------------|-------------------------|----------------------------------------------------------------|
241+
| --------------------------------------------- | ----------------------- | -------------------------------------------------------------- |
226242
| `"craftserve.com/game"` | `"minecraft-java"` | Gra, dla której przeznaczony jest dodatek (tu: Minecraft Java) |
227243
| `"craftserve.com/type"` | `"plugin"` | Typ paczki (np. `plugin`, `mod`, `map`) |
228244
| `"craftserve.com/package/time"` | `"2025-04-11 15:25:15"` | Data i godzina utworzenia paczki |
@@ -237,52 +253,48 @@ Aby dowiedzieć się więcej na ten temat skorzystaj z
237253

238254
```json
239255
{
240-
"manifestVersion":"v3",
241-
"ManifestHash":"sha256-5f5f4ce426d77a86581d7e5bd2109981eba1c64df0c226b39684a5f970a228e0",
242-
"subdir":"marketplace/paper/sha256-5f5f4ce426d77a86581d7e5bd2109981eba1c64df0c226b39684a5f970a228e0",
243-
"name":"paper",
244-
"packageVersion":"1.21.8-11",
245-
"contentVersion":"1.21.8-11",
246-
"dependencies":[
247-
"java>=17 <=21"
248-
],
249-
"provides":[
250-
"game-engine",
251-
"minecraft-java-server=1.21.8",
252-
"paper-api=1.21.8",
253-
"spigot-api=1.21.8",
254-
"bukkit-api=1.21.8",
255-
"paper=1.21.8"
256-
],
257-
"suggestedDependencies":[
258-
"java~21"
259-
],
260-
"set-env":[
261-
{
262-
"key":"MINECRAFT_VERSION",
263-
"value":"1.21.8"
264-
}
265-
],
266-
"labels":{
267-
"craftserve.com/game":"minecraft-java",
268-
"craftserve.com/minecraft-java/version":"1.21.8",
269-
"craftserve.com/mod-loader":"paper",
270-
"craftserve.com/package/time":"2025-07-23 00:17:40.965514",
271-
"craftserve.com/release/time":"2025-07-22 08:54:27.185000",
272-
"craftserve.com/require-empty-workspace":"yes",
273-
"craftserve.com/suggested-selector":"paper~1.21.8-11",
274-
"craftserve.com/type":"mod_loader",
275-
"craftserve.com/version-group":"1.21"
276-
},
277-
"fileshash":"k1:1488116ffdc37691af21a53e7d0eeb9cb1468c9aca3a41b0084705195ad41789",
278-
"downloadfiles":[
279-
{
280-
"name":"minecraft_server.jar",
281-
"url":"https://api.papermc.io/v2/projects/paper/versions/1.21.8/builds/11/downloads/paper-1.21.8-11.jar",
282-
"hash":"sha256-9457d1279efcc2094e818cacb2f17670d9479e5f6b4ea2517eb93a6a3face51f",
283-
"size":0
284-
}
285-
]
256+
"manifestVersion": "v3",
257+
"ManifestHash": "sha256-5f5f4ce426d77a86581d7e5bd2109981eba1c64df0c226b39684a5f970a228e0",
258+
"subdir": "marketplace/paper/sha256-5f5f4ce426d77a86581d7e5bd2109981eba1c64df0c226b39684a5f970a228e0",
259+
"name": "paper",
260+
"packageVersion": "1.21.8-11",
261+
"contentVersion": "1.21.8-11",
262+
"dependencies": ["java>=17 <=21"],
263+
"provides": [
264+
"game-engine",
265+
"minecraft-java-server=1.21.8",
266+
"paper-api=1.21.8",
267+
"spigot-api=1.21.8",
268+
"bukkit-api=1.21.8",
269+
"paper=1.21.8"
270+
],
271+
"suggestedDependencies": ["java~21"],
272+
"set-env": [
273+
{
274+
"key": "MINECRAFT_VERSION",
275+
"value": "1.21.8"
276+
}
277+
],
278+
"labels": {
279+
"craftserve.com/game": "minecraft-java",
280+
"craftserve.com/minecraft-java/version": "1.21.8",
281+
"craftserve.com/mod-loader": "paper",
282+
"craftserve.com/package/time": "2025-07-23 00:17:40.965514",
283+
"craftserve.com/release/time": "2025-07-22 08:54:27.185000",
284+
"craftserve.com/require-empty-workspace": "yes",
285+
"craftserve.com/suggested-selector": "paper~1.21.8-11",
286+
"craftserve.com/type": "mod_loader",
287+
"craftserve.com/version-group": "1.21"
288+
},
289+
"fileshash": "k1:1488116ffdc37691af21a53e7d0eeb9cb1468c9aca3a41b0084705195ad41789",
290+
"downloadfiles": [
291+
{
292+
"name": "minecraft_server.jar",
293+
"url": "https://api.papermc.io/v2/projects/paper/versions/1.21.8/builds/11/downloads/paper-1.21.8-11.jar",
294+
"hash": "sha256-9457d1279efcc2094e818cacb2f17670d9479e5f6b4ea2517eb93a6a3face51f",
295+
"size": 0
296+
}
297+
]
286298
}
287299
```
288300

0 commit comments

Comments
 (0)