Skip to content

Commit 1c2cda5

Browse files
committed
update readmes
1 parent 1248c62 commit 1c2cda5

3 files changed

Lines changed: 14 additions & 8 deletions

File tree

minecraft-modrinth/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
Easily download and install Minecraft mods and plugins directly from Modrinth within the server panel.
44

5-
> [!IMPORTANT]
6-
> Add `modrinth_mods` or `modrinth_plugins` to the features of your egg to enable the mod/plugins page. Also make sure your egg has the `minecraft` tag and a tag for the mod loader, e.g. `paper` or `forge` or `fabric`.
5+
## Setup
6+
7+
Add `modrinth_mods` or `modrinth_plugins` to the _features_ of your egg to enable the mod/plugins page.
8+
Also make sure your egg has the `minecraft` _tag_ and a _tag_ for the [mod loader](https://github.com/pelican-dev/plugins/blob/main/minecraft-modrinth/src/Enums/MinecraftLoader.php#L10-L16). (e.g. `paper` or `neoforge`)
79

810
## Features
911

player-counter/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22

33
Show the amount of connected players to game servers with real-time querying capabilities.
44

5-
> [!IMPORTANT]
6-
> You need to have the bz2 php extension and zip/7zip installed!
5+
## Setup
76

8-
> [!IMPORTANT]
9-
> For Minecraft servers you need to set `enable-query` to true and the `query-port` to your server port! (in `server.properties`)
7+
**IMPORTANT**: You need to have the bz2 php extension and zip/7zip installed!
8+
9+
Make sure your server has an allocation with a public ip.
10+
11+
For Minecraft servers you need to set `enable-query` to true and the `query-port` to your server port! (in `server.properties`)
12+
Game query for FiveM/RedM is currently not available due to a [bug with GameQ](https://github.com/pelican-dev/plugins/issues/48).
1013

1114
## Features
1215

user-creatable-servers/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
Allow users to create their own servers within defined resource limits set by administrators.
44

5-
> [!IMPORTANT]
6-
> Add the deployment tag (`user_creatable_servers` by default) to the nodes that should be used for creating servers.
5+
## Setup
6+
7+
Add the deployment tag (`user_creatable_servers` by default) to the nodes that should be used for creating servers.
78

89
## Features
910

0 commit comments

Comments
 (0)