Hammer Framework Core Package

Core package to create Hammer bots
Get support »

Report Bug · Documentation

@hammerhq/core

Core package for Hammer Discord bot.
Allows you to create a bot with a simple API.
Built on top of discord.js.
Built-in localization and logger support. More coming soon!
Incredible modularity with plugin support.

📦 Installation

$ npm install @hammerhq/core

🚀 Usage

You can use @hammerhq/core package to create bots, events, services and plugins.

🤖 Creating bots with Hammer's core

import { bootstrap } from "@hammerhq/core";
import { Client } from "discord.js";
import { join } from "path";

const client = new Client(ClientOptions);

async function main() {
	await bootstrap({
		client,
		i18n: {
			defaultLocale: "en", // default locale, see @hammerhq/localization
			directory: join(__dirname, "..", "locales"), // locales directory, see @hammerhq/localization
		},
		plugins: [
			// hammer plugins here. You can download them with hammer cli, from npm and create your own!
		],
	});

	await client.login(CONFIG.BOT_TOKEN);
}

main();

📦 Creating plugins

🌳 Simple plugin structure

import { Plugin } from "@hammerhq/core";

@Plugin({
	services: [], // services to register
	events: [], // events to register
})
export class MyPlugin {}

🏃 Run functions on plugin load

import { Plugin } from "@hammerhq/core";

@Plugin({
	services: [], // services to register
	events: [], // events to register
})
export class MyPlugin {
	public async onLoad() {
		// do something on plugin load
		console.log("Plugin loaded!");
	}
}

💉 Inject services

import { Plugin } from "@hammerhq/core";
import { MyOtherService } from "/path/to/MyOtherService";

@Plugin({
	services: [], // services to register
	events: [], // events to register
})
export class MyPlugin {
	constructor(private readonly myOtherService: MyOtherService) {}

	// use your service like `this.myOtherService`
	public async onLoad() {
		this.myOtherService.doSomething();
	}
}

📦 Creating services

🌳 Simple service structure

import { Service } from "@hammerhq/core";

@Service({})
export class MyService {
	// service code here
}

🏃 Run functions on service load

import { Service } from "@hammerhq/core";

@Service({})
export class MyService {
	public async onLoad() {
		// do something on service load
		console.log("Service loaded!");
	}

	// service code here
}

💉 Injecting services

import { Service } from "@hammerhq/core";
import { MyOtherService } from "/path/to/MyOtherService";

@Service({})
export class MyService {
	constructor(private readonly myOtherService: MyOtherService) {}

	// use your service like `this.myOtherService`
	public async onLoad() {
		this.myOtherService.doSomething();
	}

	// service code here
}

📦 Creating events

🌳 Simple event structure

import { Event } from "@hammerhq/core";

@Event({
	name: "ready", // event name, see discord.js client events
	once: false, // runs once or not
})
export class MyReadyEvent {
	public async execute() {
		// event code here
		console.log("Bot is ready!");
	}
}

🏃 Run functions on event load

import { Event } from "@hammerhq/core";

@Event({
	name: "ready", // event name, see discord.js client events
	once: false, // runs once or not
})
export class MyReadyEvent {
	public async onLoad() {
		// do something on event load
		console.log("Event loaded!");
	}

	public async execute() {
		// event code here
		console.log("Bot is ready!");
	}
}

💉 Injecting services

import { Event } from "@hammerhq/core";
import { Message } from "discord.js";
import { MyOtherService } from "/path/to/MyOtherService";

@Event({
	name: "messageCreate", // event name, see discord.js client events
	once: false, // runs once or not
})
export class MyReadyEvent {
	constructor(private readonly myOtherService: MyOtherService) {}

	// use your service like `this.myOtherService`
	public async onLoad() {
		this.myOtherService.doSomething();
	}

	public async execute(message: Message) {
		// event code here
		message.channel.send("Hello world!");
	}
}

🛠️ Utilities

🌍 Localization

Hammer's core comes with localization support. You can use it like this:

import { Service, Localization } from "@hammerhq/core";
import { I18n } from "@hammerhq/localization";

// we created a service for testing purposes but you can use localization service in events and plugins too
@Service({})
export class MyService {
	@Localization()
	i18n: I18n;

	// use your service like `this.i18n`
	public async onLoad() {
		// see @hammerhq/localization for more info
		const str = this.i18n.get("en", "services", "on_load", {
			service_name: "MyService",
		});

		console.log(str); // "MyService loaded!"
	}
}

📢 Logger

You can easily use @hammerhq/logger in you plugins, services and events. Just inject it like this:

import { Service, Logger } from "@hammerhq/core";
import { Logger as HammerLogger } from "@hammerhq/logger";

// we created a service for testing purposes but you can use logger service in events and plugins too
@Service({})
export class MyService {
	@Logger("[MyService]:")
	logger: HammerLogger;

	// use your service like `this.logger`
	public async onLoad() {
		// see @hammerhq/logger for more info
		this.logger.success("MyService loaded!"); // [MyService]: MyService loaded!
	}
}

🤖 Client

You can easily access client in you plugins, services and events. Just inject it like this:

import { Event, Client } from "@hammerhq/core";
import { Client as DJSClient } from "discord.js";

// we created an event for testing purposes but you can use client service in services and plugins too
@Event({
	name: "ready", // event name, see discord.js client events
	once: false, // runs once or not
})
export class MyReadyEvent {
	@Client()
	client: DJSClient;

	// use your service like `this.client`
	public execute() {
		console.log(`Logged in as ${client.user.tag}!`); // Logged in as Hammer#0000!
	}
}

📦 Complete plugin example

import { Plugin, Service, Event, Logger, Client } from "@hammerhq/core";
import { Logger as HammerLogger } from "@hammerhq/logger";
import { Client as DJSClient } from "discord.js";

@Service({})
export class MyService {
	@Logger("[MyService]:")
	logger: HammerLogger;

	public onLoad() {
		this.logger.event("MyService loaded!");
	}

	public add(a: number, b: number): number {
		return a + b;
	}
}

@Event({
	name: "ready",
	once: false,
})
export class MyReadyEvent {
	@Logger("[MyReadyEvent]:")
	logger: HammerLogger;

	@Client()
	client: DJSClient;

	constructor(private readonly myService: MyService) {}

	public onLoad() {
		this.logger.event("MyReadyEvent loaded!");
	}

	public execute() {
		const sum = this.myService.add(2, 2);

		this.client.user.setActivity(`2 + 2 = ${sum}`);
	}
}

@Plugin({
	services: [MyService],
	events: [MyReadyEvent],
})
export class MyPlugin {
	@Logger("[MyPlugin]:")
	logger: HammerLogger;

	public onLoad() {
		this.logger.event("MyPlugin loaded!");
	}
}

🧦 Looking For Contributors

We are looking for contributors to actively work on Hammer and to contribute to the repos. There is still lots of work to do. If you are interested in contributing, please join our Discord server. (There will be a surprise for early contributors!)

🔑 License

Distributed under the GPL-3.0 License. See LICENSE for more information.

🧦 Contributing

This repo is open for #hacktoberfest. Feel free to use GitHub's features.

Fork the Project
Create your Feature Branch (git checkout -b feature/my-feature)
Run prettier (npm run format)
Commit your Changes (git commit -m 'my awesome feature my-feature')
Push to the Branch (git push origin feature/my-feature)
Open a Pull Request

⭐️ Show your support

Give a ⭐️ if this project helped you!

☎️ Contact

Mail: hammer@338.rocks
Discord: https://338.rocks/discord
Website: https://hammer.338.rocks
Documentation: https://hammer.338.rocks/docs/packages/core

@hammerhq/core

Hammer Framework Core Package

@hammerhq/core

📦 Installation

🚀 Usage

🤖 Creating bots with Hammer's core

📦 Creating plugins

🌳 Simple plugin structure

🏃 Run functions on plugin load

💉 Inject services

📦 Creating services

🌳 Simple service structure

🏃 Run functions on service load

💉 Injecting services

📦 Creating events

🌳 Simple event structure

🏃 Run functions on event load

💉 Injecting services

🛠️ Utilities

🌍 Localization

📢 Logger

🤖 Client

📦 Complete plugin example

🧦 Looking For Contributors

🔑 License

🧦 Contributing

⭐️ Show your support

☎️ Contact

Readme

Keywords

Package Sidebar

Install

Repository

Homepage

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

Weekly Downloads