Profiles
Introduction
The FroggeBot Profiles module is its premier feature. It allows users to create
and manage their own character profiles, which can be customized with a variety of
options.
Profiles are a great way to express yourself and share your characters with others.
This page is meant as an informational breakdown of the Profiles Module. Check out the Profiles Tutorial if you're looking for a guide on how to create your first profile!
Preparation
First off, ensure that you have FroggeBot installed in your server.
Currently, profiles are only available to venue staff members that have been hired into
FroggeBot using the
/admin hireSlash Command! command.
If you're not a staff member, you can still follow along with this tutorial, but you won't
be able to create a profile until you've been hired.
Hiring Staff
To learn more about the hiring process, check out the hiring tutorial and the staffing module.
Getting to Your Profile
Profiles in FroggeBot are each attributed to a character. This allows individual users to
create multiple profiles for different characters on the same Discord account.
In order to access the profile creation menu, we first need to navigate to the character selection menu. To do this, use the /staff profileSlash Command! command.
Character Menu
The character menu is where you can view all the characters that are currently associated with your Discord account. If you haven't created any characters yet, this menu will only show the default character created by management when you were hired.
Emoji Key
The character menu uses emojis to represent the different profile states each character is in. Here's a quick breakdown of what each emoji means:
: The character's profile is incomplete per the venue's profile requirements.
: The character's profile has not been posted to a channel yet.- : The character's profile has been completed per the venue's profile requirements.
: The character's profile has been posted to a channel.
Adding a New Character
To add a new character to your account, click on the button. You'll be prompted to enter the character's name.
Restrictions
Max Name Length: 40 characters
Viewing a Character's Profile
To view a character's profile, click the button on the character menu. This will present a select menu with all the characters you've created.
Deleting a Character
To delete a character, click the button on the character menu. You'll be prompted to confirm the deletion.
Warning
Deleting a character is permanent and cannot be undone. Make sure you're certain before proceeding.
Please note that, as a staff member, you must have at least one character associated with your account at all times. If you only have one character and attempt to delete it, your request will be rejected.
Profile Menu
Once you've selected a character, you'll be taken to the profile menu. This is the top-level interface for managing your character's profile data.
You'll note there are two rows of buttons on this menu, each with a different function. Let's break down what each button does:
The first row, containing Main Info & Details, At A Glance Section, Personality Elements, and Add/Remove Images are all sections of the profile that can be filled in with information about your character.
The second row, containing Post/Update Profile, Profile Progress,
and Preview Profile are all functions related to the profile's status and visibility. We'll go into more
detail about each of these sections in the Profile Functions section.
Profile Sections
A profile is broken down into several sections, each of which can be filled in with information about your character. The goal is to get the best looking profile possible with minimal effort.
Main Info and Details
Clicking the button will take you to the main information section of the profile.
The buttons on this menu are as follows:
Make sure to review each tab below to ensure that the profile is set up correctly.
The name of your character. This is the name that will be displayed on the profile.
Restrictions
Max Length: 40 characters
A custom URL that underlines the character's name. This can be used to link to a variety of things, such as a character's Twitter account or a Carrd page.
Restrictions
Max Length: 250 characters
The color that will be used as an accent on the left side of the Profile and About Me embeds.
Color Picker
This must be a valid HEX color code. Please consult the Google Color Picker for assistance.
A list of the character's RP jobs. This can be used to list the character's in-game occupation or any favorite combat jobs they may have.
Restrictions
Max Length: 20 characters per job
A list of the character's freelance rates. This can be used to list the character's rates for various services they may offer.
Restrictions
Max Length: 250 characters
At A Glance Section
Clicking the button will navigate to the At A Glance portion of the profile.
The buttons on this menu are as follows:
Make sure to review each tab below to ensure that the profile is set up correctly.
This button allows you to set any of the selectable races/clans that are available in FFXIV. Additionally, you may set a custom value for either (or both) of the fields.
Restrictions
Max Length: 250 characters
This button allows the user to set their character's Gender and Pronouns to any of the 'mainstream' genders and as many of the commonly used pronouns as they want. Additionally, you may set a custom value for gender.
Restrictions
Max Length: 250 characters
This button allows the user to set their character's sexual orientation to any of a variety of common orientations Additionally, you may set a custom value for orientation.
Restrictions
Max Length: 40 characters
This button allows the user to set their character's height in both feet and inches OR centimeters.
Format
Ensure your entry complies with one of the following formats:
5'10"6ft 2in180cm
This button allows the user to set their character's age in years. You can also set a plain text value for age.
Restrictions
Max Length: 30 characters
This button allows the user to set their character's Mare ID. This is a unique identifier that can be used to share your character's modded look between friends.
Restrictions
Max Length: 30 characters
This button allows the user to set their character's Home World. This is the server that your character is associated with in FFXIV.
It first presents a selector to choose the data center, then a selector to choose the server.
Profile Personality
Click on the button to navigate to the Personality fields of the profile.
The buttons on this menu are as follows:
This button allows the user to set their character's likes. This should be a comma-separated list of things that your character enjoys.
Restrictions
Max Length: 300 characters
In contrast to the likes field, this button allows the user to set their character's dislikes. This should be at least as long (or shorter than) the likes field for formatting reasons.
Restrictions
Max Length: 300 characters
The personality field is a freeform text field that allows the user to describe their character's personality.
Restrictions
Max Length: 300 characters
In contrast to the personality field, the About Me field is a freeform text field that allows the user to describe their character in more detail. This is typically used for a character's backstory or other detailed information.
The About Me section appears in its own separate embed after the main profile body and will display the user's custom URL if one is set.
Restrictions
Max Length: 3000 characters
Add/Remove Images
Click on the button to navigate to the image management section of the profile builder.
All prompts for image management require the user to upload an image to the discord channel in which they are interacting with the bot. The bot will then process and cache the image and update the profile accordingly.
The buttons on this menu are as follows:
From the manage thumbnail menu, you can upload a new image, remove the current image, or cancel the operation.
The thumbnail image is the image that will be displayed in the upper-right the profile embed. This should ideally be a square image or one in portrait orientation.
Restrictions
- Max File Size:
8MB - File Types:
PNG/APNG,JPG/JPEG,WEBP, &GIF.
From the manage main image menu, you can upload a new image, remove the current image, or cancel the operation.
The main image is the image that will be displayed in the bottom-center the profile embed. This should ideally be a landscape image.
Restrictions
- Max File Size:
8MB - File Types:
PNG/APNG,JPG/JPEG,WEBP, &GIF.
To simply add an additional image and move on, click the button. Upload the image to the channel and the bot will process it.
Restrictions
- Max File Size:
8MB - File Types:
PNG/APNG,JPG/JPEG,WEBP, &GIF.
For any further additional image management, click the button. This will present a paginator of all the additional images currently associated with the profile.
The additional images menu allows you to remove or change the caption for all additional images associated with the profile.
Profile Functions
The profile functions are a set of actions you can perform to assist in managing your character's profile.
Post/Update Profile
Upon clicking the button the application will first check to ensure that the profile meets the venue's profile requirements. If the profile is incomplete, the application will prompt you to complete the profile before proceeding.
Incomplete Profile Error
If the profile is incomplete, the application will present an error and prevent you from posting the profile.
Be sure to review the "How To Fix?" column of the error message to see what fields need to be filled
in, and where.
In the event that your venue has configured more than one possible channel to post profiles to, the application will present a select menu to choose the channel where to post the profile.
Profile Progress
Clicking the button will present a progress dialog that shows how complete the profile is. This is a great way to see at a glance what fields are missing or incomplete.
Administering Profiles
This section is intended to document the administrative side of the Profiles module. This includes setting up profile requirements, configuring post channels, and manual profile management.
Profile Requirements
In order to post a character's profile to a channel, it must meet the venue's profile requirements. These requirements are set by the venue's management and can be configured differently from venue to venue.
To access the profile requirements, use the /admin profilesSlash Command! command. This will present a main configuration menu where you can access the list of all profile requirements.
Each button under the message can be used to toggle the requirement on or off. When a requirement is toggled on, the application will check to ensure that the requirement is met before allowing a profile to be posted.
Configuring Profile Post Channels
Once the requirements have been set, the next step is to configure the channels where profiles can be posted. This is done, once again, using the /admin profilesSlash Command! command and by selecting the button.
The venue's administrator is able to set groups of channels in which specific roles may post their profiles. This is useful for venues that have multiple roleplay channels or other channels where profiles may be posted.
To add a new posting channel, click the button.
In order to link a set of channels to a given role, click the button and follow the prompts.