Git Product home page Git Product logo

embed-creator-english-guide's Introduction

Embed Creator

Simple discord bot for sending custom embeds to channels

Setting up

  • Run npm install to install all dependencies.
  • Edit config.json file inside the config directory.
  • Run npm start or node server.js to start the bot.

Customization

  • config directory contains all configuration files.

Config files

  • config.json - Basic options such as bot token & allowed roles.
  • commands.json - Custom commands with their responses.
  • responses.json - Responses used inside the code.
    ex, Response to send when user doesn't have the permission.

How to use

Command Syntax

[PREFIX] <title> | <description> | <channel name> | <color> | <thumbnail image url> | <author name> | <author image url> | <author link>

Basic usage

  • Everything except <title> is optional.
  • You need to provide the arguments in the same order as above, separated by the | character. (You can change this character).
  • You can skip providing arguments using a space. (Check out the examples below)

Rich Command Syntax

[PREFIX] ti~<value> | de~<value> | ch~<value> | co~<value> | th~<value> | an~<value> | ai~<value> | al~<value>

Keys explained

Key Meaning
ti title
de description
ch channel name
co embed color
th thumbnail url
an author name
ai author image url
al author link
im image url
ft footer text
fi footer img

Rich Command usage

  • Rich commands allow you to send arguments in any order.
  • It uses key~value pairs.
  • Everything except ti is optional.
  • You need to provide the arguments using key~value pairs, separated by the | character. (You can change this character).

Examples

?embed is used as the prefix for examples.

  1. Send an embed to the current channel.
    ?embed Test | This is a test

  2. Send an embed to a channel named example.
    ?embed Test | This is a test | example

  3. Send an embed to a channel named example with the color red.
    ?embed Test | This is a test | example | #ff0000
    (Use hex color values)

  4. Send an embed to the current channel with the color red.
    ?embed Test | This is a test | | #ff0000
    (Space is used to skip the <channel name> argument)

  5. Send an embed to a channel named example using rich commands.
    ?embed ti~test | ch~example

  6. Send an embed to a channel named example with the color red using rich commands.
    ?embed ti~test | ch~example | co~#ff0000

embed-creator-english-guide's People

Contributors

viper-cod avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.