Skip to content

Commit

Permalink
edit README.md and added README_RU.md. added comments to config.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
FazziCLAY committed Apr 3, 2021
1 parent 509c9f8 commit 0f77b5c
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 30 deletions.
55 changes: 31 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# OpenPrivateMessages
## Minecraft bukkit plugin.

---
RUSSIAN README - [README_RU.md](./README_RU.md)

---

### config.yml
```yaml
commandUsing: "Используйте /$command <player> <message>"
# Когда команда исполняется без аргумента игрока или сообщения
commandUsing: "Use /$command <player> <message>"
# 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
Expand All @@ -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"
Expand All @@ -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
- $command - The command to use. If /tell <...> then tell; If /msg <...> then msg
(Translated from `Google Translate`)
58 changes: 58 additions & 0 deletions README_RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# OpenPrivateMessages
## Minecraft bukkit plugin.

### config.yml
```yaml
commandUsing: "Use /$command <player> <message>"
# Когда команда выполняется без аргумента игрока или сообщения

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
17 changes: 11 additions & 6 deletions resources/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
commandUsing: "Используйте /$command <player> <message>"
playerNotFound: "Игрок не найден."
commandUsing: "Use /$command <player> <message>"
# 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
Expand All @@ -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 "

0 comments on commit 0f77b5c

Please sign in to comment.