diff options
| author | Matthew <pugmatt@gmail.com> | 2022-01-27 02:55:09 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-27 02:55:09 -0500 |
| commit | 84071623d591d37bef06f275c2491e55d8d0a53f (patch) | |
| tree | 7e8d9f2180761e5a2d968ee4d6ad047905a9cced | |
| parent | eff282b2e2e7d87a91c7fc89ea1dc5d50731ea87 (diff) | |
| download | BedrockConnect-84071623d591d37bef06f275c2491e55d8d0a53f.tar.gz BedrockConnect-84071623d591d37bef06f275c2491e55d8d0a53f.tar.bz2 BedrockConnect-84071623d591d37bef06f275c2491e55d8d0a53f.zip | |
Include instructions of modifying wording/language1.14
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
@@ -30,6 +30,7 @@ Table of contents * [Publicly available BedrockConnect instances](#publicly-available-bedrockconnect-instances) * [Hosting your own serverlist server](#hosting-your-own-serverlist-server) * [Defining your own custom servers](#defining-your-own-custom-servers) + * [Change wording of serverlist](#change-wording-of-serverlist) * [Using your own DNS server](#using-your-own-dns-server) * [Libraries used](#libraries-used) * [Donations](#donations) @@ -100,6 +101,7 @@ The following arguments can be placed in the startup command to ajust settings: | featured_servers | If true, the featured servers will be displayed in the serverlist. If false, the servers are hidden. | true | | whitelist | Specify file containing list of whitelisted players. (Should be a text file with the player names specified on seperate lines) | | | fetch_featured_ips | If true, dynamically grab the featured server IPs from the domain names. If false, a file ```featured_server_ips.json``` will be generated, containing the hard-coded featured server IPs, and to allow changing them if needed. | true | +| language | Specify a file containing language customizations. See [guide for changing wording](#change-wording-of-serverlist) | | MySQL example: ``` @@ -130,6 +132,27 @@ Then, add this argument to your startup script: `custom_servers=[path to json fi The icon URL is not required, if omitted it will show the default icon. +# Change wording of serverlist + +For cases where you want to change the wording/language of your BedrockConnect server, you can do this by creating a JSON file in the same directory as the BedrockConnect JAR. The contents of this file should contain the parts of the wording you want to overwrite. + +You can find all the options that be overwritten here: https://github.com/Pugmatt/BedrockConnect/blob/master/serverlist-server/src/main/resources/language.json + +Example custom language file: +```json +{ + "main": { + "heading": "My Cool ServerList", + "connectBtn" : "Hop in a server!" + }, + "disconnect": { + "exit": "Goodbye!" + } +} +``` + +Once finished, you include it in your server by adding the following arguement to your startup command: ```language=my_lang.json``` (Replace "my_lang" with the name of your file") + # Using your own DNS server In the case where you want to use your own DNS server instead of the one I supplied, this is what zones you'll need to set your DNS to in order for BedrockConnect to work: |
