Skip to content

Commit f4ecc3f

Browse files
committed
Updated readme
1 parent 7f7545d commit f4ecc3f

File tree

1 file changed

+44
-7
lines changed

1 file changed

+44
-7
lines changed

README.MD

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,47 @@
11
# ViaProxyMultiLaunch
2-
Launch another jar file in combination with ViaProxy.
2+
Launch another jar file in combination with ViaProxy.\
3+
This helps if your server host only allows you to run a single jar file.\
4+
A spare port to bind ViaProxy/the server to is needed.
35

46
## Usage
5-
The server <b>has</b> to be in a separate folder because of file conflicts with ViaProxy.\
6-
To use this plugin you have to launch ViaProxy instead of the normal server jar file.\
7-
The server jar has to be added to the launch arguments of ViaProxy:
8-
`````shell
9-
[ViaProxy launch] --serverjar server.jar
10-
`````
7+
### Installation
8+
Download the latest release from the [releases page](https://github.com/ViaVersionAddons/ViaProxyMultiLaunch/releases) and place it in the `plugins` folder of the ViaProxy server.
9+
10+
### Configuration
11+
When starting ViaProxy with the plugin installed for the first time, the config file (`multilaunch.yml`) will be generated in the server folder.\
12+
It contains all the necessary settings to configure the plugin.
13+
14+
<details>
15+
16+
<summary>Default configuration:</summary>
17+
18+
```yaml
19+
#The path to the server jar to launch
20+
#Make sure the server is in another folder than ViaProxy itself to avoid file conflicts!
21+
ServerJar: other/server.jar
22+
23+
#The JVM arguments to use when launching the server
24+
JvmArguments:
25+
- -DIReallyKnowWhatIAmDoingISwear
26+
27+
#The arguments to use when launching the server
28+
ServerArguments:
29+
- nogui
30+
31+
#If the console input should be forwarded to the server
32+
#This also means that ViaProxy is not able to read the console input!
33+
#If the server process is not running, the input will be handled by ViaProxy
34+
ForwardConsole: true
35+
36+
#The time in seconds to wait for the server to shutdown before forcing it
37+
#A force shutdown may cause data loss!
38+
ShutdownTimeout: 60
39+
40+
#The command to send to the server when stopping it
41+
StopCommand: stop
42+
43+
#If ViaProxy should be stopped when the server stops
44+
StopViaProxyOnServerStop: true
45+
```
46+
47+
</details>

0 commit comments

Comments
 (0)