Skip to content

Commit efbbe7f

Browse files
authored
Improve readme formatting
1 parent bba9227 commit efbbe7f

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#Tongues - Translation plugin for Bukkit/Spigot MC server
1+
# Tongues - Translation plugin for Bukkit/Spigot MC server
22

33
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.
44

55
This is quite a stable version, any issues or feature requests are welcome!
66

7-
##Main features
7+
## Main features
88
- Translates on the fly chat messages
99
- Provides a translated "WhisperWithinRadius" command
1010
- 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!
1717
- Logs chat messages to files and/or [LogEntries](logentries.com)
1818
- Configuration store files use the player UUID since version 1.3
1919

20-
##Installation
20+
## Installation
2121
- Drop the JAR in the plugins folder
2222
- Reload plugins or start the server
2323
- Edit the plygin.yml created in the plugin's data folder to set the Bing translation API ClientID and SecretKey
2424
- Possibly create languages and groups configuration files
2525
- Reload again
2626
- Give permissions
2727

28-
##Commands
29-
###tongues.setlang###
28+
## Commands
29+
### tongues.setlang ###
3030
/setlang [language] - Will change the current language of the issuing player.
3131

3232
permissions: Requires permission **tongues.setlang**
@@ -41,14 +41,14 @@ When [language] is **?** the command would query and display the current languag
4141

4242
aliases: setlang, lang
4343

44-
###tongues.whisper###
44+
### tongues.whisper ###
4545
/whisper [message] - Whisper a message to every player in radius
4646

4747
permissions: Requires permission **tongues.whisper**
4848

4949
aliases: whisper
5050

51-
###tongues.talk###
51+
### tongues.talk ###
5252
/talk [message] - Will whisper the message to any players around you
5353

5454
permissions: Requires permission **tongues.talk** and **tongues.whisper**
@@ -64,7 +64,7 @@ permissions: Requires permission **tongues.talk.all**
6464

6565
aliases: talk, t
6666

67-
###tongues.listen###
67+
### tongues.listen ###
6868
/tl [on/off] - Enables or disables the global chat listening.
6969

7070
permissions: Requires permission **tongues.listen**
@@ -73,7 +73,7 @@ permissions: Requires permission **tongues.listen**
7373
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:
7474
* *whisper.radius* (int) - Sets the whispering radius - default is 10
7575

76-
##Translation Logic
76+
## Translation Logic
7777
When a message is sent, the language of the player receiving the message is used to translate the message.
7878

7979
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
8383

8484
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.
8585

86-
##Language Configuration
86+
## Language Configuration
8787
Language settings per player are stored in the file **langStore.json** in the plugin's data folder.
8888
This file contains a single JSON object. The keys of this object are the player UUID and the values are the language.
8989
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:
9999
}
100100
```
101101

102-
##Groups Configuration
102+
## Groups Configuration
103103
A Player can belong to zero or more groups.
104104
To define the groups create a file called **groupsStore.json** in the plugin's data folder.
105105
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`
131131

132132
Currently - Saving the changes to the JSON file or reloading from it is not supported.
133133

134-
##Chat Logging
134+
## Chat Logging
135135
The plugin logs chat messages, their sender, receiver, and the message that was sent as it was formatted.
136136
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.
137137
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:
156156

157157
**Note:** The logger will not log whisper commands which arrived at no one.
158158

159-
##Latest Changes
159+
## Latest Changes
160160

161161
Since 1.5:
162162
- 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

Comments
 (0)