Skip to content

Home

Jump to bottom
Phinner edited this page Dec 13, 2024 · 3 revisions

Welcome to the flex wiki! Here are a few instructions to get started.

Installation

This plugin requires at least :

Configuration

The configuration file is located in /config/mods/flex/config.yaml:

# Builtin flex hooks configuration
hooks:
  # Redirect chat processing to flex (beware, it overrides the "send message" packet listener)
  chat: false
  # Use flex for displaying player join messages (beware, it will always set "showConnectMessages" to false to avoid conflicts)
  join: false
  # Use flex for displaying player quit messages (beware, it will always set "showConnectMessages" to false to avoid conflicts)
  quit: false
  # Name hook configuration
  name:
    # If enabled, flex will update the display name of all online players periodically
    enabled: false
    # The update interval of the name hook
    update-interval: "500ms"

# Translator configuration (3 back-ends are supported)
translator:
  # The default back-end, all translations will fail
  "None"
  
  # DeepL, commercial translation solution (https://www.deepl.com)
  # Provides excellent quality translations, their free tier is ideal for small to medium activity servers
  # Your DeepL API token
  deepl-token: "xxx"

  # LibreTranslate, self-hosted translation solution (https://github.com/LibreTranslate/LibreTranslate)
  # Translation quality is medium, ideal for high activity servers with the means to host an instance
  # The LibreTranslate API endpoint
  lt-endpoint: "https://translation.example.com/"
  # Your LibreTranslate API token (optional if you use one of the free instances
  lt-token: "xxx"

# Predefined text with placeholders
templates:
  # The name of your template
  greeting:
    # The steps composing your template
    steps:
      # A simple text step
      - text: "Hello "
      # This step has a filter, it will only append the text if the subject is an online player
      - if: "player:name"
        text: "%player:name%"
      # Let's add the same filter with a "not" condition so we can still have a fallback name
      - if: { not: "player:name" }
        text: "Unknown"
      # Finish up
      - text: ", nice to meet you"
Clone this wiki locally