Skip to content

Commit eff57ac

Browse files
committed
Update README to include notes on online mode and wildcard domain support
1 parent 52ee868 commit eff57ac

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.MD

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ It removes the need for multiple servers and automatically sets everything up fo
1414
Since ViaProxy is now responsible for the connection handling and version translation, this plugin is much easier to maintain and should theoretically never break (unless ViaProxy changes something).
1515

1616
## Installation
17-
Download the latest release from the [releases page](https://github.com/ViaVersionAddons/MiniConnect/releases) and put it into the `plugins` folder of your ViaProxy server.\
18-
<b>After installing the plugin, ViaProxy will no longer function as a normal proxy server! The plugin will also change some config options of ViaProxy to make it work properly.</b>\
19-
This can always be reverted by removing the plugin from the `plugins` folder and changing the config options back to their original values.\
17+
Download the latest release from the [releases page](https://github.com/ViaVersionAddons/MiniConnect/releases) and put it into the `plugins` folder of your ViaProxy server.
18+
> [!NOTE]
19+
> After installing the plugin, ViaProxy will no longer function as a normal proxy server! The plugin will also change some config options of ViaProxy to make it work properly.\
20+
> This can always be reverted by removing the plugin from the `plugins` folder and changing the config options back to their original values.\
21+
2022
The plugin itself does not have any configuration options.
2123

2224
## Usage
@@ -28,12 +30,26 @@ After joining the server, a GUI with settings will open:\
2830
4. **Proxy online mode**: Enable online mode for your account. This extra verification will be used to save settings between sessions.\
2931
After clicking the button, you have 60s to reconnect to the MiniConnect server with a valid Minecraft account.\
3032
You can disable this option at any time by clicking the button again.
33+
> [!WARNING]
34+
> This also saves your logged in Minecraft account information.\
35+
> Your data will be encrypted, but make sure you trust the MiniConnect server you are enabling this option on.\
36+
> Malicious servers can circumvent this encryption and access your data.
3137
5. **Connect to server**: Connect to the server after setting all options.
3238
6. **How to use**: A small usage guide.
3339
7. **Disconnect**: Disconnect from the lobby (same as closing the GUI).
3440

3541
After setting all required option (server address and protocol version), click on the `Connect to server` button to connect to the server.\
36-
If you disconnect from the server, all settings will be reset and you will have to set them again.
42+
Unless online mode is enabled, all settings will be lost on disconnect and you will have to set them again.
3743

3844
When connected to a server, you can return to the lobby by typing the `/disconnect` command in the chat.
3945
This will retain all settings and you can immediately connect to another server.
46+
47+
### Wildcard Domain Support
48+
If the MiniConnect server supports wildcard domains, you can use the ViaProxy wildcard syntax to pre-fill the server address and version.\
49+
Examples:\
50+
- Format 1:\
51+
`address_port_version.viaproxy.hostname` e.g. `server.example.com_25565_1.8.viaproxy.example.com`\
52+
- Format 2:\
53+
`address.<address>.port.<port>.version.<version>.f2.viaproxy.hostname` e.g. `address.server.example.com.port.25565.version.1.8.f2.viaproxy.example.com`
54+
55+
Both fill `server.example.com:25565` as the server address and `1.8` as the protocol version.

0 commit comments

Comments
 (0)