Skip to content

Commit

Permalink
Improve many readme Readme sections
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippvK authored Apr 23, 2020
1 parent 6c2eed3 commit 07a3290
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,32 @@ The Java Applet-based Minigolf Client was one of the most popular multiplayer ga
- Use local Map store instead of database
- Added ability to pass IP of server to client
- Ability to play on on a single computer and hosting a game for up to 4 players in your home network
- Removed bad words and custom tracks
- Added ability to choose a nickname freely

## Usage

### Prerequisites
- Clone this repo: `git clone [email protected]:PhilippvK/playforia-minigolf.git`
- Install Java Development Kit 8 (https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
- OpenJDK1.8 should work as well!
- Install Apache `ant` for building: https://ant.apache.org/manual/install.html
- *Optional:* Install IntelliJ IDEA Java IDE (https://www.jetbrains.com/idea/download/) and import this reposiory as project

### 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
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 if had to run `JAVA_HOME=/Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home ant compile`)

### 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.
Assuming that all 3 tools have compiled sucessfully, you have 3 possible ways for running the server binary:
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!
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:
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
3. Use the exported JAR file: `java -jar server.jar`
Expand All @@ -56,13 +62,14 @@ java -jar client.jar 192.168.1.7 # Replace IP with the one of your server (which

After the Login screen, which can be skipped with an empty form, you should see your familiar Playforia Minigolf Menu!

**NEW:** You can now choose your nickname freely. However the input to the password field will still be ignored and there is no check for errors and so on...

Running the Editor is quite straightforward as it can be started like
Running the Editor is quite straightforward as it can be started like expected: `java -jar editor.jar`

## Compability

Tested:
- MacOS 10.14.5 Mojave with Java Version `1.8.0_152-ea` with JDK
- 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
- Windows (7/8/10)

Expand All @@ -78,9 +85,9 @@ Untested: (Will likely be compatible, too!)

## Notices

1. The code is neither written by me nor my property (Original Source: )
1. The code is neither written by me nor my property. I do NOT represent the same values as people who have worked on this code before. (Original Source: https://github.com/WorldStarHipHopX/playforia)
2. I am not responsible for any bug, problems, security flaws,...
3. Also, I do not intent to extend the current codebase very much
3. Also, I do not intent to extend the current codebase very much.
4. The Java code you will find in the repository is pretty bad. Some parts even look like they where generated, for example by an converter tool
5. There is actually an aimbot implemented in the client code. Look for `allowCheating` in `GameCanvas.java` for trying it out. Use it wisely.

Expand Down

0 comments on commit 07a3290

Please sign in to comment.