Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Fix few typos
- Replace Ant sections with Maven
- Add myself as a contributor
  • Loading branch information
pehala committed Aug 29, 2020
1 parent 015fab1 commit 09cbad5
Showing 1 changed file with 10 additions and 15 deletions.
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,18 @@ The Java Applet-based Minigolf Client was one of the most popular multiplayer ga

### Building

There are 3 directories of interest: `client`, `server` and `editor`, which should compile quite easily.
Choose your prefered toolchain:
1. **IntelliJ IDEA**: Import Project from git and compile - Due to updates to the IDE, I unfortunately can not help you with this at the moment, as I have to figure it out, too.
2. **Ant Build**: Run `ant compile` in the repective directory

**Warning:** If you have multiple versions of the JDK installed, you have to make sure, that the environment variable `JAVA_HOME` points to the actual directory where version 1.8 is located. (For MacOS I had to run `JAVA_HOME=/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home ant compile`)
Run `mvn install` in the root directory. This builds `client`, `server` and `editor` submodules and all their respectable executables

### Running

First, the server application has to be started as it provides ressources like sounds, maps and textures which are required for "offline" modes, too.
As I cound not manage to include the tracks inside the compiled JAR archive, the `tracks` directory has to be located at the same folder where the `server.jar` is located! There is a symbolic link in the `server/` directory which will likely not work on Windows systems. Please remove it and copy the directory instead!
Assuming that all 3 tools have compiled sucessfully (or downloaded them them from the [Releases Page](https://github.com/PhilippvK/playforia-minigolf/releases)), you have 3 possible ways for running the server binary:
First, the server application has to be started as it provides resources like sounds, maps and textures which are required for "offline" modes, too.
As I could not manage to include the tracks inside the compiled JAR archive, the `tracks` directory has to be located at the same folder where the `server.jar` is located! There is a symbolic link in the `server/` directory which will likely not work on Windows systems. Please remove it and copy the directory instead!
Assuming that all 3 tools have compiled successfully (or downloaded them from the [Releases Page](https://github.com/PhilippvK/playforia-minigolf/releases)), you have 3 possible ways for running the server binary:
1. Using the IntelliJ IDE: Use the provides build artifacts or run the server by pressing the play button after compiling
2. Using the Ant tool: Run `ant run` in the `./server` directory
2. Using the Maven tool:
* Client: Run `mvn compile exec:exec` in the `./client` directory
* Server: Run `mvn compile exec:java` in the `./server` directory
* Editor: Run `mvn compile exec:java` in the `./editor` directory
3. Use the exported JAR file: `java -jar server.jar`

The client can be started the same way (AFTER THE SERVER WAS STARTED) but you can also give launch options for server ip and game language in the following format
Expand All @@ -84,12 +82,9 @@ Running the Editor is quite straightforward as it can be started like expected:

Tested:
- MacOS 10.14.5 Mojave with Java Version `1.8.0_152-ea` with (Open)JDK
- Raspbian Strech (9) with Java version 1.8.0\_65
- Ubuntu 19.04 with Java version `1.8.0_265`
- Windows (7/8/10)

Untested: (Will likely be compatible, too!)
- Ubuntu
- ...

## Problems
- Passwords and logins are ignored
Expand All @@ -108,7 +103,7 @@ Untested: (Will likely be compatible, too!)
- [@PhilippvK](https://github.com/PhilippvK) (BuyMeACoffe: https://www.buymeacoff.ee/PhilippvK)
- [@maitovelkkis](https://github.com/maitovelkkis)
- [@eYeWoRRy](https://github.com/eYeWoRRy)

- [@pehala](https://github.com/pehala)
---

## Final Words
Expand Down

0 comments on commit 09cbad5

Please sign in to comment.