fill1890 / FabSit

Fabric sit mod for Minecraft
MIT License
12 stars 6 forks source link

FabSit: Sit mod for Fabric

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

Required server-side, but is optional client-side - currently allows for client-side translation if installed. New client features may be added later.

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

The mod eventually aims to provide near-feature parity to the GSit mod for Spigot however implementation is ongoing. Exact behaviour matching is not guaranteed.

Available on Github, Modrinth and CurseForge

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.

Players can also right-click on a slab or stair with an empty hand to sit on it; this is disabled by default but can be enabled in the config file.

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 use /fabsit reload to reload the config file from disk. Requires op level 2 by default

Configuration

Use /fabsit reload to reload the config file on-the-fly.

Configuration file with default values is as follows:

{
  // Locale to use for server-side translation
  // Currently only supports en_us
  "locale": "en_us",

  // Allow poses underwater?
  "allow_posing_underwater": false,

  // Allow poses midair? Note that this will likely
  // interfere with fall damage if enabled
  "allow_posing_midair": false,

  // Force players to sit in the centre of a block
  "centre_on_blocks": false,

  // Allow players to sit on a stair or slab by right-clicking
  "right_click_sit": false,

  // adjusts the behaviour when hiding players using /lay and /spin
  // try disabling this if there is erratic behaviour using these commands
  "strongly_remove_players": true,

  // server-enabled poses. If LuckPerms is installed,
  // prefer using permissions instead as they are dynamic
  "allow_poses": {
    "sit": true,
    "lay": true,
    "spin": true
  },

  // enable/disable update messages
  "messages": {
    // send a custom message to the action bar
    "action_bar": true,
    // send an error message in chat if the player can't pose
    "pose_errors": true
  }
}

Internationalization

FabSit supports both server-side and client-side translation.

If the mod is installed on the client, the server will send a translation key for the client to translate into its own locale, assuming the mod has support for it.

If not, the server will translate into the locale set in the config file.

Currently the mod is english-only - if you would like to contribute a translation feel free to open an issue or a pull request.