Skip to content

Commit

Permalink
Add description
Browse files Browse the repository at this point in the history
Used for CurseForge and Modrinth pages
  • Loading branch information
fill1890 committed Jun 23, 2022
1 parent 88749c9 commit 9e2314e
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## FabSit: Sit mod for Fabric

Ever wanted to use `/sit` on a fabric server? This mod is for you!

Required server-side. Can be installed client-side for local translation (maybe more features Soon).

The mod currently implements `/sit`, `/lay` and `/spin`.

The mod eventually aims to provide near-feature parity to the [GSit](https://www.spigotmc.org/resources/gsit-modern-sit-seat-and-chair-lay-and-crawl-plugin-1-13-x-1-19-x.62325/)
mod for Spigot however implementation is ongoing. Exact behaviour matching is not guaranteed.

See the [Github](https://github.com/fill1890/FabSit) page for configuration and internationalization details.

Available on [Github](https://github.com/fill1890/FabSit), [Modrinth](https://modrinth.com/mod/fabsit) and
[CurseForge](https://www.curseforge.com/minecraft/mc-mods/fabsit)

Requires the Fabric API

## Usage

Simply add the jar file to your server mods directory, and optionally to the client directory.

Players can then use `/sit` to sit, `/lay` to lie down or `/spin` to start spinning.

## Permissions

Permissions to pose are granted to all players by default.

### `fabsit.commands` node

`sit, lay, spin:` specific permission to use appropriate poses

### `fabsit.reload`
Permission to reload the config file from disk. Requires op level 2 by default

0 comments on commit 9e2314e

Please sign in to comment.