readme update for caligo

This commit is contained in:
Oth3r 2024-04-01 17:58:26 -05:00
commit 911133de23

View file

@ -7,17 +7,23 @@
Sit on **stairs**, **slabs**, **carpets** by default, and sit on everything else using the config! 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! 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! The mod also has full Geyser support! Enjoy sitting with everyone, weather they are on Bedrock or Java!
### Where to install? ### Where to install?
**Sit!** works on the server (singleplayer included), with support for clients that join in to use their own settings to sit. **Sit!** works on the server (singleplayer included), also with support for clients that join in to use their own settings to sit.
## Help localize Sit! on [Crowdin](https://crowdin.com/project/oth3r-sit)! ## Help localize Sit! on [Crowdin](https://crowdin.com/project/oth3r-sit)!
![overview](https://github.com/Oth3r/Sit/blob/master/media/overview.gif?raw=true) ![overview](https://github.com/Oth3r/Sit/blob/master/media/overview.gif?raw=true)
## Check out my other Projects! ## 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 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) [![DirectionHUD Spigot badge](https://github.com/Oth3r/DirectionHUD/blob/master/media/plugin-badge.png?raw=true)](https://modrinth.com/plugin/directionhud-plugin)
# Features # Features
### Hand Restrictions ### Hand Restrictions
Don't want to accidentally sit down? Set custom restrictions for each hand in the config! 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! * 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) ![hand restrictions](https://github.com/Oth3r/Sit/blob/master/media/hand-restrictions.gif?raw=true)
@ -26,6 +32,7 @@ Don't want to accidentally sit down? Set custom restrictions for each hand in th
Want to sit on _**EVERY**_ block? With the config you can add more options to sit on! Custom block states are also supported. 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) ![custom blocks](https://github.com/Oth3r/Sit/blob/master/media/custom-blocks.gif?raw=true)
### Customizable Config ### 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! 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!
@ -35,3 +42,5 @@ Configure to your hearts desire with the in-game config with **[ModMenu](https:/
## Future Goals ## Future Goals
* Forge Port (probably NeoForge 1.21) * Forge Port (probably NeoForge 1.21)
* Custom dismounting logic * Custom dismounting logic
* better config (coming soon!)
* keybindings (next update)