Table of Contents
Statcord
post
Manual posting
Emits the post event
autopost
Auto posting
Emits the autopost-start event
postCommand
Post stats about a command
Parameters
command_name
string The name of the command that was runauthor_id
string The id of the user that ran the command
registerCustomFieldHandler
Register the function to get the values for posting
Parameters
customFieldNumber
(1
| 2
) Whether the handler is for customField1 or customField2handler
Normal Handler
Returns (Error | null)
ShardingClient
registerCustomFieldHandler
Register the function to get the values for posting
Parameters
customFieldNumber
(1
| 2
) Whether the handler is for customField1 or customField2handler
Sharding Handler
Returns (Error | null)
postCommand
Post stats about a command
Parameters
command_name
string The name of the command that was runauthor_id
string The id of the user that ran the commandclient
any The discord client this command is being posted for
post
Post all current stats to statcord
Emits the post event
Handlers
Normal Handler
Asynchronous function
Parameters
Returns (Promise<string>)
Sharding Handler
Asynchronous function
Parameters
Returns (Promise<string>)
Events
post event
"post" - Emitted whenever a post to the api takes place
Parameters
status - (false | Error | string)
autopost-start event
"autopost-start" - Emitted when autopost is started
Examples
Normal Usage
const Statcord = require("statcord.js");
const Discord = require("discord.js");
const client = new Discord.Client();
const statcord = new Statcord.Client({
key: "statcord.com-APIKEY",
client,
postCpuStatistics: false,
postMemStatistics: false,
postNetworkStatistics: false
});
statcord.registerCustomFieldHandler(1, async (client) => {
});
statcord.registerCustomFieldHandler(2, async (client) => {
});
const prefix = "cs!";
client.on("ready", async () => {
console.log("ready");
statcord.autopost();
});
client.on("message", async (message) => {
if (message.author.bot) return;
if (message.channel.type !== "text") return;
if (!message.content.startsWith(prefix)) return;
let command = message.content.split(" ")[0].toLowerCase().substr(prefix.length);
statcord.postCommand(command, message.author.id);
if (command == "say") {
message.channel.send("say");
} else if (command == "help") {
message.channel.send("help");
} else if (command == "post") {
if (message.author.id !== "bot_owner_id") return;
statcord.post();
}
});
statcord.on("autopost-start", () => {
console.log("Started autopost");
});
statcord.on("post", status => {
if (!status) console.log("Successful post");
else console.error(status);
});
client.login("TOKEN");
Sharding Usage
sharder.js
const Discord = require("discord.js");
const Statcord = require("statcord.js");
const manager = new Discord.ShardingManager('./bot.js', { token: "TOKEN"});
const statcord = new Statcord.ShardingClient({
key: "statcord.com-APIKEY",
manager,
postCpuStatistics: false,
postMemStatistics: false,
postNetworkStatistics: false,
autopost: false
});
statcord.registerCustomFieldHandler(1, async (manager) => {
});
statcord.registerCustomFieldHandler(2, async (manager) => {
});
manager.spawn();
manager.on("shardCreate", (shard) => {
console.log(`Spawned shard ${shard.id}`);
});
statcord.on("autopost-start", () => {
console.log("Started autopost");
});
statcord.on("post", status => {
if (!status) console.log("successful post");
else console.error(status);
});
bot.js
const Discord = require("discord.js");
const Statcord = require("statcord.js");
const client = new Discord.Client();
const prefix = "cs!";
client.on("ready", async () => {
console.log("ready");
});
client.on("message", async (message) => {
if (message.author.bot) return;
if (message.channel.type !== "text") return;
if (!message.content.startsWith(prefix)) return;
let command = message.content.split(" ")[0].toLowerCase().substr(prefix.length);
Statcord.ShardingClient.postCommand(command, message.author.id, client);
if (command == "say") {
message.channel.send("say");
} else if (command == "help") {
message.channel.send("help");
} else if (command == "post") {
if (message.author.id !== "bot_owner_id") return;
Statcord.ShardingClient.post(client);
}
});
client.login("TOKEN");
Contributing
Contributions are always welcome!
Take a look at any existing issues on this repository for starting places to help contribute towards, or simply create your own new contribution to the project.
When you are ready, simply create a pull request for your contribution and we will review it whenever we can!
Donating
You can also help me and the project out by sponsoring me through a donation on PayPal.
Discussion, Support and Issues
Need support with this project, have found an issue or want to chat with others about contributing to the project?
Please check the project's issues page first for support & bugs!
Not found what you need here?
- If you have an issue, please create a GitHub issue here to report it, include as much detail as you can.
- Alternatively, You can join our Discord server to discuss any issue or to get support for the project.: