iranathan / Polaris

Polaris is a Roblox verification bot designed to provide additional features with greater ease.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Info

Codacy Badge Polaris project bot

Polaris is a Roblox verification bot that has been closed source since it's creation.

This Christmas however we thought long and hard about this, and we think the best way to achieve our goal - to help as many people as possible power their server with as little effort as possible - is to open source.

So here it is! The Polaris bot. We'll be open sourcing our webpanel and website in the coming days.

Feel free to snoop, edit, hash, contribute to and remix our bot!

Installing

  1. Clone this repo - git clone https://github.com/neztore/polaris
  2. Navigate into new folder cd polaris
  3. Run npm install in this repo
  4. Create your settings.json. Set sync to true
  5. Make sure your PostgreSQL database is running (or rethinkdb depending on version)
  6. Run it!

Setup / config

Config

The Polaris client takes a config object, which can contain:

  • token - The bot token to use
  • erisOptions - The options to pass to the underlying eris client
  • Raven - A Raven client for sentry. Use without this is planned, but currently untested.

It also expects a settings.json to exist in the root, with example values as below. We also plan to stop moving this in the near future.

{
	"token": "Main bot token",
	"testToken": "Test bot token",
	"dblToken": "Discord bot list token",
	"sentry": "Sentry token",
	"specialPeople": {
		"93968063": "This user works for Polaris.",
		"66592931": "This user is the Polaris developer.",
		"Roblox id": "Desc string to be shown"
	}
}

If you don't want any "special people" just leave that as an empty array.

Support

Join our discord for support. This open sourcing will not affect the main bot.

The main website

About

Polaris is a Roblox verification bot designed to provide additional features with greater ease.

License:MIT License


Languages

Language:JavaScript 100.0%