WOLF.js is a community maintained javascript library used to create Unofficial Bots
- Node Version: 18 +
- Visual Code
- WOLF.js - npm i wolf.js
- ioredis - npm i ioredis
- Create a new repo using the following repo Bot Template
keyword: keyword # keyword #single word only
framework:
developer: #your id here
language: en #default response language here
login:
email: # bot email here
password: # bot password here
onlineState: 1 # online state here
command:
ignore:
official: true # whether or not an official bot will trigger a command (internal)
unofficial: true # whether or not an unofficial bot will trigger a command (internal)
self: true # whether or not the bot will process its own messages and trigger its own commands (internal)
message:
ignore:
self: true # whether or not the bot will process its own messages (internal)
subscriptions:
messages:
channel:
enabled: true #subscribe to channel messages (server)
tipping: true # subscribe to channel message tip events (server)
private:
enabled: true # subscribe to private messages (server)
tipping: false # subscribe to private message tip events (server) - NOT IMPLEMENTED
[
{
"name": "{keyword}_command_{keyword}",
"comment":"{keyword} must match the keyword specified in config yaml",
"value":"!{keyword}"
},
{
"name": "{keyword}_command_help",
"value":"help"
},
{
"name": "{keyword}_help_message",
"value":"Welcome to the {botname} bot\n\n!{keyword} help - To display this message\n!{keyword} me - Display basic information about your profile"
},
{
"name": "{keyword}_command_me",
"value":"me"
},
{
"name": "{keyword}_subscriber_message",
"value":"Nickname: {nickname} (ID: {id})\nStatus Message: {status}\nLevel: {level} ({percentage}% completed)"
}
]import { WOLF, Command } from 'wolf.js';
import me from './src/me/index.js';
const client = new WOLF();
const keyword = client.config.keyword;
client.commandHandler.register(
[
new Command(`${keyword}_command_${keyword}`, { both: async (command) => command.reply(command.getPhrase(`${keyword}_help_message`)) },
[
new Command(`${keyword}_command_help`, { both: (command) => command.reply(command.getPhrase(`${keyword}_help_message`)) }),
new Command(`${keyword}_command_me`, { both: (command) => me(client, command) })
]
)
]
);
client.on('channelMessage', async (message) => {
if (message.body !== '!ping') { return false; };
return await message.reply('Pong!');
});
client.on('privateMessage', async (message) => {
if (message.isCommand) { return false; }
const { language } = await client.subscriber.getById(message.sourceSubscriberId);
return await message.reply(client.phrase.getByLanguageAndName(language, `${client.config.keyword}_help_message`))
});
client.on('ready', () => {
console.log('Ready');
});
client.login();/**
* Required for intellisense to work with client & command
* @param {import('wolf.js').WOLF} client
* @param {import('wolf.js').CommandContext} command
*/
export default async (client, command) => {
const subscriber = await client.subscriber.getById(command.sourceSubscriberId);
return await command.reply(
client.utility.string.replace(
command.getPhrase(`${client.config.keyword}_subscriber_message`),
{
nickname: subscriber.nickname,
id: subscriber.id,
status: subscriber.status,
level: subscriber.reputation.split('.')[0],
percentage: subscriber.percentage,
}
)
);
};Bots MUST be approved by WOLF staff in bot approval or bot approval.ar
- Nothing at all ᴺᵒᵗʰᶦⁿᵍ ᵃᵗ ᵃˡˡ
- Nothing at all ᴺᵒᵗʰᶦⁿᵍ ᵃᵗ ᵃˡˡ
- You can receive help in wolf.js