From 61ff50a81d02d0604c98e498fea227a7abcc3d16 Mon Sep 17 00:00:00 2001 From: Oth3r <68134921+Oth3r@users.noreply.github.com> Date: Fri, 6 Jun 2025 20:01:52 -0500 Subject: [PATCH 1/2] add OtterLib dependency message, fixes #23 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b851d3a..2457022 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ The mod also has full Geyser support! Enjoy sitting with everyone, weather they ### 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) From bc23a3d2c258f2d4dd3f65888d259003b302c8f9 Mon Sep 17 00:00:00 2001 From: Oth3r <68134921+Oth3r@users.noreply.github.com> Date: Fri, 6 Jun 2025 20:09:48 -0500 Subject: [PATCH 2/2] README refresh --- README.md | 74 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 47 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 2457022..47fbea2 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,68 @@ -# 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) + + +[![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! + +### **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. ### 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. +**Sit!** works on the server, without the players needing to install the mod *(singleplayer included!)*. \ -[Farbric API](https://modrinth.com/mod/fabric-api) and [OtterLib](https://modrinth.com/mod/otterlib) is required to for the mod to load. +[Fabric 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) +### 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! ## 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) + + + Caligo badge + + + Directionhud badge + + + More Heart Types badge + # Features -### Hand Restrictions +### 🤚 Hand Restrictions Don't want to accidentally sit down? Set custom restrictions for each hand in the config! +\ +Use **player unique** 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! +per player hand restriction showcase -![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 sitting options! +\ +With the new config system, block tags and custom blockstates can be used to mass select blocks at ease. -### 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. +players sitting on a vast range of blocks -![custom blocks](https://github.com/Oth3r/Sit/blob/master/media/custom-blocks.gif?raw=true) +### ⌨️ Keybinds +Don't want to sit with the **just** the hand? Use a keybind or type a command to sit instead! -### 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! +setting keybinds for the sit mod, and sitting by using them -![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) +### 📃 Customizable Config +Don't like the default settings? Go wild in the config for yourself or your players! +the Sit! config wiki page ## Future Goals - * Forge Port (probably NeoForge 1.21) - * Custom dismounting logic - * better config (coming soon!) - * keybindings (next update) + * NeoForge Port + * Full config via [OtterLib](https://modrinth.com/mod/otterlib)