# Slither.io bot
Just for fun and AI. Written in Javascript, this is a project which the aim is to make a computer play against humans inside a human-driven game, which is in this case Slither.io. The goal is simple - try and make the snake live and get as long as possible.

[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000)](https://gitter.im/ErmiyaEskandary/Slither.io-bot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

# Table of Contents
- [Installation instructions](https://github.com/ErmiyaEskandary/Slither.io-bot#installation-instructions)
	- [Visual tutorial](https://github.com/ErmiyaEskandary/Slither.io-bot#visual-tutorial)
	- [Text tutorial](https://github.com/ErmiyaEskandary/Slither.io-bot#text-tutorial)
- [Hotkeys](https://github.com/ErmiyaEskandary/Slither.io-bot#hotkeys)
- [Contributing](https://github.com/ErmiyaEskandary/Slither.io-bot#contributing)
	- [Documentation](https://github.com/ErmiyaEskandary/Slither.io-bot#documentation)
- [Authors](https://github.com/ErmiyaEskandary/Slither.io-bot#authors)
- [License](https://github.com/ErmiyaEskandary/Slither.io-bot#license)

# Installation instructions

**NOTE: these instructions are for installing the bot at a production-ready, fully working and a fully tested state, which is recommended. For the latest bleeding edge code, which may not be fully tested, refer to the bot.user.js file in the current default develop branch as the instructions below refer the bot file in the master branch.**

## Interactive tutorial
http://slither.jlynx.net/

## Visual tutorial
https://www.youtube.com/watch?v=d7mkAgQNuCA - Created by http://slither.jlynx.net/

https://youtu.be/mlEKp-ZAi7w - Created by http://slithere.com/

https://youtu.be/QF9JBMi-fLo?t=38s - Created by SeppeTutorials

https://youtu.be/IpsAazbVIcw - Created by TheFlyingPlatypus

## Text tutorial
If you are on chrome, download the [TamperMonkey](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo?hl=en) extension.

On other browsers, use the [GreaseMonkey](https://addons.mozilla.org/en-GB/firefox/addon/greasemonkey/) extension.

Once installed, click on [this](https://github.com/ErmiyaEskandary/slither.io-bot/raw/master/bot.user.js), and choose **Install**.

Go to [slither.io](http://slither.io/), and enjoy !

# Hotkeys

Key | Result
---|---
T / Right Click | Bot enabled/disabled
**O** | **Mobile rendering - Try this if you experience lag**
A/S | Radius multiplier
D | Quick radius change - "approach" and "avoid" mode
I | Auto respawn
G | Leaderboard overlay
Y | Visual debugging
U | Log debugging
H | Overlays
B | Background Change
Mouse wheel | Zoom in/out
Z | Reset zoom
ESC | Quick respawn
Q | Quit to menu


# Contributing

Please refer to the [guidelines for contributing](https://github.com/ErmiyaEskandary/Slither.io-bot/blob/master/.github/CONTRIBUTING.md) for all the information you need.

[Check the wiki for additional information](https://github.com/ErmiyaEskandary/Slither.io-bot/wiki)

NOTE : For existing collaborators, please refer to the [DEVELOPER.md file.](https://github.com/ErmiyaEskandary/Slither.io-bot/blob/master/DEVELOPER.md)
## Documentation

[![Documentation Status](https://readthedocs.org/projects/slitherio-bot/badge/?version=latest)](http://slitherio-bot.readthedocs.io/en/latest/?badge=latest)

The [online documentation](http://slitherio-bot.readthedocs.io/en/master/) is maintained in the `/docs` directory.

# Authors
**Ermiya Eskandary & Théophile Cailliau (ErmiyaEskandary & FliiFe)**

Started as a collaborative and fun project between me and FliiFe on 2016/04/20, with this :
> Slither.io bot could be cool

# License

**Licensed under the Mozilla Public License, v. 2.0**

Read LICENSE.md for more info.
