Skip to content

Commit 891a542

Browse files
committed
Update README.md, add compatibility and changes section
1 parent 45fff82 commit 891a542

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,31 @@ It'll similarly let you sit anywhere, if the server is running Polysit.
3737
>
3838
> Unfortunately, this is unavoidable as the only method Polysit uses on the client is the `/sit` command.
3939
40+
## Compatibility
41+
42+
It is compatible with any mod that implements standard slabs, stairs and beds.
43+
It's even compatible with the scale attribute, and other scaling mods such as Pehkui.
44+
45+
> [!NOTE]
46+
> 1.20.1 and older has poorer support for Pehkui.
47+
> Bugs in relation to scaling while sitting will occur.
48+
> There are still [mitigations](#changes-to-vanilla-logic) for Polysit's other behaviours.
49+
50+
If for any reason, there's a slab, stair, bed, or any other seat-like block that doesn't work,
51+
[feel free to submit a bug report](https://github.com/Modflower/Polysit/issues/).
52+
53+
### Changes to Vanilla Logic
54+
55+
Polysit does try to fix bugs that were found in development, or directly caused by its functionality.
56+
57+
- Moving the player out of blocks when getting up.
58+
- Forcing the player to take a smaller pose to avoid suffocating when getting off a seat.
59+
- This applies generically to any seat, not just Polysit's.
60+
- Forcefully sending relevant packets for bugs caused by Mojang's fixes or changes.
61+
- Beds during the day can be right-clicked to sit on it.
62+
63+
All help to ensure that Polysit provides the best UX it possibly can while also maintaining vanilla-esk logic.
64+
4065
## Building
4166

4267
1. Make sure you have the JDK.

0 commit comments

Comments
 (0)