Skip to content

Commit ae87d66

Browse files
authored
Add CraftserveAgent command documentation (#55)
Added Polish and English docs detailing CraftserveAgent plugin commands.
1 parent 5c137e8 commit ae87d66

2 files changed

Lines changed: 139 additions & 0 deletions

File tree

docs/en-US/csrvagentcommannds.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# CraftserveAgent Commands
2+
3+
CraftserveAgent is a built-in Craftserve plugin that runs on any server with an engine that supports plugins (such as Spigot, Paper, or Purpur). It significantly simplifies server management and also introduces additional security features, such as login and verification on offline-mode servers.
4+
5+
Individual Agent's functions are implemented as modules, which you can enable or disable in the webpanel (Minecraft Settings -> CraftserveAgent Settings).
6+
7+
# Modules:
8+
9+
## Skin Restoration
10+
11+
Allows you to restore skins on offline-mode servers, which is not the default behavior. A simple replacement for the popular [SkinRestorer](https://craftserve.com/en/m/skinsrestorer) plugin.
12+
13+
**Usage:**
14+
15+
`/skin` - restores the player's skin.
16+
17+
## Authentication (Login)
18+
19+
Forces registration and login when joining a server, preventing unauthorized access to accounts with higher privileges on offline-mode servers. A simpler alternative to the popular [AuthMe](https://craftserve.com/en/m/authmereloaded) plugin.
20+
21+
**Usage:**
22+
23+
`/register <password>` - registers an account for the current player with the specified password.
24+
`/login <password>` - logs in to the current player's account using the specified password.
25+
26+
## Homes
27+
28+
A familiar feature from many Minecraft servers, with a simple implementation. It allows you to create your own home points (so-called "homes") and teleport to them at any time using a command.
29+
30+
**Commands:**
31+
`/home` - teleports to the set home. If no home is set, a new one will be created. Permission: `craftserve-agent.home`.
32+
`/delhome` - deletes the current home. Permission: `craftserve-agent.home`.
33+
34+
## TPA
35+
36+
TPA allows you to send teleport requests to other players. You can also teleport them to yourself using requests.
37+
38+
**Commands:**
39+
`/tpa <nick>` - sends a teleport request to the specified player. Permission: `craftserve-agent.tpa.to-others`.
40+
`/tpahere <nick>` - sends a request to teleport another player to yourself. Permission: `craftserve-agent.tpa.to-me`.
41+
`/tpaaccept` - accepts a teleport request.
42+
`/tpadeny` rejects a teleport request.
43+
`/tpacancel` - cancels a sent teleport request.
44+
45+
## Spawn
46+
47+
Allows you to set a spawn point on the map and teleport to it at any time.
48+
49+
**Commands:**
50+
`/spawn` - teleports to the spawn. Permission: `craftserve-agent.spawn`.
51+
`/setspawn` - sets the spawn. Permission: `craftserve-agent.spawn.set`.
52+
53+
## Warps
54+
55+
Warps are a well-known system that allows you to set points of interest (warps) on the map and teleport to them at any time using a command.
56+
57+
**Commands:**
58+
`/warp <name>` teleports to a warp. Permission: `craftserve-agent.warp`.
59+
`/setwarp <name>` - sets a warp. Permission: `craftserve-agent.warp.set`.
60+
`/delwarp <name>` - removes a warp. Permission: `craftserve-agent.warp.set`.
61+
62+
## Other
63+
64+
Other useful CraftserveAgent plugin commands.
65+
66+
**Commands:**
67+
`/back` - teleports back to the previous location. Permission: `craftserve-agent.back`.
68+
`/slots <number>` - changes the number of slots on the server. Permission: `craftserve-agent.slots`.

docs/pl-PL/csrvagentkomendy.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Polecenia CraftserveAgent
2+
3+
CraftserveAgent to wbudowany plugin Craftserve, działający na każdym serwerze z silnikiem, który obsługuje pluginy (jak Spigot, Paper, czy Purpur). Upraszcza on znacznie zarządzanie serwerem, a także wprowadza dodatkowe zabezpieczenia, jak logowanie i weryfikacja na serwerach offline-mode (tzw. "non-premium").
4+
5+
Poszczególne funkcje Agenta aplikowane są w formie modułów, które możesz włączać i wyłączać w panelu (w zakładce Ustawienia Minecraft -> Ustawienia CraftserveAgent).
6+
7+
8+
# Moduły:
9+
10+
## Przywracanie skinów
11+
12+
Umozliwia przywracanie skinów na serwerach offline-mode, co nie jest domyślnym zachowaniem. Prosty zamiennik popularnego pluginu [SkinRestorer](https://craftserve.com/pl/m/skinsrestorer).
13+
14+
**Użycie:**
15+
16+
`/skin` - przywraca skina gracza.
17+
18+
## Autoryzacja (logowanie)
19+
20+
Wymusza rejestrację i logowanie podczas dołączania na serwer, zabezpieczając nieautoryzowany dostęp do kont z wyższymi uprawnieniami na serwerach offline-mode. Prostsza alternatywa dla popularnego [AuthMe](https://craftserve.com/pl/m/authmereloaded).
21+
22+
**Użycie:**
23+
24+
`/register <hasło>` - rejestruje konto na aktualngo gracza ze wskazanym hasłem.
25+
`/login <hasło>` - loguje na konto aktualnego gracza z użyciem podanego hasła.
26+
27+
## Domy (homes)
28+
29+
Znana funkcja z wielu serwerów Minecraft w prostej implementacji. Pozwala na tworzenie swoich punktów domowych (tzw. "homes") i teleportację do nich w dowolnym momencie za pomocą komendy.
30+
31+
**Komendy:**
32+
`/home` - teleportuje do ustawionego domu (home). Jeśli żaden dom nie jest ustawiony, powstanie nowy. Uprawnienie: `craftserve-agent.home`.
33+
`/delhome` - usuwa aktualny dom (home). Uprawnienie: `craftserve-agent.home`.
34+
35+
## TPA
36+
37+
TPA umożliwia wysyłanie próśb o teleportację do innych graczy. Pozwala także na teleportowanie ich do siebie za pomocą próśb.
38+
39+
**Komendy:**
40+
`/tpa <nick>` - wysyła prośbę o teleportację do wskazanego gracza. Uprawnienie: `craftserve-agent.tpa.to-others`.
41+
`/tpahere <nick>` - wysyła prośbę o teleportację innego gracza do siebie. Uprawnienie: `craftserve-agent.tpa.to-me`.
42+
`/tpaaccept` - akceptuje prośbę o teleportację.
43+
`/tpadeny` odrzuca prośbę o teleportację.
44+
`/tpacancel` - anuluje wysłaną prośbę o teleportację.
45+
46+
## Spawn
47+
48+
Pozwala na ustawienie spawnu na mapie i teleportację do niego w dowolnym momencie.
49+
50+
**Komendy:**
51+
`/spawn` - teleportuje na spawn. Uprawnienie: `craftserve-agent.spawn`.
52+
`/setspawn` - ustawia spawn. Uprawnienie: `craftserve-agent.spawn.set`.
53+
54+
55+
## Warpy
56+
57+
Warpy to znany od zawsze system pozwalający na ustalenie punktów zainteresowania na mapie (warpów) i teleportację do nich w dowolnym momencie za pomocą komendy.
58+
59+
60+
**Komendy:**
61+
`/warp <nazwa>` teleportuje na warp. Uprawnienie: ` craftserve-agent.warp`.
62+
`/setwarp <nazwa>` - ustawia warp. Uprawnienie: `craftserve-agent.warp.set`.
63+
`/delwarp <nazwa>` - usuwa warp. Uprawnienie: `craftserve-agent.warp.set`.
64+
65+
## Inne
66+
67+
Pozostałe przydatne komendy pluginu CraftserveAgent.
68+
69+
**Komendy:**
70+
`/back` - teleportuje z powrotem do poprzedniej lokacji. Uprawnienie: `craftserve-agent.back`.
71+
`/slots <liczba>` - zmienia liczbę slotów na serwerze. Uprawnienie: `craftserve-agent.slots`.

0 commit comments

Comments
 (0)