Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bundle maps into build artifacts #104

Merged
merged 3 commits into from
Nov 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 0 additions & 10 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,6 @@ jobs:
${{ steps.changelog.outputs.changelog }}
draft: true
prerelease: false
- name: Upload Tracks
id: upload-tracks
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: shared/target/tracks.zip
asset_name: tracks.zip
asset_content_type: application/zip
- name: Upload Server Jar
id: upload-server-jar
uses: actions/upload-release-asset@v1
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Run `mvn install` in the root directory. This builds `client`, `server` and `edi
### Running

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!
By default, the server uses tracks from the project's bundled resources, however if you want to run with a custom set of tracks, launch the server using the `--tracks-dir` option!
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 Maven tool: Run `mvn compile exec:java` in the `./server`, `./client` or `./editor` directory
Expand All @@ -65,12 +65,15 @@ java -jar client.jar -server 192.168.1.7 -lang en_US # Replace IP with the one o
We provide an experimental Dockerfile for easy hosting of the server application. You can either build the image by yourself or download the pre-build images from [quay.io](https://quay.io/repository/philippvk/minigolf) via `docker pull quay.io/philippvk/minigolf:latest`.

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

### CLI options
Both client and server include CLI options for hostname (`-ip`), port (`-p`) settings. To learn about all the available setting you can include help with `-h` parameter.

To use custom tracks instead of the default set of bundled tracks, use the `--tracks-dir` option when starting the server and point it to where your tracks are located.

If you want to enable debugging messages, add `--verbose` to the list of arguments.

## Compability
## Compatibility

Tested:
- Ubuntu 22.04 with Java version `17.0.6`
Expand All @@ -86,7 +89,7 @@ Tested:
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.
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
4. The Java code you will find in the repository is pretty bad. Some parts even look like they were 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.

## Contribution
Expand Down
Binary file removed assets/res/AGolf/picture/balls.gif
Binary file not shown.
Binary file removed assets/res/AGolf/picture/bg-lobby-dual.gif
Binary file not shown.
Binary file removed assets/res/AGolf/picture/bg-lobby-multi-fade.jpg
Binary file not shown.
Binary file removed assets/res/AGolf/picture/bg-lobby-multi.gif
Binary file not shown.
Binary file removed assets/res/AGolf/picture/bg-lobby-password.gif
Binary file not shown.
Binary file removed assets/res/AGolf/picture/bg-lobby-single-fade.jpg
Binary file not shown.
Binary file removed assets/res/AGolf/picture/bg-lobby-single.gif
Binary file not shown.
Binary file removed assets/res/AGolf/picture/bg-lobbyselect.gif
Binary file not shown.
Binary file removed assets/res/AGolf/picture/elements.gif
Binary file not shown.
Binary file removed assets/res/AGolf/picture/shapes.gif
Binary file not shown.
Binary file removed assets/res/AGolf/picture/special.gif
Binary file not shown.
Binary file removed assets/res/Editor/fill_icon&16.png
Binary file not shown.
Binary file removed assets/res/Editor/pencil_icon&16.png
Binary file not shown.
Binary file removed assets/res/Editor/playback_rec_icon&16.png
Binary file not shown.
Binary file removed assets/res/Editor/playback_stop_icon&16.png
Binary file not shown.
Binary file removed assets/res/Shared/picture/bigtext.gif
Binary file not shown.
Binary file removed assets/res/Shared/picture/credit-background.jpg
Binary file not shown.
Binary file removed assets/res/Shared/picture/icon.png
Binary file not shown.
Binary file removed assets/res/Shared/picture/language-flags.png
Binary file not shown.
Binary file removed assets/res/Shared/picture/ranking-icons.gif
Binary file not shown.
Binary file removed assets/res/Shared/picture/tf-background.gif
Binary file not shown.
Binary file removed assets/res/Shared/sound/challenge.au
Binary file not shown.
Binary file removed assets/res/Shared/sound/game-draw.au
Binary file not shown.
Binary file removed assets/res/Shared/sound/game-loser.au
Binary file not shown.
Binary file removed assets/res/Shared/sound/game-winner.au
Binary file not shown.
Binary file removed assets/res/Shared/sound/gamemove.au
Binary file not shown.
Binary file removed assets/res/Shared/sound/illegal.au
Binary file not shown.
Binary file removed assets/res/Shared/sound/notify.au
Binary file not shown.
Binary file removed assets/res/Shared/sound/timelow.au
Binary file not shown.
Binary file removed assets/res/appletloader_playforia.gif
Binary file not shown.
Loading
Loading