Git Product home page Git Product logo

townychatremake's Introduction

๐Ÿ’ฌ TownyChatRemake โœจ

TownyChatRemake is a simple yet fully customizable chat plugin that syncs with Towny.

๐Ÿ‘€ Preview

image

โœจ Features

  • Towns and nations specific channels
  • Fully customizable and easy-to-use configuration for server owners
  • User-friendly shortcut commands
  • Spy mode
  • DiscordSRV support

๐Ÿ›  Usage

โš ๏ธ You must use Paper 1.18.2 to run this plugin.

This is because it uses the Adventure library to handle chat formatting.

Commands

  • /chat <channel> - Switch between channels, e.g. /chat town
  • /town toggle chat - Toggle town chat
  • /nation toggle chat - Toggle nation chat
  • /gc /tc /nc - Channel shortcut commands, e.g. /tc hi town!, can be modified in the config.
  • /ta reload chat - Reload config

Permissions

  • townychat.chat - Default permission to switch channels
  • townychat.spy - Toggle spy mode, it allows you to receive messages from all the channels
  • townychat.format - Chat formatting with the MiniMessage Format

Config

Everything should be explained in the config.yml file, but here are some reminders:

โš™๏ธ Recommended Towny Settings

town.set_tag_automatically = true
nation.set_tag_automatically = true

DiscordSRV Channels

While this plugin supports DiscordSRV on the global channel, You can also link Discord channels to towns and nations specific in-game channels.

Go to DiscordSRV's config.yml and to the Channels setting. You can add channels using this format: "government-name" (e.g. "town-mytown"), all lowercase.

๐Ÿ“‹ To do list

By priority:

  • Better permissions

    • townychat.hear.<channel> - Recieve message from that channel
    • townychat.write.<channel> - Write in that channel
    • townychat.format.
      • colors - Use the colors in message (e.g aqua or #00FF00)
      • decorations - Use decoration in message (italic, bold, underline, strikethrough, obfuscated)
      • misc - Use every other MiniMessage features in message (click, hover, keybind, translatable, insertion, rainbow, gradient, transition, font, newline)
  • Switch channels quickly with /tc /nc /gc...

  • Cooldown

  • Support for legacy colors formatting (e.g. &e for yellow text)

  • (?) Custom channels

  • (?) Muteable parameter for channels

๐Ÿ™ Support

Please contact PainOchoco#3570 on Discord if you have any issues or requests!

townychatremake's People

Contributors

groobledierne avatar painochoco avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.