Sit/README.md

69 lines
3.9 KiB
Markdown
Raw Normal View History

2025-06-06 20:09:48 -05:00
<img src="https://github.com/Oth3r/oth3r.github.io/blob/main/mod_data/Sit!/media/banner.png?raw=true" width="50%" style="margin-bottom: 10px; max-width:400px;">
[![github](https://img.shields.io/github/issues/oth3r/Sit?logo=github?label=Issues)](https://github.com/Oth3r/Sit/releases) [![Crowdin](https://badges.crowdin.net/oth3r-sit/localized.svg)](https://crowdin.com/project/oth3r-sit) [![discord](https://dcbadge.vercel.app/api/server/https://discord.gg/AVSTHCAUvn?style=flat)](https://www.oth3r.one/discord)
2023-11-25 19:33:11 -06:00
[![modrinth](https://img.shields.io/modrinth/dt/sit!?label=Modrinth&logo=modrinth)](https://modrinth.com/mod/sit!) [![curseforge](https://cf.way2muchnoise.eu/892424.svg)](https://www.curseforge.com/minecraft/mc-mods/Sit1)
2023-07-22 17:35:48 -05:00
2025-06-06 20:09:48 -05:00
### **Sit!** is a vanilla+ mod that adds sitting in minecraft.
* Sit on **stairs**, **slabs**, **carpets** by default, and sit on everything else by tweaking the config!
* You can also customize **hand restrictions** to stop accidentally sitting down!
* The mod also has full **Geyser** support! Enjoy sitting with everyone, whether they are on Bedrock or Java!
* If Sit! clients join a Sit! server they can use **their own hand settings** to sit.
2024-04-01 17:58:26 -05:00
2023-12-01 16:39:48 -06:00
### Where to install?
2025-06-06 20:09:48 -05:00
**Sit!** works on the server, without the players needing to install the mod *(singleplayer included!)*.
\
2025-06-06 20:09:48 -05:00
[Fabric API](https://modrinth.com/mod/fabric-api) and [OtterLib](https://modrinth.com/mod/otterlib) is required to for the mod to load.
2024-04-01 17:58:26 -05:00
2025-06-06 20:09:48 -05:00
### Help localize Sit! on [Crowdin](https://crowdin.com/project/oth3r-sit)!
Sit! is currently in English, Traditional Chinese, Italian, Brazilian Portuguese, and Turkish! Help expand this list via Crowdin so reach more people!
2024-04-01 17:58:26 -05:00
2023-07-22 17:35:48 -05:00
## Check out my other Projects!
2025-06-06 20:09:48 -05:00
<a href="https://modrinth.com/mod/caligo">
<img src="https://github.com/Oth3r/Caligo/blob/master/media/promo_badge.png?raw=true" alt="Caligo badge"
style="margin-right: 5px;">
</a>
<a href="https://modrinth.com/mod/directionhud">
<img src="https://github.com/Oth3r/DirectionHUD/blob/master/media/mod-badge.png?raw=true" alt="Directionhud badge"
style="margin-right: 5px;">
</a>
<a href="https://modrinth.com/mod/more-heart-types">
<img src="https://github.com/Oth3r/MoreHeartTypes/blob/master/media/Badge.png?raw=true" alt="More Heart Types badge"
style="">
</a>
2023-07-22 17:35:48 -05:00
# Features
2024-04-01 17:58:26 -05:00
2025-06-06 20:09:48 -05:00
### 🤚 Hand Restrictions
2023-07-22 17:35:48 -05:00
Don't want to accidentally sit down? Set custom restrictions for each hand in the config!
2025-06-06 20:09:48 -05:00
\
Use **player unique** hand restrictions when connecting to a `Sit!` server on a `Sit!` Client!
2024-04-01 17:58:26 -05:00
2025-06-06 20:09:48 -05:00
<img src="https://github.com/Oth3r/oth3r.github.io/blob/main/mod_data/Sit!/media/desc/hand_restrictions.gif?raw=true" width="100%" style="margin-bottom: 10px;max-width:600px;"
alt="per player hand restriction showcase">
2023-07-22 17:35:48 -05:00
2025-06-06 20:09:48 -05:00
### 🟩 Custom Blocks
Want to sit on _**EVERY**_ block? With the config you can add more sitting options!
\
With the new config system, block tags and custom blockstates can be used to mass select blocks at ease.
2023-12-01 16:39:48 -06:00
2025-06-06 20:09:48 -05:00
<img src="https://github.com/Oth3r/oth3r.github.io/blob/main/mod_data/Sit!/media/desc/custom_blocks.gif?raw=true" width="100%" style="margin-bottom: 10px; max-width:600px;"
alt="players sitting on a vast range of blocks">
2023-07-22 17:35:48 -05:00
2025-06-06 20:09:48 -05:00
### ⌨️ Keybinds
Don't want to sit with the **just** the hand? Use a keybind or type a command to sit instead!
2024-04-01 17:58:26 -05:00
2025-06-06 20:09:48 -05:00
<img src="https://github.com/Oth3r/oth3r.github.io/blob/main/mod_data/Sit!/media/desc/keybinds.gif?raw=true" width="100%" style="margin-bottom: 10px; max-width:600px;"
alt="setting keybinds for the sit mod, and sitting by using them">
2023-07-22 17:35:48 -05:00
2025-06-06 20:09:48 -05:00
### 📃 Customizable Config
Don't like the default settings? Go wild in the config for yourself or your players!
<img src="https://github.com/Oth3r/oth3r.github.io/blob/main/mod_data/Sit!/media/desc/config.gif?raw=true" width="100%" style="margin-bottom: 10px; max-width:600px;"
alt="the Sit! config wiki page">
2023-07-22 17:35:48 -05:00
## Future Goals
2025-06-06 20:09:48 -05:00
* NeoForge Port
* Full config via [OtterLib](https://modrinth.com/mod/otterlib)