Giter VIP home page Giter VIP logo

polaris's Introduction

Polaris

Codacy Badge Polaris project bot

Polaris is an open source Roblox verification bot, created in November 2017 and open sourced in December 2018.

It is currently labelled as unmaintained in the sense that I will not be actively improving it or fixing less critical bugs. If you'd like to take over maintaining the bot, feel free to contact me or just fork and PR some fixes!

This bot is designed to work in tandem with the Polaris-React webpanel and site.

Feel free to snoop, edit, hash, contribute to and remix the 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 rethinkdb database is running
  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.

The main website.

polaris's People

Contributors

neztore avatar reduxgb avatar dependabot[bot] avatar iranathan avatar johnnymorganz avatar codacy-badger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.