andrew
/
ace-of-shades-2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved readme.

This commit is contained in:
Andrew Lalis 2022-07-26 17:32:21 +02:00
parent 9b7908fd60
commit 8e2537a532
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -7,3 +7,20 @@ Both the client and server use a similar style of YAML-based configuration, wher
java -jar server.jar /path/to/my/custom/config.yaml
```
If no configuration file is found, and none is explicitly provided, then a set of default configuration options is loaded.
## Running the Game
Ace of Shades 2 uses Java 17. You'll need to install that first (or any later version), if you don't have it already.
To run the client, go to the [releases](https://github.com/andrewlalis/ace-of-shades-2/releases) page and download the `aos2-client` file that corresponds to your system. You'll need to make a configuration file in the same directory as the JAR file, something like this:
```yaml
serverHost: localhost
serverPort: 25565
username: myUsername
input:
mouseSensitivity: 0.005
display:
fullscreen: true
captureCursor: true
fov: 80
```
To connect to a particular server, you'll need to update this config file and then you can start the game with `java -jar <jarfile>` or by double-clicking on it.