Skip to content

Commit 4efd37c

Browse files
committed
Update README.md
1 parent 2f2da23 commit 4efd37c

File tree

1 file changed

+38
-12
lines changed

1 file changed

+38
-12
lines changed

README.md

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,50 @@
55

66
A polymer-based server-side sit mod for Fabric & Quilt!
77

8-
## How to Use?
8+
## Installation
99

1010
Requirements:
11-
- Minecraft 1.18.2
12-
- [Polymer](https://modrinth.com/mod/polymer)
13-
- [Polysit](https://github.com/the-glitch-network/polysit/releases)
14-
- One of either mod loader:
15-
- [Quilt](https://quiltmc.org/install) + [QSL](https://modrinth.com/mod/qsl)
16-
- [Fabric](https://fabricmc.net/use) + [Fabric API](https://modrinth.com/mod/fabric-api)
1711

18-
Install Minecraft 1.18.2, Polymer, Polysit and your mod loader of choice, then you can right-click/use a slab or stair
19-
to sit in it. No client mod is required, but you may install to use it in single player or with LAN.
12+
- Minecraft 1.19.3 through 1.21.4
13+
- [Polymer]
14+
- [Polysit]
15+
- Pick a mod loader:
16+
- [Quilt](https://quiltmc.org/install) + [QSL](https://modrinth.com/mod/qsl)
17+
- [Fabric](https://fabricmc.net/use) + [Fabric API](https://modrinth.com/mod/fabric-api)
18+
19+
Install Minecraft, [Polymer], [Polysit] and your mod loader of choice.
20+
You only need to install it on the server, but there's a client-sided enhancement if one prefers.
21+
22+
You also have the option of using it in singleplayer or with friends over LAN.
23+
24+
## Using
25+
26+
You can right-click/use any slab, stair and bed to sit on it.
27+
28+
There's also `/sit`, which allows you to sit practically anywhere, even on cacti... if you're immune to thorns.
29+
30+
For clients with the mod, there's also a keybind named `Sit`, which defaults to `G`.
31+
It'll similarly let you sit anywhere, if the server is running Polysit.
32+
33+
> [!NOTE]
34+
> Servers using other mods or plugins that happen to also include `/sit` as a command,
35+
> or using an older version of Polysit, may not use the same checks or be as seamless as the latest version.
36+
>
37+
> If the server does not support or blocks `/sit`, this keybind may be unavailable and cannot be used.
38+
>
39+
> Unfortunately, this is unavoidable as the only method Polysit uses on the client is the `/sit` command.
2040
2141
## Building
2242

23-
1. Make sure you have the JDK. You can get it from [Adoptium](https://adoptium.net) if you don't already have it. Java
24-
17 is required.
43+
1. Make sure you have the JDK.
44+
You can get it from [Adoptium](https://adoptium.net) if you don't already have it.
45+
Java 17 is required for <=1.20.4.
46+
Java 21 is required for >=1.20.5.
2547
2. Run `gradlew build`
2648
3. Get the build from `builds/libs`.
2749

28-
</div>
50+
</div>
51+
52+
[Polymer]: https://modrinth.com/mod/polymer
53+
54+
[Polysit]: https://modrinth.com/mod/polysit

0 commit comments

Comments
 (0)