forked from virt-mirrors/Sit
Merge remote-tracking branch 'origin/master'
This commit is contained in:
Oth3r
commit
86066ebfb1
1 changed files with 48 additions and 26 deletions
74
README.md
74
README.md
|
|
@ -1,46 +1,68 @@
|
|||
# Sit!
|
||||
[](https://github.com/Oth3r/Sit/releases) [](https://crowdin.com/project/oth3r-sit) [](https://www.oth3r.one/discord)
|
||||
<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;">
|
||||
|
||||
[](https://github.com/Oth3r/Sit/releases) [](https://crowdin.com/project/oth3r-sit) [](https://www.oth3r.one/discord)
|
||||
|
||||
[](https://modrinth.com/mod/sit!) [](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!)*.
|
||||
\
|
||||
[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)!
|
||||
|
||||
### 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!
|
||||
[](https://modrinth.com/mod/caligo)
|
||||
[](https://modrinth.com/mod/directionhud)
|
||||
[](https://modrinth.com/plugin/directionhud-plugin)
|
||||
|
||||
<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>
|
||||
|
||||
# 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!
|
||||
<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">
|
||||
|
||||
|
||||
### 🟩 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.
|
||||
<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">
|
||||
|
||||
|
||||
### ⌨️ 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!
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
### 📃 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">
|
||||
|
||||
## 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)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue