xysDavid / croyale

Easy to use asynchronous Wrapper for RoyaleAPI.

An easy to use Asynchronous wrapper to interact with RoyaleAPI.com

Features

• Object Oriented
• User friendly
• Maximum coverage of the API
• Cache, Rate-limit and error handling
• Utility functions

Installation

node.js 8.0.0 or newer is required

Stable: npm install croyale

Master: npm install TheLearneer/croyale

master branch might contian some bugs, so if you are interested in bug free code then install stable, but if you are want to have the latest of the wrapper then install master branch.

Example Usage

const { Client } = require('croyale');
const client = new Client('super secret token');

client.Users.getProfile('CVLQ2GV8', { keys: ['tag', 'name'] })
	.then(player => {
		console.log(`Name of the player with tag ${player.tag} is ${player.name}`);
	})
	.catch(console.error);

Credits

• The major credit for the existence of this wrapper goes to the developers of the api; SML and Selfish.
• In the meantime I would like to thank every individual person who have directly or indirectly helped me.

Links

• Documentation
• CRoyale Discord server
• RoyaleAPI Discord server
• GitHub
• NPM

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the documentation.
Make sure the changes you made aren't breaking things and are working fine if you'd like to submit a PR.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Croyale Server.