GCommands

Creating your first listener

What is a listener?

A listener listens to events that occur. This could be events from the discord API, or from GCommands.

Creating a listener

When setting up the client you added path.join(__dirname, 'listeners') so go ahead and open or create the listeners folder and create a new file in it.

const { Listener } = require('gcommands');

// Create a new listener listening to the "ready" event
new Listener({
	// Set the name for the listener
	name: 'ready',
	// Set the event to listen to
	event: 'ready',
	// The function thats called when the event occurs
	run: (client) => {
		return console.log(`Ready! Initialized with ${client.guilds.cache.size} guilds`);
	}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
const { Listener } = require('gcommands');

// Create a new listener listening to the "ready" event
new class extends Listener {
	constructor() {
		super({
			// Set the name for the listener
			name: 'ready',
			// Set the event to listen to
			event: 'ready',
		});
	}

	// The function thats called when the event occurs
	run(client) {
		return console.log(`Ready! Initialized with ${client.guilds.cache.size} guilds`);
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

In this case, you don't define the client in the first place, you define the variable directly. So for example, if you have a messageCreate listener, the run function will be something like this: run: (message) => {}. discord.js puts a client in each structure, so you just use message.client afterwards. In the case of class, you can use this.client as you do with commands.

This listener listens to the ready event. The ready event gets emitted when your client becomes ready. After restarting your bot you should see this in your console:

Ready! Initialized with 1 guilds