SimpleStaffChat 1.2.4

Easy-to-use cross-network staff chat

  1. egg82
    Native Minecraft Version:
    1.13
    Tested Minecraft Versions:
    • 1.8
    • 1.9
    • 1.10
    • 1.11
    • 1.12
    • 1.13
    • 1.14
    • 1.15
    Source Code:
    https://github.com/egg82/SimpleStaffChat
    Languages Supported:
    English, Español, Français, Deutsche
    simplestaffchat.png
    Support Discord: https://discord.gg/gY4Hask

    common-installation-tab.png
    The first time SimpleStaffChat is run it will take some time to start up. this is normal, and will very rarely (if ever) take that long again.

    To set SimpleStaffChat up for a single server, simply drop the jar into your "plugins" folder. The auto-generated configuration should default to reasonable values for you, but you may modify it if you wish.

    When setting SimpleStaffChat up for multiple servers (a network) please take a look at the other storage and messaging options available in the configuration and set to best fit your network's needs.

    To add more languages, simply create the appropriate file in the "lang" sub-directory for the plugin.

    For example, you may add Spanish language support by creating a file named "lang_es.yml" or UK English language support by creating a file named "lang_en_GB.yml"

    common-config-tab.png

    Code (Text):
    # How the plugin stores long-term data
    # "external" data sources will also be used as messaging
    storage:
      engines:
        mysql:
          # Whether or not to use MySQL/MariaDB
          # https://mariadb.org/
          enabled: false
          connection:
            # Address and port of the database instance
            address: '127.0.0.1:3306'
            # The name of the database the plugin will store data in
            # This must be created beforehand
            database: 'simple_staff_chat'
            # Table prefix for all plugin tables, indexes, keys, and procedures
            prefix: 'ssc_'
            # Database credentials
            username: ''
            password: ''
            # Extra options to use with the database server
            # These values will override any others
            options: 'useSSL=false&useUnicode=true&characterEncoding=utf8'
        redis:
          # Whether or not to use Redis for storage
          # https://redis.io/
          enabled: false
          connection:
            # Address and port of the Redis instance
            address: '127.0.0.1:6379'
            # Redis credentials
            password: ''
            # Storage prefix for all plugin data
            prefix: 'ssc:'
        sqlite:
          # Whether or not to use SQLite
          # https://www.sqlite.org/index.html
          enabled: true
          connection:
            # File name for the database
            file: 'simple_staff_chat.db'
            # Table prefix for all plugin tables, indexes, keys, and procedures
            prefix: 'ssc_'
            # Extra options to use with the database server
            # These values will override any others
            options: 'useUnicode=true&characterEncoding=utf8'
      settings:
        # The maximum size of the storage engine connection pool
        # Determines the max number of connections to storage engines
        max-pool-size: 4
        # The minimum size of the storage engine connection pool
        # Determines the min number of connections kept alive to storage engines
        min-idle: 4
        # The maximum lifetime of a connection in the pool
        # Should be at least 30 seconds less than any storage engine or infrastructure-imposed connection time limit
        max-lifetime: 1800000 # 30 minutes
        # The maximum number of milliseconds that the plugin will wait for a new connection from the pool before timing out
        timeout: 5000 # 5 seconds
      # The order in which the storage engines will be used
      # The first available engine will be considered the "master" and will be the authoritative data source
      # Keep in mind that, for redundancy, ALL defined and enabled storage engines will be used
      order:
        - 'mysql'
        - 'redis'
        - 'sqlite'

    # How the plugin rapidly shares information with other servers along the network
    # Note that cross-server chat toggling only works if a messaging engine is provided
    # Else any toggled chat will be erased when the player leaves the server
    messaging:
      engines:
        rabbitmq:
          # Whether or not to use RabbitMQ for messaging
          # https://www.rabbitmq.com/
          enabled: false
          connection:
            # Address and port of the RabbitMQ instance
            address: '127.0.0.1:5672'
            # RabbitMQ virtual host
            v-host: '/'
            # RabbitMQ credentials
            username: 'guest'
            password: 'guest'
        redis:
          # Whether or not to use Redis for messaging
          # https://redis.io/
          enabled: false
          connection:
            # Address and port of the Redis instance
            address: '127.0.0.1:6379'
            # Redis credentials
            password: ''
      settings:
        # The maximum size of the messaging engine connection pool
        # Determines the max number of connections to messaging engines
        max-pool-size: 5 # + 1 for the receiver
        # The minimum size of the messaging engine connection pool
        # Determines the min number of connections kept alive to messaging engines
        min-idle: 5 # + 1 for the receiver
        # The maximum lifetime of a connection in the pool
        # Should be at least 30 seconds less than any messaging engine or infrastructure-imposed connection time limit
        max-lifetime: 1800000 # 30 minutes
        # The maximum number of milliseconds that the plugin will wait for a new connection from the pool before timing out
        timeout: 5000 # 5 seconds
      # The order in which the messaging engines will be used
      # Keep in mind that, for redundancy, ALL defined and enabled messaging engines will be used
      order:
        - 'rabbitmq'
        - 'redis'

    chat:
      # Message format to use for admin chat
      format: '&6[&r{server}&r&6] [&r{level}&r&6] &b{player} &7>>&r {message}'
      # Whether or not to allow Minecraft color/format codes in chat messages
      allow-codes: true
      # Whether or not to use the levels system, or ignore the levels system and just use and assume one level for everything
      # True allows greater control and flexibility
      # False will simplify the usage of the plugin
      use-levels: true

    # When true, logs some extra output to the console so you can see if/why things might be failing
    debug: false
    # Default language (affects console output)
    lang: 'en'

    stats:
      # Whether or not to send anonymous usage statistics to bStats
      # True: Send anonymous stats; let the author know how well the plugin is doing and how it's used!
      # False: Do not send stats and make the author sad :(
      usage: true
      # Whether or not to send anonymous errors to the author
      # True: Send errors anonymously to GameAnalytics so the author can fix them!
      # False: Do not send errors and wonder why any bugs you encounter haven't been fixed
      errors: true

    update:
      # Whether or not to automatically check for updates and notify the console if found
      check: true
      # Whether or not to notify players with the ssc.admin permission node
      notify: true

    # Config version, no touchy plz
    version: 1.2
    common-commands-tab.png
    /ssc reload - Reloads the plugin configuration. This will disconnect and reconnect (if appropriate) any services configured in the config.yml file.
    /ssc import <master> <slave> [batchSize] - Import data from master to slave. Optionally specify batch size for larger/longer imports.
    /ssc level <level> <name> - Set an existing level's new name or create a new level.
    /chat,sc,ao,admin,post <level> [chat] - Send a message to everyone with permissions to see the level you're chatting in. Optionally (if not specifying a message) toggle your chat state in that level so you can simply chat normally, without the use of commands.

    common-permissions-tab.png
    ssc.admin - allows access to the /ssc reload, /ssc import, and /ssc level commands
    ssc.level.[X] - allows access to chatting in/seeing messages from the specified level

    common-donations-tab.png
    Please consider donating to support this free plugin!
    PP_logo_h_150x38.png
    common-api-tab.png
    API source is available on GitHub, and documentation coming soon!​

Recent Reviews

  1. PhoebePower
    PhoebePower
    5/5,
    Version: 1.0.1
    Great plugin. Been watching it for a while! Do you think you could possibly release a sponge compatible version?
    1. egg82
      Author's Response
      I've never made a Sponge plugin before, but it's definitely on my to-do! I'll give it a shot when I have time (or if someone else would like to try as well)

      Thanks for the review!