Ecosyste.ms: Awesome

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

https://github.com/owenashurst/agar.io-clone

Agar.io clone written with Socket.IO and HTML5 canvas
https://github.com/owenashurst/agar.io-clone

Last synced: 20 days ago
JSON representation

Agar.io clone written with Socket.IO and HTML5 canvas

Lists

README 

        
Agar.io Clone

=============



This project was originally created by @huytd. I have since taken ownership of the repository to revive the project.



[![GitHub Stars](https://img.shields.io/github/stars/huytd/agar.io-clone.svg)](https://github.com/huytd/agar.io-clone/stargazers)

[![GitHub Issues](https://img.shields.io/github/issues/huytd/agar.io-clone.svg)](https://github.com/huytd/agar.io-clone/issues)

[![GitHub Wiki](https://img.shields.io/badge/project-wiki-ff69b4.svg)](https://github.com/huytd/agar.io-clone/wiki/Home)

[![Live Demo](https://img.shields.io/badge/demo-online-green.svg)](#live-demos)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/huytd/agar.io-clone?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



A simple but powerful Agar.IO clone built with socket.IO and HTML5 canvas on top of NodeJS.



![Image](screenshot.png)



## Live Demos

An updated live list of demos can be found on the [Live Demos wiki page](https://github.com/owenashurst/agar.io-clone/wiki/Live-Demos).



The official Agar.IO-Clone URL can be found [here](https://owenashurst-agario-clone.herokuapp.com).



This is the most up to date version from master. Any merged pull requests will deploy to this URL automatically.



---



## How to Play

You can check out how to play on our [wiki](https://github.com/owenashurst/agar.io-clone/wiki/How-to-Play).



#### Game Basics

- Move your mouse around the screen to move your cell.

- Eat food and other players in order to grow your character (food respawns every time a player eats it).

- A player's **mass** is the number of food particles eaten.

- **Objective**: Try to get as big as possible and eat other players.



#### Gameplay Rules

- Players who haven't eaten yet cannot be eaten as a sort of "grace" period. This invincibility fades once they gain mass.

- Everytime a player joins the game, **3** food particles will spawn.

- Everytime a food particle is eaten by a player, **1** new food particle will respawn.

- The more food you eat, the slower you move to make the game fairer for all.



---



## Latest Changes

- Game logic is handled by the server

- The client side is for rendering of the canvas and its items only.

- Mobile optimisation.

- Implementation of working viruses.

- Display player name.

- Now supporting chat. 

- Type`-ping` in the chatbox to check your ping, as well as other commands!



---



## Installation

You can simply click one of the buttons below to easily deploy this repo to Bluemix or Heroku:



[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)



Or...



>You can check out a more detailed setup tutorial on our [wiki](https://github.com/owenashurst/agar.io-clone/wiki/Setup).



#### Requirements

To run / install this game, you'll need: 

- NodeJS with NPM installed.

- socket.IO.

- Express.



#### Downloading the dependencies

After cloning the source code from Github, you need to run the following command to download all the dependencies (socket.IO, express, etc.):



```

npm install

```



#### Running the Server

After downloading all the dependencies, you can run the server with the following command:



```

npm start

```



The game will then be accessible at `http://localhost:3000`. The default port is `3000`, however this can be changed in config. Further elaboration is available on our [wiki](https://github.com/owenashurst/agar.io-clone/wiki/Setup).



### Running the Server with Docker

If you have [Docker](https://www.docker.com/) installed, after cloning the repository you can run the following commands to start the server and make it acessible at `http://localhost:3000`:



```

docker build -t agarioclone_agar .

docker run -it -p 3000:3000 agarioclone_agar

```



---



## FAQ

1. **What is this game?**



  This is a clone of the game [Agar.IO](http://agar.io/). Someone said that Agar.IO is a clone of an iPad game called Osmos, but we haven't tried it yet. (Cloneception? :P)

  

2. **Why would you make a clone of this game?**



  Well, while the original game is still online, it is closed-source, and sometimes, it suffers from massive lag. That's why we want to make an open source version of it: for educational purposes, and to let the community add the features that they want, self-host it on their own servers, have fun with friends and more.

  

3. **Any plans on adding an online server to compete with Agar.IO or making money out of it?**



  No. This game belongs to the open-source community, and we have no plans on making money out of it nor competing with anything. But you can of course create your own public server, let us know if you do so and we can add it to our Live Demos list!

  

4. **Can I deploy this game to my own server?**



  Sure you can! That's what it's made for! ;)

  

5. **I don't like HTML5 canvas. Can I write my own game client with this server?**



  Of course! As long as your client supports WebSockets, you can write your game client in any language/technology, even with Unity3D if you want (there is an open source library for Unity to communicate with WebSockets)!

  

6. **Can I use some code of this project on my own?**



  Yes you can.



## For Developers

 - [Game Architecture](https://github.com/owenashurst/agar.io-clone/wiki/Game-Architecture) to understand how the backend works.

 - If you want to start your own project, I recommend you use [this template](https://github.com/huytd/node-online-game-template). Happy developing!

 -



## TODOs

 We have an explicit [TODO](https://github.com/owenashurst/agar.io-clone/wiki/Coming-Features) list for the all the features we aim to develop in the future. Feel free to contribute, we'll be more than grateful.



## License

>You can check out the full license [here](https://github.com/owenashurst/agar.io-clone/blob/master/LICENSE).



This project is licensed under the terms of the **MIT** license.