Sit/README.md

# Sit!
[![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)

[![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) 

**Sit!** is a minecraft mod that adds sitting in vanilla minecraft. 
Sit on **stairs**, **slabs**, **carpets** by default, and sit on everything else using the config! 
You can also customize hand restrictions to stop accidentally sitting down! 
The mod also has full Geyser support! Enjoy sitting with everyone, weather they are on Bedrock or Java!

### Where to install?
**Sit!** works on the server (singleplayer included), also with support for clients that join in to use their own settings to sit.
\
[Farbric API](https://modrinth.com/mod/fabric-api) and [OtterLib](https://modrinth.com/mod/otterlib) is required to for the mod to load.

## Help localize Sit! on [Crowdin](https://crowdin.com/project/oth3r-sit)!
![overview](https://github.com/Oth3r/Sit/blob/master/media/overview.gif?raw=true)

## Check out my other Projects!
[![Caligo badge](https://github.com/Oth3r/Caligo/blob/master/media/promo_badge.png?raw=true)](https://modrinth.com/mod/caligo)
[![DirectionHUD badge](https://github.com/Oth3r/DirectionHUD/blob/master/media/mod-badge.png?raw=true)](https://modrinth.com/mod/directionhud)
[![DirectionHUD Spigot badge](https://github.com/Oth3r/DirectionHUD/blob/master/media/plugin-badge.png?raw=true)](https://modrinth.com/plugin/directionhud-plugin)

# Features

### Hand Restrictions
Don't want to accidentally sit down? Set custom restrictions for each hand in the config!

* Per player hand restrictions when connecting to a `Sit!` server on a `Sit!` Client!

![hand restrictions](https://github.com/Oth3r/Sit/blob/master/media/hand-restrictions.gif?raw=true)

### Custom Blocks
Want to sit on _**EVERY**_ block? With the config you can add more options to sit on! Custom block states are also supported.

![custom blocks](https://github.com/Oth3r/Sit/blob/master/media/custom-blocks.gif?raw=true)

### Customizable Config
Configure to your hearts desire with the in-game config with **[ModMenu](https://modrinth.com/mod/modmenu)** & **[YetAnotherConfigLib](https://modrinth.com/mod/yacl)**, or use the provided config file for servers!

![config](https://github.com/Oth3r/Sit/blob/master/media/config.gif?raw=true)
![custom blocks config](https://github.com/Oth3r/Sit/blob/master/media/custom-blocks-config.png?raw=true)

## Future Goals
 * Forge Port (probably NeoForge 1.21)
 * Custom dismounting logic
 * better config (coming soon!)
 * keybindings (next update)