Manual posting
Emits the post event
Auto posting
Emits the autopost-start event
Post stats about a command
command_namestring The name of the command that was runauthor_idstring The id of the user that ran the command
Register the function to get the values for posting
customFieldNumber(1|2) Whether the handler is for customField1 or customField2handlerNormal Handler
Returns (Error | null)
Register the function to get the values for posting
customFieldNumber(1|2) Whether the handler is for customField1 or customField2handlerSharding Handler
Returns (Error | null)
Post stats about a command
command_namestring The name of the command that was runauthor_idstring The id of the user that ran the commandclientany The discord client this command is being posted for
Post all current stats to statcord
Emits the post event
Asynchronous function
clientDiscord.js Client The client is passed to your function when getting the data
Returns (Promise<string>)
Asynchronous function
managerDiscord.js ShardingManager The manager is passed to your function when getting the data
Returns (Promise<string>)
"post" - Emitted whenever a post to the api takes place
status - (false | Error | string)
"autopost-start" - Emitted when autopost is started
const Statcord = require("statcord.js");
const Discord = require("discord.js");
const client = new Discord.Client();
// Create statcord client
const statcord = new Statcord.Client({
key: "statcord.com-APIKEY",
client,
postCpuStatistics: false, /* Whether to post CPU statistics or not, defaults to true */
postMemStatistics: false, /* Whether to post memory statistics or not, defaults to true */
postNetworkStatistics: false /* Whether to post network statistics or not, defaults to true */
});
/* Register custom fields handlers (these are optional, you are not required to use this function)
* These functions are automatically run when posting
*/
// Handler for custom value 1
statcord.registerCustomFieldHandler(1, async (client) => {
// Get and return your data as a string
});
// Handler for custom value 2
statcord.registerCustomFieldHandler(2, async (client) => {
// Get and return your data as a string
});
// Client prefix
const prefix = "cs!";
client.on("ready", async () => {
console.log("ready");
// Start auto posting
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);
// Post command
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") {
// Only owner runs this command
if (message.author.id !== "bot_owner_id") return;
// Example of manual posting
statcord.post();
}
});
statcord.on("autopost-start", () => {
// Emitted when statcord autopost starts
console.log("Started autopost");
});
statcord.on("post", status => {
// status = false if the post was successful
// status = "Error message" or status = Error if there was an error
if (!status) console.log("Successful post");
else console.error(status);
});
client.login("TOKEN"); const Discord = require("discord.js");
const Statcord = require("statcord.js");
const manager = new Discord.ShardingManager('./bot.js', { token: "TOKEN"});
// Create statcord sharding client
const statcord = new Statcord.ShardingClient({
key: "statcord.com-APIKEY",
manager,
postCpuStatistics: false, /* Whether to post CPU statistics or not, defaults to true */
postMemStatistics: false, /* Whether to post memory statistics or not, defaults to true */
postNetworkStatistics: false, /* Whether to post network statistics or not, defaults to true */
autopost: false /* Whether to auto post or not, defaults to true */
});
/* Register custom fields handlers (these are optional, you are not required to use this function)
* These functions are automatically run when posting
*/
// Handler for custom value 1
statcord.registerCustomFieldHandler(1, async (manager) => {
// Get and return your data as a string
});
// Handler for custom value 2
statcord.registerCustomFieldHandler(2, async (manager) => {
// Get and return your data as a string
});
// Spawn shards, statcord works with both auto and a set amount of shards
manager.spawn();
// Normal shardCreate event
manager.on("shardCreate", (shard) => {
console.log(`Spawned shard ${shard.id}`);
});
statcord.on("autopost-start", () => {
// Emitted when statcord autopost starts
console.log("Started autopost");
});
statcord.on("post", status => {
// status = false if the post was successful
// status = "Error message" or status = Error if there was an error
if (!status) console.log("successful post");
else console.error(status);
});const Discord = require("discord.js");
const Statcord = require("statcord.js");
const client = new Discord.Client();
/* There is no need to create a statcord client in the bot script,
because it has already been made in the sharding script
*/
// Client prefix
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);
// Post command
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") {
// Only owner runs this command
if (message.author.id !== "bot_owner_id") return;
// Example of manual posting
Statcord.ShardingClient.post(client);
// Errors on the sharding client will be sent to the console straight away
}
});
client.login("TOKEN");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!
You can also help me and the project out by sponsoring me through a donation on PayPal.
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.:
