Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wpernath/quarkus-grumpycat

A simple fat-cat / packman like multi player game, with a logic server written in Java with Quarkus and a Engine written in JavaScript with the MelonJS game framework.
https://github.com/wpernath/quarkus-grumpycat

argocd game game-development gitops html5-canvas java javascript kubernetes melonjs openshift quarkusio tekton-pipelines

Last synced: about 1 month ago
JSON representation

A simple fat-cat / packman like multi player game, with a logic server written in Java with Quarkus and a Engine written in JavaScript with the MelonJS game framework.

Awesome Lists containing this project

README 

        
# Quarkus GrumpyCat

![Quarkus GrumpyCat](./melonjs-client/src/main/client/data/img/GrumpyCat-Title.png)



This Game uses Quarkus, the Supersonic Subatomic Java Framework and HTML 5 / JavaScript and MelonJS.



If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .



All client game logic is currently coded with JavaScript and [MelonJS](https://github.com/melonjs/melonjs).



There is a demo of this game running [here](http://cat-client-grumpycat.apps.kelly.rhepds.com/generated/index). 



## Technical Blog entries

I am currently blogging about the creation of this game as it's still meant to be educational.



Here are the current articles:



- [How to setup, prepare and demo GrumpyCat as a GitOps example](https://www.opensourcerers.org/2023/05/08/how-to-set-up-and-demonstrate-quarkus-grumpycat-gitops-demo/)

- [Chapter #1 - Initial Setup](https://www.opensourcerers.org/2022/10/24/using-quarkus-to-develop-a-multiplayer-game-chapter-1-initial-setup/)

- [Chapter #2 - The server feeds the client](https://www.opensourcerers.org/2022/12/19/using-quarkus-to-develop-a-multiplayer-game-chapter-2-the-server-feeds-the-client/)



## The Game



This game was inspired by the old Fat-Cat game and by PacMan. You're controlling a dog in a maze which needs to eat all food without being caught by a grumpy cat or other enemies. 



It also supports multi player gaming. A host can invite up to 3 other players who can join a multi player session. The winner of such a session is "last dog standing" or the player who has collected most points.



### How to play (single player)

Right now you can control the dog with arrow keys UP, DOWN, LEFT & RIGHT and with W, A, S, D. More keys are:



- *P* PAUSE

- *SPACE* place bomb

- *Shift* + UP/DOWN/LEFT/RIGHT: place barrier in the direction

- *ALT | option* + UP/DOWN/LEFT/RIGHT: throw a magic bolt into the direction, killing spiders or stunning other enemies (cats, golems).

- *Q* start a magic firespin around your player. Any other player / enemy coming too close to you will be stunned / killed (depending on the enemy). Spell is up for 15sec

- *E* start a magic protection circle around your player. No other players / enemies could harm you for 15sec.

- *R* place a magic nebula at the place you are right now. Path finding enemies (cats, spiders) will walk to this place and get damaged / stunned. Spell is up for 15sec.



If the cat gets into an exploding bomb, it stops for 3sec. A bomb can destroy barriers. The level ends if you got all food or if you don't have any energy left.



In order to use those weapons, you have to collect them in form of a magic potion or in form of a bomb first. 

  

### How to play (multi player)

You can start the game in multi player modus. Up to 4 players are able to play against each other. 

You can place bombs, throw magic bolts and cast the magic firespin to harm other players. If you're hurting others, you also get points.



In multi player mode a level ends if either all bonus is collected or if you are the last player standing. The winner is that player with the highest score. 



### Bonus tiles

There are different bonus tiles to be collected. 

- Pill (looks like a cactus): 10 Pts

- Bomb: 50 Pts, add 5 bombs to your inventory

- Meat: 25 Pts, add 25 points more energy

- Cheese: 15 Pts, add 20 points more energy

- Chest: 250 Pts, add a random weapon to your inventory (does NOT count for level end!)

- Potion: 50 Pts

  - Small red: maxEnergy + 25

  - Big red: maxEnergy + 50

  - Blue: +3 magic bolts 

  - brown: +3 magic firespins

  - green: +3 magic protection circles

  - violet: +3 magic nebula



![Bonus Tiles](./docs/37E7903F-54F1-40A4-8E73-9DB6198D4BD2.jpeg)



### Life demo

There is a demo of this game running [here](http://cat-client-grumpycat.apps.ruby.rhepds.com). 

Please note, that I am using this server also for workshops etc. So the system might not be as stable as expected. But you can give it a try.



If you have any suggestestions or want to contribute, please open an [issue here](https://github.com/wpernath/quarkus-grumpycat/issues). Thank you!



### Game Graphics



![the game](docs/game-title.png)

![cats](docs/the-game1.png)

![spiders](docs/the-game2.png)

![game over](docs/game-over.png)



## What's NEW?

Starting with v0.6.0, there is a multi player mode where up to 4 players can play against each other via network on specialized multi player maps (right now just 2 of them). 



The game is over if:

- All bonus items have been collected

- All other players left the game (intentionally or unintentionally)



The winner of the match is the player who has a higher score than all others or who has survived all others. 



- Players can drop bombs to other players to hit them (-50 Energy, plus 100 score). 

- Players can lock other players by throwing a barrier into the way (those can be destroyed with a bomb)



And do not forget: There are still other enemies who can hit you!



## Running the applications in dev mode

Please have a look at the [contributors guide](./CONTRIBUTING.md).



## Running on Docker / Podman

There are container images ready to be used on [Quay.io](https://quay.io/wpernath/quarkus-grumpycat). Use this command to pull the images to your local repository:



```shell

docker pull quay.io/wpernath/quarkus-grumpycat

docker pull quay.io/wpernath/grumpycat-melonjs

```



To run the server, the required database and the client, you need to have Docker / Podman configured and running. You can use the `docker-compose.yaml` to start the latest version of the game:



```shell

docker-compose [--detach|-d] up

```



The app is then available under `http://localhost:8085` in your browser.



## Running on Kubernetes / OpenShift



### OpenShift / Kubernetes image deployment in a GitOps way

Please have a look [here](./kubernetes-config/README.md)



### Using full featured GitOps

To make use of all GitOps features, have a look at the documentation inside the [gitops](./gitops/README.md) folder of this project. 



## Roadmap



- Split cat-server to a cat-server and a cat-multiplayer service. 

- Implement an Infispan service to make cat-multiplayer more scalable

- Make cat-multiplayer reactive to keep up with several concurrent sessions



## About the graphics

The map graphics are coming from [LPC Terrain](https://opengameart.org/content/tiled-terrains) and all its authors. Special thanks to all of them!