The Welcome Image Generator automatically generates a welcome image for people that just joined a guild. The best part about it is that you can put all values inside a single link, and the server will generate the image with your given information
As already mentioned, all values are given through a GET-Request, or in short, everything is already in the URL. The reason I made it a GET-Request is that POST-Requests require lots of additional code with a GET-Request, you just add the variables into a string, the URL.
All you have to do is to enter the needed values into the URL. An example would be:
https://api.discorddevtools.xyz/welcome-image-generator/generate.png?title=Example+Title&username=Wumpus&discriminator=1234.
The server then gets your given information (in this case is: title = "Example Title", username = "Wumpus", discriminator = "1234")
Knowing that, if you need an example image, go to https://api.discorddevtools.xyz/welcome-image-generator/generate.png and watch the magic happen yourself!
Of course there are a lot more options you can enter wayy more options than that. For a full list of options, please scroll down.
To understand how GET-Request URLs work and how you can add special characters or spaces to one, please click on the hyperlinks on this text.
A full list of parameters, their expected values and default values can be found here:
allCaps (Default: false, Type: boolean) => Display all texst in uppercase.
cacheImage (Default: true, Type: boolean) => Cache the image locally on the server for 7 days forever so the image URL has to be generated only once. Improves performance enormously when reloading!
title (Default: "Welcome!", Type: string) => The title (first line) of the image. Usually a greeting.
titleColor (Default: "ff0000", Type: string/hex) => The title text color.
text (Default: "Welcome!", Type: string) => The text (last line) of the image. Usually a great staying wish.
textColor (Default: "0000ff", Type: string/hex) => The text (last line) color.
username (Default: "Unknown", Type: string) => The username of the user that joined the server. Do not provide the discriminator in here!
usernameColor (Default: "a9a9a9", Type: string/hex) => The username text color.
discriminator (Default: "0000", Type: 4-digit-number string) => The discriminator of the user that joined the server. Please provide a string of 4 digits without the hashtag!
discriminatorColor (Default: "a9a9a9", Type: string/hex) => The discriminator text color.
borderColor (Default: "fff", Type: string/hex) => The color of the border
image (Default: "/default-image.png", Type: string/imageURL) => The image (profile picture). Please provide a direct URL to an image file.
background (Default: "/default-background.jpg", Type: string/imageURL or string:"none") => The background image. Please provide a direct URL to an image file. If you don't want a background image, set this to "none".
backgroundColor (Default: "ffff", Type: string/hex) => The color of the background. Only gets displayed when there is no background image or the background image has transparent parts in it. To remove the background image, set the option "background" to "none" as described on the previous element.
backgroundAdjustWidth (Default: true, Type: boolean) => Adjust the width of the image. The width will never be cropped.
backgroundAdjustHeight (Default: true, Type: boolean) => Adjust the height of the image. The height will be cropped if it overflows.
Direct image URLs must always end with a valid image datatype. Examples are: .png .jpg .gif. If the URL does not end with a valid image datatype ending, the code will automatically switch to the default image. This will be changed in the near future though.
Another important note is that you shouldn't add hashtags infront of your hex codes! Since GET-Request use special encoding for special symbols, including hashtags, the hashtag wouldn't get passed to the server if not done correctly. That's why you should leave it out in general!
