From 0f77b5cff747c867e458778c26f9fa66d015da98 Mon Sep 17 00:00:00 2001 From: fazziclay Date: Sat, 3 Apr 2021 10:02:40 +0300 Subject: [PATCH] edit README.md and added README_RU.md. added comments to config.yml --- README.md | 55 +++++++++++++++++++++++------------------ README_RU.md | 58 ++++++++++++++++++++++++++++++++++++++++++++ resources/config.yml | 17 ++++++++----- 3 files changed, 100 insertions(+), 30 deletions(-) create mode 100644 README_RU.md diff --git a/README.md b/README.md index 4cc87f8..1d2d6a5 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ # OpenPrivateMessages ## Minecraft bukkit plugin. +--- +RUSSIAN README - [README_RU.md](./README_RU.md) + +--- + ### config.yml ```yaml -commandUsing: "Используйте /$command " -# Когда команда исполняется без аргумента игрока или сообщения +commandUsing: "Use /$command " +# When a command is executed without a player argument or message -playerNotFound: "Игрок не найден." -# Когда получатель сообщения не онлайн. +playerNotFound: "Player not found" +# When the recipient of the message is offline. timeFormat: "dd.MM.yyyy HH:mm:ss" -# Формат времени. Нужно для переменной $time +# Time format. Required for the $time variable -recipientMessage: # Сообщение со стороны получателя +recipientMessage: # Message from the recipient's side Pattern: "$sender_nickname -> $recipient_nickname: $message" Hover: Enable: true @@ -21,8 +26,8 @@ recipientMessage: # Сообщение со стороны получателя Enable: true Text: "/$command $sender_nickname " -senderMessage: # Сообщение со стороны отправителя - Pattern: "&2Сообщение отправлено!" +senderMessage: # Message from the sender's side + Pattern: "&2Message sent!" Hover: Enable: true Text: "&9~~~~ PrivateMessage ~~~~\n&a$sender_nickname &7-> &a$recipient_nickname\n&d(Click to send $recipient_nickname)\n\n&f$message" @@ -31,28 +36,30 @@ senderMessage: # Сообщение со стороны отправителя Text: "/$command $sender_nickname " ``` -### Доступные переменне в конфиге +### Available variables in config **recipientMessagePattern** & **senderMessagePattern**: -- $recipient_nickname - Ник получателя -- $sender_nickname - Ник отправителя -- $message - Контент сообщения -- $time - Время при отправке +- $recipient_nickname - The recipient's nickname +- $sender_nickname - Sender's nickname +- $message - Message content +- $time - Time when sending **recipientMessageClickText**: -- $command - Используемая команда -- $sender_nickname - Ник отправителя -- $time - Время при отправке +- $command - Command to use +- $sender_nickname - Sender's nickname +- $time - Time when sending **senderMessageClickText** -- $command - Используемая команда -- $recipient_nickname - Ник получателя -- $time - Время при отправке +- $command - Command to use +- $recipient_nickname - The recipient's nickname +- $time - Time when sending **recipientMessageHoverText** & **senderMessageHoverText**: -- $sender_nickname - Ник отправителя -- $recipient_nickname - Ник получателя -- $message - Контент сообщения -- $time - Время при отправке +- $sender_nickname - Sender's nickname +- $recipient_nickname - The recipient's nickname +- $message - Message content +- $time - Time when sending **commandUsing**: -- $command - Используемая команда. Если /tell <...> то tell; Если /msg <...> то msg \ No newline at end of file +- $command - The command to use. If /tell <...> then tell; If /msg <...> then msg + +(Translated from `Google Translate`) \ No newline at end of file diff --git a/README_RU.md b/README_RU.md new file mode 100644 index 0000000..d29e400 --- /dev/null +++ b/README_RU.md @@ -0,0 +1,58 @@ +# OpenPrivateMessages +## Minecraft bukkit plugin. + +### config.yml +```yaml +commandUsing: "Use /$command " +# Когда команда выполняется без аргумента игрока или сообщения + +playerNotFound: "Player not found" +# Когда получатель сообщения не онлайн. + +timeFormat: "dd.MM.yyyy HH:mm:ss" +# Формат времени. Нужно для переменной $time + +recipientMessage: # Сообщение со стороны получателя + Pattern: "$sender_nickname -> $recipient_nickname: $message" + Hover: + Enable: true + Text: "&9~~~~ PrivateMessage ~~~~\n&a$sender_nickname &7-> &a$recipient_nickname\n&d(Click to reply)\n\n&f$message" + Click: + Enable: true + Text: "/$command $sender_nickname " + +senderMessage: # Сообщение со стороны отправителя + Pattern: "&2Message sent!" + Hover: + Enable: true + Text: "&9~~~~ PrivateMessage ~~~~\n&a$sender_nickname &7-> &a$recipient_nickname\n&d(Click to send $recipient_nickname)\n\n&f$message" + Click: + Enable: true + Text: "/$command $sender_nickname " +``` + +### Доступные переменне в конфиге +**recipientMessagePattern** & **senderMessagePattern**: +- $recipient_nickname - Ник получателя +- $sender_nickname - Ник отправителя +- $message - Контент сообщения +- $time - Время при отправке + +**recipientMessageClickText**: +- $command - Используемая команда +- $sender_nickname - Ник отправителя +- $time - Время при отправке + +**senderMessageClickText** +- $command - Используемая команда +- $recipient_nickname - Ник получателя +- $time - Время при отправке + +**recipientMessageHoverText** & **senderMessageHoverText**: +- $sender_nickname - Ник отправителя +- $recipient_nickname - Ник получателя +- $message - Контент сообщения +- $time - Время при отправке + +**commandUsing**: +- $command - Используемая команда. Если /tell <...> то tell; Если /msg <...> то msg \ No newline at end of file diff --git a/resources/config.yml b/resources/config.yml index cfae2fe..7a4a810 100644 --- a/resources/config.yml +++ b/resources/config.yml @@ -1,8 +1,13 @@ -commandUsing: "Используйте /$command " -playerNotFound: "Игрок не найден." +commandUsing: "Use /$command " +# When a command is executed without a player argument or message + +playerNotFound: "Player not found" +# When the recipient of the message is offline. + timeFormat: "dd.MM.yyyy HH:mm:ss" +# Time format. Required for the $time variable -recipientMessage: +recipientMessage: # Message from the recipient's side Pattern: "$sender_nickname -> $recipient_nickname: $message" Hover: Enable: true @@ -11,11 +16,11 @@ recipientMessage: Enable: true Text: "/$command $sender_nickname " -senderMessage: - Pattern: "&2Сообщение отправлено!" +senderMessage: # Message from the sender's side + Pattern: "&2Message sent!" Hover: Enable: true Text: "&9~~~~ PrivateMessage ~~~~\n&a$sender_nickname &7-> &a$recipient_nickname\n&d(Click to send $recipient_nickname)\n\n&f$message" Click: Enable: true - Text: "/$command $sender_nickname " + Text: "/$command $sender_nickname " \ No newline at end of file