Socialismus

configurations

settings.yml

0 - Standard information

1 - Debug mode

2 - Debug mode but with much more information

log-level: 0

This option allows you to disable or enable the update checker, which checks

for updates every hour.

update-checker: true

In this section you can disable or enable the desired module.

true - enabled

false - disabled

modules:

The chat module changes the behaviour of the vanilla Minecraft chat and adds

more formatting and customization, allowing you to create several different

chat with different requirements and styles.

chats: true

Swapper module adds to your chat message shortcuts, emojis or anything you

can imagine.

swapper:
enabled: true

Suggests swappers in chat (only for swappers without regex).

Works only if ProtocolLib is installed

suggest: true

Bubble chat is a module that changes the way players chat with each other.

It adds a bubble (hologram) with a message from the chat over the player's head.

Works only if ProtocolLib is installed

bubblechat: true

The announcer module allows you to create announcements that will be displayed

on the server. You can create as many announcements as you want and set the

time interval between them.

announcer: true

The chat mention module allows you to mention a player in the chat by typing

@playername. The player will receive a notification that he has been mentioned.

It is recommended to enable it for chat OR bubbles, not both

chatmention:

Enable for chats allows you to enable or disable whether the module should work

in the chat.

enable-for-chats: true

Enable for bubbles allows you to enable or disable whether the module should work

in the bubbles.

enable-for-bubbles: true

In this section, you can switch the plugin's behavior mode, which

can impact its performance and usage of resources.

true - enabled

false - disabled

performance:
caching: true

commands.yml

#

PARAMETER EXPLANATION:

#

command: allows you to change the command and its aliases by printing all

aliases separated by | symbol.

#

permission: needed right for player/staff to use this specific command and

aliases. You can leave it empty to disable it.

#

syntax: this parameter is printed if the command is used incorrectly.

#

enabled: almost all commands can be enabled or disabled with this option.

main-command:
command: "socialismus|social"
permission: "socialismus.player"
reload-command:
sub-command: "reload"
permission: "socialismus.reload"
enabled: true
announce-command:
sub-command: "announce|broadcast|bc"
permission: "socialismus.announce"
syntax: "[announcement id]"
enabled: true
private-message-command:
command: "msg|w|reply"
permission: "socialismus.player"
syntax: "[recipient] [message]"
enabled: true
bubble-command:
sub-command: "bubble"
permission: "socialismus.bubble"
syntax: "[message]"
enabled: true

messages.yml

chat:

Set 'no-online-players: null' to disable the message

no-online-players: "ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | Nobody received your message because there are no players on the server."

Set 'no-nearby-players: null' to disable the message

no-nearby-players: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | No one has heard you."
insufficient-players: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | There must be at least {minOnline} players on the server to send a message to this chat"
no-use-permission: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You've no permission to send a message"
too-small-message: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | Your message is too short to be sent."
forbidden-world: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You can't chat in this world."
swapper:
no-use-permission: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You don't have permission to use that swapper"
bubblechat:

Set 'noSendPermission: null' to disable the message

no-use-permission: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You've no permission to send a bubble message"
too-small-message: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | Your message is too short to be sent."
forbidden-world: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You can't bubble in this world."
commands:
only-for-player: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | This command can only be used by players."
wrong-syntax: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You used the command incorrectly."
unknown-command: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You used a command that doesn't exist."
error-occurred: "An error occurred while executing the command."
missing-argument: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You did not specify the required argument to execute the command."
player-not-found: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | Player could not be found because he is offline or does not exist."
same-player: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You cannot use this player in this scenario."
main-command:
description: "Help command"
command-format: " {command}{subCommand} - {description}"
help-format:

• " "
• " Command help [List of commands]"
• "{commands}"
• " "

reload-command:
description: "Reloads plugin configuration"
reloaded-successfully: "Configs were successfully reloaded"
announce-command:
description: "Announces a message to the server"
no-announcement: "No announcement with that id was found"
announce: "Announcing announcement"
private-message-command:
description: "Send player a private message"
format: "{senderName} -> {recipientName}: {message}"
bubble-command:
description: "Send a message in a bubble."
success: " ꜱᴏᴄɪᴀʟɪꜱᴍᴜꜱ | You sent a message in a bubble."

chats.yml

#

CHATS DOCUMENTATION:

#

Here you can create as many Chats as you like.

chats:

Here you can specify a chat id, it should be unique and not used in any other chat.

- id: "example"

#

Here you can specify how you want to use the chat.

usage:

In type you need to specify the method that will be used to trigger the chat.

Possible values:

- SYMBOL (using a symbol in the chat)

- COMMAND (using a command)

- SYMBOL_COMMAND (combining these 2 options)

type: SYMBOL_COMMAND

symbol: "!"

command: "example"

#

Message Format allows you to specify the design of the final message that will be shown

to the players. You can use PlaceholderAPI placeholders, MiniMessage formatting and

internal {playerName}/{message} placeholders.

message-format: "{playerName}: {message}"

#

In this list, you can specify what and how to show players when they hover their mouse

over the message format. You can use PlaceholderAPI placeholders and MiniMessage formatting

hover-format:

- "Oh look at that!"

- "Oh look at that!"

#

Here you can specify the requirements for using this chat.

requirements:

This option allows you to disable requirements check, it is advised to think about if you

need the requirements or not, because if you disable the performance will be much better.

enabled: true

sender:

This option allows you to specify the minimum online players required to use this chat.

min-online: 0

Here you can set a number of symbols that players must write to be able to send this

message in this chat.

symbol-count-threshold: 0

Here you can specify the permission that the player must have to use this chat.

use-permission: "i.love.whereareiam"

Here you can specify the worlds in which the player can use this chat.

worlds:

- "world"

- "world_nether"

- "world_the_end"

#

recipient:

This option allows you to specify the radius in which the player will see the message.

radius: -1

This option allows you to specify whether the player will see his own message.

see-own-message: true

This option allows you to specify the permission that the player must have to see this

see-permission: "whereareiam.is.the.best"

Here you can specify the worlds in which the player can see this chat.

worlds:

- "world"

- "world_nether"

- "world_the_end"

chats:

• id: "global"

usage:
type: SYMBOL_COMMAND
symbol: ""
command: "global"
message-format: "G | %luckperms_prefix%{playerName}: {message}"
enable-swapper: true
mentions:
enabled: true
mention-self: false
mention-all: false
mention-nearby: false
max-mentions: 5
radius: 100
hover-format:

• " "
• " Information"
• " Message was sent at: %player_world_time_24%"
• " "
• " World: %player_world_name%"
• " XYZ: %player_location_x%, %player_location_y%, %player_location_z%"
• " "

requirements:
enabled: true
sender:
min-online: 0
symbol-count-threshold: 0
use-permission: ""
worlds: []
recipient:
radius: -1
see-own-message: true
see-permission: ""
worlds: []

example-swapper.yml

#

SWAPPER DOCUMENTATION

#

- whereareiam:

Preface, it was described earlier that you can use this to create shortcuts for

messages or emojis. But all functionality is not limited to that, you can create

much more, it only depends on your imagination.

#

If you have any suggestions for improvements to this module, please feel free to

post a suggestion on the github page. github.com/whereareiam/Socialismus

#

Here you can create as many Swappers as you like.

swappers:

#

Swapper toggle allows you to specify if it is enabled and if it is usable for players,

a good option if you need to temporarily disable it instead of deleting it.

- enabled: true

#

Content allows you to specify a list of content to replace a placeholder with.

You can use PlaceholderAPI placeholders and MiniMessage formatting.

content:

- "example1"

- "%player_name% is amazing!"

- "%itemsadder_my_super_custom_symbol%"

#

Here you can specify the content that will be displayed when the mouse is hovered

over the replaced placeholder.

You can use PlaceholderAPI placeholders and MiniMessage formatting.

content-hover:

- "Oh look at that!"

#

Swapper's settings allow you to customize how it will behave.

settings:

Here you can specify what permission a player needs to use this swapper. If the

required permission is not given, the player will get a message if it is not set to null.

Set 'permission: ""' to disable permission check.

permission: "privilege.2"

#

The Direct Search option controls how the search works. If you set it to true, it will

search exactly for this placeholder and will not care if it is in the middle of a text

or not.

#

EXAMPLE

Our text is: "I like bananas".

Our placeholder is: "an".

The content is: "wow!"

In the end, our text will change to this:

"I like bwow!wow!as".

direct-search: true

#

The Random content option controls the behavior of the content list. If you set it to

true, it will grab any value from content and insert it instead of a placeholder. If

you set it to true, it will grab any value from content and insert it instead of a

placeholder. If you set it to false, the first content will be grabbed and inserted

instead of the placeholder.

If you want to use regex patterns in your placeholder, change this option to true and

add $ to the beginning of your regex pattern in the placeholder list.

random-content: true

#

A list of placeholders that will be replaced with content from the list above.

placeholders:

- "{example}"

- "$(banana|bananas)"

- ":lol:"

#

Here you can set requirements for using this swapper.

requirements:

enabled: true

use-permission: "swapper.test"

swappers:

• enabled: true

content:

• ":)"

content-hover: []
placeholders:

• "{happy}"

settings:
direct-search: true
random-content: false
requirements:
enabled: false
use-permission: ""

• enabled: true

content:

• ":("

content-hover: []
placeholders:

• "{sad}"

settings:
direct-search: true
random-content: false
requirements:
enabled: false
use-permission: ""

• enabled: true

content:

• "