Skip to content

Latest commit

 

History

History
77 lines (42 loc) · 2.61 KB

README.md

File metadata and controls

77 lines (42 loc) · 2.61 KB

RabbitIO: Smart PlayerIO authentication

Rabbit is a library written in C#, and allows PlayerIO integration of Armor Games, Kongregate, Mousebreaker, Facebook, email, Yahoo, and standard authentication into one login interface. Give one username and password UI to your users, and Rabbit will know what service to authenticate them into.

Usage

After you have installed RabbitIO from NuGet, including Rabbit is easy:

Connection conn = new RabbitAuth().LogOn(gameId, email, passwordOrToken);

If you prefer to skip the authentication check, you can pass in the AuthenticationType manually (for example Kongregate):

Connection conn = new RabbitAuth(Rabbit.Auth.AuthenticationType = Rabbit.Auth.AuthenticationType.Kongregate).LogOn(gameId, email, token);

Everybody Edits

Use EERabbitAuth() to authenticate with Everybody Edits:

Connection conn = new EERabbitAuth().LogOn(EmailOrTokenOrUserName, RoomID, Password);

Project Goals

  • Well maintained
  • Well documented
  • Well tested
  • Maintain backwards compatibility

Project Maturity

Rabbit is a new library, and is used in CupCake, Terra, and Skylight, which together power the majority of the bots on Everybody Edits. Rabbit has no new issues for around a year, and so is deemed stable and can be used in any of your projects.

Supported Features

  • Support for Armor Games, Kongregate, Mousebreaker, Facebook, and standard authentication
  • Support for PlayerIO useSecureApiRequests
  • Smart error detection and recovery
  • Fast: queries are categorized in milliseconds
  • Many localizations

Getting Started

Over on the wiki, have a look at our Getting Started guide. Send questions to decagongithub@gmail.com, and report any issues to the GitHub Issue Tracker

Documentation & Examples

Rabbit has documentation available on GitHub.

For more samples, have a look at Rabbit.Tests

Requirements

Rabbit requires .NET framework 3.5 or later.

Credits

Yonom, author of Cupcake, significantly helped!

Continuous Integration

Build status

License

Copyright (C) 2014-2017 under the MIT license.