agario-clone

Clone of Agar.io for tweaking, implementing new features, and learning how to program with p5.js.

The easily tweakable clone for modders, developers and .io games enthusiasts of any level! 💪

  🔴 Accurate: true to the feel of the game.
  🟠 Customizable: configure all aspects of the game.
  🟡 Fun: create cool new mods in seconds.
  🟢 Extendable: add any mod imaginable.
  🔵 Feature rich: has most of agar.io's features.
  🟣 Easy: use p5.js to add features in minutes.

🎯 Project Goals

Provide a simple framework to allow rapidly implementing new Agar.io features.
Teach how to create io games and how to work with p5.js and JavaScript in general.
Be highly tweakable and inspire creation of new games.

🚀 Getting Started

Step 0. Prerequisites

Node.js v17.4.0 - the version which this project was created and tested on.
Yarn - a package manager aimed at stability.
Git - for cloning this repository.
A terminal set up in your projects folder to clone and run this project.

Step 1. Download

git clone https://github.com/yamyam263/agario-clone.git

Alternatively, you can use GitHub Desktop, GitHub CLI, or Download ZIP.

Step 2. Install

cd agario-clone
yarn

Step 3. Run

yarn start

✔️ You're done! Head over to localhost:3000 on your browser to play the game!

🛠️ Configuration & Tweaking

Head over to config/settings.json using your favorite editor (for example: vscode, Notepad on Windows or TextEdit on Mac). Start tweaking! Upon finishing step 3 of the setup, your terminal should be listening to any changes you make. Just hit save and test your changes on localhost:3000 - there is no need to refresh.

🙏 Thank You

Please check out these previous works that helped inspire the creation of agario-clone. 🧠

Agar.io coding challenge by The Coding Train - inspired this entire project.
starship - inspired the structure of this README.md.

yamcodes/agario-clone