1.0.3 • Published 3 years ago

simple-discord-modules v1.0.3

Weekly downloads
102
License
ISC
Repository
github
Last release
3 years ago

Simple Discord Modules

A lightweight Node.js package to make creating discord.js components easier.

Installation

npm install simple-discord-modules --save

Usage

There are several functions made to make creating discord bots/components easier.

embedMaker

embedMaker takes in properties, and results in a discord embed object.

const SimpleDiscord = require('simple-discord-modules');

SimpleDiscord.embedMaker({ options });

options is a passable Object to embedMaker, you do not have to pass any option, when one is not present, it is left blank/default.

Options:

OptionTypeExampleRequires
titleString"Embed Title"-
descriptionString"Embed Description"-
authorString"Embed Author"-
authorImageString"Author Image URL"author
authorLinkString"Author Link URL"author & authorImage
footerString"Embed Footer-
footerImageString"Footer Image URL"footer
colorString"#ffffff"-
thumbnailString"Embed Thumbnail Image URL"-
imageString"Embed Image URL"-
linkString"Embed Link URL"-
timestampBooleantrue-
fieldsArray { field_Options }, { field_Options } -

Field Options:

OptionTypeExampleRequired
nameString"Field Name"Yes
valueString"Field Value"Yes
inlineBooleantrueNo

If you dont know what these values mean, I would reccomend reading up on embeds Here

Examples

embedMaker

message.channel.send(
	SimpleDiscord.embedMaker({
		title: 'Embed Title',
		description: 'Embed Description!',
		color: '#26d1e0',
		fields: [
			{ name: 'Field 1', value: 'Value 1', inline: true },
			{ name: 'Field 2', value: 'Value 2', inline: true },
			{ name: 'Field 3', value: 'Value 3' },
		],
	})
);