Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Contains information on how to install the file and how to run it
  • Loading branch information
Joshuliu committed Jun 8, 2018
1 parent 7d52d80 commit 7b9910c
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Discord Webhook Embed Generator

![Discord Webhook Embed Generator](https://i.imgur.com/vUDRSvW.png)

## Getting Started

### What is required

[Webhook Embed.py](https://www.dropbox.com/s/oku8rvg75yjsyxh/Webhook%20Embed.py?dl=1)
• Python (Download for [Mac](https://www.python.org/ftp/python/3.6.5/python-3.6.5-macosx10.6.pkg)/[Linux](https://www.python.org/ftp/python/3.6.5/Python-3.6.5.tar.xz)/[Windows](https://www.python.org/ftp/python/3.6.5/python-3.6.5-amd64.exe))

### Run the file

Use Python Launcher to execute **Webhook Embed.py**. This file is compatible with all versions of Python.

## Creating the Embed

### Step 1 - Essential Information

![Webhook Editing](https://i.imgur.com/1Z71brT.png)

#### Webhook URL

The script will first ask for your webhook URL. This will be provided at the bottom of the webhook editing panel for the webhook.
Make sure that you've also already set your webhook's profile picture and username.

#### Title and Description

The script will prompt for a title and description. This is the first two lines of every embed. Enter the corresponding answer.

### Step 2 - Going into Detail

#### Setting a Thumbnail

Setting a thumbnail is optional. This is an image on the top right that is shown from a given URL.

#### Fields

You can have up to 25 fields per embed, each with a custom name and content. Fields are also optional.

#### Embed Color

You will be prompted to enter a 6 digit hex key for the color of the embed. This is the left stripe of color.

### Step 3 - Enjoy!

If everything worked as planned, the bot will send a preview of the data being sent, and then the webhook will send the embed into the channel provided by the webhook creator.

0 comments on commit 7b9910c

Please sign in to comment.