diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf88c62 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Sit! +[![github](https://img.shields.io/github/v/release/oth3r/Sit?color=blueviolet&logo=github)](https://github.com/Oth3r/Sit/releases) [![discord](https://dcbadge.vercel.app/api/server/Mec6yNQ9B7?style=flat)](https://discord.gg/Mec6yNQ9B7) [![modrinth](https://img.shields.io/modrinth/dt/sit!?label=Modrinth&logo=modrinth)](https://modrinth.com/mod/sit!) [![curseforge](https://cf.way2muchnoise.eu/843483.svg)](https://www.curseforge.com/minecraft/mc-mods/Sit!) + +**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! + +![overview](https://github.com/Oth3r/Sit/blob/master/media/overview.gif?raw=true) +## Check out my other Projects! +[![DirectionHUD badge](https://github.com/Oth3r/DirectionHUD/blob/master/media/DirectionHUD%20badge.png?raw=true)](https://modrinth.com/mod/directionhud) +[![DirectionHUD Spigot badge](https://github.com/Oth3r/DirectionHUD/blob/master/media/DirectionHUD%20Spigot%20badge.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! + +![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 + * Client & Server sync to have custom hand restrictions per player \ No newline at end of file