Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/Wil2129/Battle-arena

A battle royale game for the real ones built with Phaser 3 and Colyseus
https://github.com/Wil2129/Battle-arena

2d-game battle-royale colyseus phaser shooting-game top-down top-down-shooter

Last synced: 26 days ago
JSON representation

A battle royale game for the real ones built with Phaser 3 and Colyseus

Awesome Lists containing this project

README 

        
# Battle-arena

Battle royale game for the real ones. Built with Phaser 3 and Colyseus, Battle arena - battefield honor is a survival game in its epiphany which brings players in unkown locations of a map together and force them to fight for thier survival. It came form the concept of popular games such as [Fortnite](https://fr.wikipedia.org/wiki/Fortnite) or [Pubg](https://fr.wikipedia.org/wiki/PlayerUnknown%27s_Battlegrounds) 



## Technical information

* Our game's frontend is developed in [PhaserJS](https://phaser.io/) - a js framework which gives us the possibility to build HTML5 games with less stress. 

* Our game's backend is done with nodeJS which uses [Colyseus](https://colyseus.io/) to implement a powerful multiplayer game server.

* The sound, image assets from the game are all from various internet sources (All Open Source)

* The map of the game has been drawn using Tiled Map Editor - a powerful tool to draw game maps.



## What we have already implemented

* The display of the map on the game.

* The mouvement of the player and its rotation according to the position of the mouse even while moving.

* The connection between the client and the server which permits us to:

  * Send message between players to see, who is dead, who just entered the party, who left it etc

  * The server to send updates about some crucial information such as other players position in the map

* The firing of the bullet by the player and its collision with other player to eliminate them.

* The score which shows how many players has been eliminated by a particular player.|



## What we still have to implement

* SoundTrack when the playing in the game.

* Sound effects for the game (bullet firing).

* HUD's to display the useful information about the player such as its health.

* Multiple rooms to host multiple parties and add limitations to number of player allowed per room.

* A Menu system to help the player navigate along the game.

* Powerups and special abilities that the player can have along the game.

* More weapons of course!!!

* Authentication for persistent players and those who wnat to keep thier gained XP's and rewards. (primarily with facebook)

* intergration with facebook instant games(optional).

* push notification systems and data storage implemented with firebase for players to be able to save thier highest scores, XP's and rewards.



## How to install it

To be able to install and run the game, you need to download:

* [Git](https://git-scm.com/downloads)

* [Node](https://nodejs.org/en/) - take the LTS (latest stable version) version



After installation of the above programs, if you didm't have them...



1. clone the repository by entering the command below in your terminal.



  ```git clone https://github.com/ArnolFokam/Battle-arena.git```



2. Navigate to the folder of the project using your terminal 



3. Next, enter this command in your terminal to install the dependencies you need for the game.

  ```npm install```

4. Then run this command to run the game server on your computer.

  ```npm run start:server```

5. That's it. Your server is up and running. By now, you can open a couple of pages to test it on you computer.

  * [http://localhost:2567](http://localhost:2567) can be opened in you browser to see and play the game.

  * [http://localhost:2567/colyseus](http://localhost:2567/colyseus) can be opened to monitor the  status of your game server. (client connected, rooms etc)



Note: if you want others to access the webpage and play the game. You must be connected through the same network and the must replace the localhost in the url with your IP address in the network.



To know your IP address in the network. this link may help you. :point_right: [Find your computer's IP address](https://kb.iu.edu/d/aapa)



## Who is behind this

Three brightful minds namely:



 [Arnol Fokam](https://github.com/ArnolFokam/) - JS Ninja and cold blooded Game architect.  

 [Teddy Baha](https://github.com/Wil2129) - Firebase Samurai and Ace critical thinker.  

 [Alex Jordan](https://github.com/alexjordan05) - Graphics Sensei and Gamer in the Soul.