Configuration
hChat
- Main Page
- Commands and Permissions
- Variables and Codes
- # Configuration
- Source @ GitHub
- Stats @ MCStats
Main Configuration
This is the config.yml file.
| Key | Description | Value type |
|---|---|---|
| enable | Enable plugin | Boolean |
| check_for_updates | Check for plugin updates and download if available | Boolean |
| update_if_available | Download update. If disabled, it only checks. | Boolean |
| format.name | Format display name | Boolean |
| format.chat | Format chat messages | Boolean |
| format.death | Format death messages | Boolean |
| format.list | Format list name | Boolean |
| format.join | Format join messages | Boolean |
| format.quit | Format quit messages | Boolean |
| format.channel_join | Format channel join messages | Boolean |
| format.channel_quit | Format channel quit messages | Boolean |
| format.away_start | Format away start messages | Boolean |
| format.away_stop | Format away stop messages | Boolean |
| format.away_kick | Format away kick messages | Boolean |
| format.motd | Format motd messages | Boolean |
| format.me | Format me messages | Boolean |
| format.tell | Format tell messages | Boolean |
Group Configuration
The groups.yml file keeps the groups. These groups can be linked to groups in your permission plugin by setting the string/text ID of a group section to the same as in your permission group layout. If a matching group for a player is not found, the default group will be used. The default group need to contain all values, but other groups don't and will inherit missing values from the default group. If you want an example of fancy colors and stuff, check out this example: config.yml. The group settings are described below:
| Key | Description | Value type |
|---|---|---|
| name | Name of group (does not have to be the same as the ID) | String |
| prefix | Prefix | String |
| suffix | Suffix | String |
| format.name | Display name format | String |
| format.list | List format | String |
| format.chat | Chat format | String |
| format.death | Death format | String |
| format.join | Join format | String |
| format.quit | Quit format | String |
| format.channel_join | Channel join format | String |
| format.channel_quit | Channel quit format | String |
| format.away_start | Away start format | String |
| format.away_stop | Away stop message | String |
| format.away_kick | Away kick format | String |
| format.me | Me format | String |
| format.tell_sender | Tell format for sender | String |
| format.tell_receiver | Tell format for receiver | String |
| format.tell_spy | Tell format for spy/mod/admin | String |
| format.motd | Motd format | String |
| censor | If chat from group should be censored | Boolean |
| color_codes | If group can use color codes in chat messages | Boolean |
| can_chat | If group can chat | Boolean |
| show_personal_messages | If personal messages should be written to console. | Boolean |
| away_long_tag | Away long tag. Normally "[AFK]". | String |
| away_short_tag | Away short tag. Normally just a color code. | String |
| away_threshold_seconds | Seconds from a player moves, or similar, before being flagged as away | Integer |
| kick_on_away | If players should get kicked when going away | Boolean |
| channel_default | Default channel for all worlds | String |
| channel_world_default.<world> | Default channels for specific worlds. Overrides channel_default. | String |
Channel Configuration
The channels.yml file keeps the channels. Channels can be joined wither by commands or automatically. The default channel will always be present, but the other channels will not copy any of its values. You can have multiple default channels by defining different default channels for each group or world. If you set a channel as private and as default in some group or world, players will automaticallt join it and be able to leave to it, but not intentionally join it by using commands from for example another world or group. The channel settings are described below:
| Key | Description | Value type |
|---|---|---|
| name | Name of channel (does not have to be the same as the ID) | String |
| owner | UUID of the channel owner. Only the owner can edit a channel. | UUID string |
| password | Password to join the channel | String |
| chat_format | A specific chat format for the channel. Leave blank to use chat format from group. | String |
| private | Privacy of group. If private, only the owner, member groups, members and admins may join. | Boolean |
| hidden | If it should be visible in the channel list and channel who list. | Boolean |
| censor | If it should be censored | Boolean |
| color_codes | Allow color codes in chat. It has to be disabled in both the group and channel to disallow. | Boolean |
| universal | If the chat messages should be broadcasted across all world | Boolean |
| auto_join_if_default | If this is the default channel for a group, force players to join it when changing worlds | Boolean |
| range | Range of chat in blocks | Decimal or integer |
| monitor_channels | Channels players in this channel will receive chat messages from, if the individual player has access to that group. Passworded groups can not be monitored. | String list |
| member_groups | Member groups | String list |
| members | Player members | UUID string list |
| banned_members | Banned members. These may only join if this is their default channel. | UUID string list |
Censor Configuration
The censor.yml file is a dictionary for words that should be replaced. The file consists of pairs of words or sentences (string keys and string values). The words to the left will be replaced by words to the right. After the file is created, two examples will be inserted.