You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
#Tongues - Translation plugin for Bukkit/Spigot MC server
1
+
#Tongues - Translation plugin for Bukkit/Spigot MC server
2
2
3
3
Tongues implements real time translation support for messages between players and extends the basic chat services to include other useful features. Currently uses the Azure cognitive services text translation API.
4
4
5
5
This is quite a stable version, any issues or feature requests are welcome!
6
6
7
-
##Main features
7
+
##Main features
8
8
- Translates on the fly chat messages
9
9
- Provides a translated "WhisperWithinRadius" command
10
10
- Uses the Bing Translation service (Requires an active account)
@@ -17,16 +17,16 @@ This is quite a stable version, any issues or feature requests are welcome!
17
17
- Logs chat messages to files and/or [LogEntries](logentries.com)
18
18
- Configuration store files use the player UUID since version 1.3
19
19
20
-
##Installation
20
+
##Installation
21
21
- Drop the JAR in the plugins folder
22
22
- Reload plugins or start the server
23
23
- Edit the plygin.yml created in the plugin's data folder to set the Bing translation API ClientID and SecretKey
24
24
- Possibly create languages and groups configuration files
25
25
- Reload again
26
26
- Give permissions
27
27
28
-
##Commands
29
-
###tongues.setlang###
28
+
##Commands
29
+
###tongues.setlang###
30
30
/setlang [language] - Will change the current language of the issuing player.
The plugin allows configuration of the radius to consider for whispering to players (same in all directions x/y/z) with the config.yml key:
74
74
**whisper.radius* (int) - Sets the whispering radius - default is 10
75
75
76
-
##Translation Logic
76
+
##Translation Logic
77
77
When a message is sent, the language of the player receiving the message is used to translate the message.
78
78
79
79
If no language is setup for this player, no translation is attempted or sent.
@@ -83,7 +83,7 @@ Currently, regardless of the sending player's configured language, an auto-detec
83
83
84
84
So for example, a "French" configured player might still send some "English" text and expect it to be translated correctly to a "Russian" configured player.
85
85
86
-
##Language Configuration
86
+
##Language Configuration
87
87
Language settings per player are stored in the file **langStore.json** in the plugin's data folder.
88
88
This file contains a single JSON object. The keys of this object are the player UUID and the values are the language.
89
89
Configuration of the language is stored in the file when the plugin is disabled and read when the plugin is enabled.
@@ -99,7 +99,7 @@ Example of a valid language configuration JSON object:
99
99
}
100
100
```
101
101
102
-
##Groups Configuration
102
+
##Groups Configuration
103
103
A Player can belong to zero or more groups.
104
104
To define the groups create a file called **groupsStore.json** in the plugin's data folder.
105
105
The file contains a single JSON object. The keys of this object are the group name and the values are the group member players' UUID's.
@@ -131,7 +131,7 @@ During server run time, the groups can be modified using the `add` and `remove`
131
131
132
132
Currently - Saving the changes to the JSON file or reloading from it is not supported.
133
133
134
-
##Chat Logging
134
+
##Chat Logging
135
135
The plugin logs chat messages, their sender, receiver, and the message that was sent as it was formatted.
136
136
When a message is sent to multiple receivers (such as a public message, or a whisper with more than one player around) it will log one row for each delivered message.
137
137
When logging to files, chat logs are appended to a log file per server startup, organized in a month/day folder structure.
@@ -156,7 +156,7 @@ The config.yml file can configure the following for chat logging:
156
156
157
157
**Note:** The logger will not log whisper commands which arrived at no one.
158
158
159
-
##Latest Changes
159
+
##Latest Changes
160
160
161
161
Since 1.5:
162
162
- Migrated translation services to the new Azure cognitive text translation API. This is a beaking change and the comfiguration must change to include a valid subscription key for the new translation services.
0 commit comments