ENG Yamls - Avankziar/MyHomeRules GitHub Wiki

Plugin

Status 09.04.2021
name: MyHomeRules
main: main.java.me.avankziar.myhomerules.spigot.MyHomeRules
version: 5
author: Avankziar
api version: 1.16
description: A rules accepting plugin
website: https://www.spigotmc.org/resources/my-home-rules.79165/
softdepend: [InterfaceHub]

Config

Language: GER
Mysql:
  Status: false
  Host: 127.0.0.1
  Port: 3306
  DatabaseName: mydatabase
  SSLEnabled: false
  AutoReconnect: true
  VerifyServerCertificate: false
  User: admin
  Password: not_0123456789
  TableNameI: MyHomeRulesPlayerData

# RunTaskTimer is in minutes, when the notification (that you have to accept the rules) should be repeated.
RunTaskTimer: 1

# KickEndTimer refers in minutes to how long the player has after the last notification to accept the rules.
# The first for single page view, the second for multiple page view. For the second, only this number counts as a delay.
KickEndTimerSimpleSite: 1
KickEndTimerMultipleSite: 5

# How often the notification should come.
HowOftenSendMessageBeforeKick: 4

# The special command to accept the rules too. (This will be redirected internally to the default command.
CustomCommand: /dsgvo

# The boolean to set when and if the list of commands are executed on accept and revoke.
Use:
  CommandByAccept: true
  CommandByRevoke: false

# The actual command lists
# If it starts with player, it will be executed for the player, but AS this player.
# If it starts with console, it will be executed in the console.
# %player% is a replacer for the player name.
CommandsBy:
  Accept:
  - player<->default test %player%
  - console<->default test %player%
  Revoke:
  - player<->default test %player%
  - console<->default test %player%
# Defines whether to use the simple format or the multiple page format.
RunTask:
  SimpleSite: true
# For server rules in the "key" path, the separator.
Rules:
  RuleSeperator: x

# Do not touchy
Identifier:
  Click: click
  Hover: hover
Seperator:
  BetweenFunction: '~'
  WhithinFuction: '@'
  Space: +
  HoverNewLine: ~!~

Languages

I will not explain the language files in the wiki, because there is actually nothing to explain.
Except that about 450 languages are supported but only English and German are included by default. If you use other languages, so you can send me your translation, then I maintain them. Here a pictorial indication, which languages are supported: ISO639-2B

Multiple page view

The multiple page view is for when you need multiple pages to explain your rules and the server to players.

# The '1' is the page number. This is also what is meant when talking about /rules site <number>, in the command. Only integers can be used.
# The rest behaves like the simple format.
'1':
  Message:
  - §d======§c======§e======§7[§bMyHome&4Rules§7]§e======§c======§d======
  - §bTo enable a pleasant climate on the server,
  - §bcertain rules must be followed. §c/rules~click@RUN_COMMAND@/rules~hover@[email protected]
  - §bYou can find the DSGVO guidelines at §c/dsgvolink~click@RUN_COMMAND@/dsgvolink~hover@[email protected]
  - §bNews and messages can be found at §c/forum~click@RUN_COMMAND@/forum~hover@[email protected]
    §bRead more.
  - §2-----------------------------------------------------
  - §0.
  - §6=====§2click §2here§6======>> §4§l§o/dsgvo~click@RUN_COMMAND@/dsgvo~hover@[email protected]
    §6<<<======§2Klick §2hier§6=====
  - §0.
  - §2-----------------------------------------------------
  - §next+page+=>~click@RUN_COMMAND@/rules+site+2~hover@[email protected]
  Hover:
    Message:
      LineTwo: '&eClick here to run the command &c/dsgvolink &directly.~!~&eThis
        will redirect you to the DSGVO guidelines.'
      LineThree: '&eClick here to execute the command &c/rules &directly.~!~&eThis
        then redirects you to the actual rules.'
      LineFour: '&eClick here to be redirected to the forum.~!~&eThere you can read
        find all updates, news and~!~&eDisscusions, and even vote on topics.
        topics.'
      LineSix: '&eClick here to confirm the rules.'
      Base: '&eClick here to access the rules on the website.'
    Command:
      Next: '&eClick here to go to the next page.'
      Past: '&eClick here to go to the previous page.'
'2':
  Message:
  - §eHere is the next page
  - §dHere is the second line.
  - §e<=+previous+page~click@RUN_COMMAND@/rules+site+1~hover@[email protected]

Server rules

The server rules are another information point. They are divided in the file by the separator symbol from the config. Default would be "x". Means the first rule would be "1". But the first subrule of the first rule is then written "1x1".

'1':
  Number: '1'
  Name: §9Be kind to each other
  Lines:
  - §eNo insults.
  - §6No hostilities.
1x1:
  Number: '1.1'
  Name: §9Laugh and have fun
  Lines:
  - §eJokes allowed!
  - §6But nothing below the belt!
⚠️ **GitHub.com Fallback** ⚠️