Skip to content

Commit fbc7096

Browse files
committed
Update README with JAR distribution instructions
1 parent 14e4b51 commit fbc7096

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,30 @@ Or with PowerShell:
1616

1717
Requires JDK 17+.
1818

19+
The built JAR is written to:
20+
21+
```text
22+
target/java-254-client.jar
23+
```
24+
25+
The build adds the JARs from `lib/` to the application manifest, allowing
26+
`target/java-254-client.jar` to be launched directly.
27+
1928
## Run
2029

2130
```bat
2231
run.bat
2332
```
2433

34+
Using `run.bat` is recommended because it supplies the Java options used by
35+
LWJGL and starts the client with the default server settings.
36+
37+
You can also launch the packaged JAR directly:
38+
39+
```powershell
40+
java -jar target/java-254-client.jar
41+
```
42+
2543
Args: `nodeId portOffset [lowmem|highmem] [free|members] storeid`
2644

2745
The port-offset controls both HTTP and game ports:
@@ -35,3 +53,20 @@ The port-offset controls both HTTP and game ports:
3553
| `run-8888.bat` | 8888 | 52402 | 8808 |
3654

3755
If your server uses a non-standard split (e.g. HTTP 8080 but game 43594), edit `getCodeBase()` in `src/main/java/jagex2/client/Client.java`.
56+
57+
## Distribution
58+
59+
The JAR contains the compiled client classes, so the `target/classes/` folder
60+
is not needed. The dependency JARs are separate and must be distributed with
61+
the client:
62+
63+
```text
64+
Java-254-Client/
65+
|-- lib/
66+
| `-- *.jar
67+
`-- target/
68+
`-- java-254-client.jar
69+
```
70+
71+
Keep the `lib/` and `target/` folders in these relative locations. Moving the
72+
JAR out of `target/` will prevent it from finding the libraries in `lib/`.

0 commit comments

Comments
 (0)