ChatManagePlugin(v2)

English

Overview of This Plugin

This plugin, created by 1510ty, converts Romanized chat text to Hiragana and synchronizes chat across multiple servers.
The chat synchronization feature across multiple servers requires a separate Redis server.
If you do not need the synchronization feature across multiple servers, please refer to the explanation of the config below.

What Will Be Added?

・Converting Romanized text to Hiragana
・Chat synchronization across multiple servers Both features can be enabled or disabled in the config.

Test Environment

Folia 26.1.2 8

Installation Instructions

1. Please set up a Redis server in advance (not required if you are not using the cross-server chat synchronization feature)
   
2. Download the plugin file (.jar)
   
3. Copy or move the downloaded plugin file to the server’s “plugins” folder
   
4. (Re)start the Folia server
   
5. Done!

About config

When you (re)start the server, a “ChatManagePluginv2” folder will be created in the “plugins” folder.
Inside the ChatManagePluginv2 folder, there is a “config.yml” file.
Open the config.yml file.
By default, the content is as follows:

romazitohiragana:
  enable: true
redis:
  enable: true
  host: localhost
  port: 6379
  channel: chat_relay

By default,
・The feature that converts Roman letters to hiragana is enabled
・Redis is enabled
・The Redis server host is localhost
・The Redis server port is 6379
・The channel is chat_relay
.
For example, if you want to disable the feature that converts Roman letters to hiragana (you should generally disable this outside of a Japanese environment; since I am Japanese and this is a plugin used on a Japanese server, the feature that converts Roman letters to hiragana is enabled by default),

romazitohiragana:
  enable: false //Changed
redis:
  enable: true
  host: localhost
  port: 6379
  channel: chat_relay

Also, if you want to change the Redis server's IP address to “192.168.1.50” and the port to 7000,

romazitohiragana:
  enable: true
redis:
  enable: true
  host: 192.168.1.50 //Changed
  port: 7000 //Changed
  channel: chat_relay

Also, if you don't need the chat synchronization feature across multiple servers using Redis,

romazitohiragana:
  enable: true
redis:
  enable: false //Changed
  host: localhost
  port: 6379
  channel: chat_relay

In this case,

  host: localhost
  port: 6379
  channel: chat_relay

This section will be ignored.

Other

The source code is available on GitHub.
Development environment: IntelliJ Idea

日本語

このプラグインの概要

1510tyが作った、ローマ字のチャットをひらがなに変換したり、複数のサーバー間でチャットを同期したりするプラグインです。
複数サーバー間でのチャット同期機能には、Redisサーバーが別途必要です。
複数サーバー間での同期機能が不要な場合は、下のconfigについての説明を見てください。

何が追加されるか

・ローマ字のひらがなへの変換
・複数サーバー間でのチャット同期

テスト環境

Folia 26.1.2 8

インストール方法

1. Redisサーバーを事前に準備しておいてください(サーバー間チャット同期機能を使用しない場合は不要)
   
2. プラグイン ファイル (.jar) をダウンロード
   
3. ダウンロードしたプラグインファイルをサーバーの「plugins」フォルダーにコピーまたは移動
   
4. Foliaサーバーを(再)起動
   
5. 完了!

configについて

サーバーを(再)起動すると、「plugins」フォルダーに「ChatManagePluginv2」フォルダーが生成されます。
ChatManagePluginv2フォルダー内に、"config.yml"ファイルがあります。
config.ymlファイルを開きます。
初期状態では、内容は次のようになっています。

romazitohiragana:
  enable: true
redis:
  enable: true
  host: localhost
  port: 6379
  channel: chat_relay

デフォルトで、
・ローマ字をひらがなに変換する機能は有効
・Redisの使用は有効
・Redisサーバーのホストはlocalhost
・Reidsサーバーのポートは6379
・チャンネルはchat_relay
となっています。
例えば、ローマ字をひらがなに変換する機能を無効にする場合(日本語の環境以外では基本的に無効にするべきです。自分は日本人で、さらに日本のサーバーで使われているプラグインなので、デフォルトでローマ字をひらがなに変換する機能は有効となっています)は、

romazitohiragana:
  enable: false //Changed
redis:
  enable: true
  host: localhost
  port: 6379
  channel: chat_relay

のようにします。 また、RedisサーバーのIPを「192.168.1.50」、ポートを7000に変更したい場合は、

romazitohiragana:
  enable: true
redis:
  enable: true
  host: 192.168.1.50 //Changed
  port: 7000 //Changed
  channel: chat_relay

のように変更します。
また、Redisをつかった複数サーバー間でのチャット同期機能が不要な場合は、

romazitohiragana:
  enable: true
redis:
  enable: false //Changed
  host: localhost
  port: 6379
  channel: chat_relay

のように変更します。この場合、

  host: localhost
  port: 6379
  channel: chat_relay

の部分は無視されます。
みたいな感じです。

その他

ソースコードはGithubで公開してあります。
開発環境: IntelliJ Idea