Recruiting

Information

The recruiting module allows players and tribes to recruit new members. When a player is looking for a tribe or a tribe is looking for a player, they can use the recruiting module to find each other. The recruiting module is a great way to find new members for your tribe or a new tribe to join.

When a player uses the recruit command the module will create a new recruit message in the recruiting channel. If a player wants to join or recruit a player they can click on the recruit button under the message. Once clicked both players will be added to a private negotiation channel where they can discuss the details of the recruitment.

Once the negotiation is complete the recruiter can complete the recruitment by clicking the complete button inside the negotiation channel. If the recruiter cancels the recruitment the negotiation channel will be deleted, the recruit message will stay available in the recruiting channel.

Command(s)

<> Required () Optional

/recruit tribe <name> <playtime> <age> <languages> <timezone> <info> - Creates a new tribe recruit in the recruiting channel.

/recruit player <name> <players> <timezone> <languages> <info> - Creates a new player recruit in the recruiting channel.

Configuration

The configuration options are located in the config.js file under the recruiting section inside the modules object.

Options

config.js → modules → recruiting

recruiting: {
    enabled: true, // Whether or not the looking for tribe command will be enabled.
    channel_id: '1148717015943626762', // The ID of the channel where the looking for tribe messages will be sent.
    category_id: '1139515434522116179', // The ID of the category where the negotiation channels will be created.
    negotiation_duration_hours: 1, // The amount of hours the negotiation channels will last.
    looking_for_tribe: {
        embed_title: 'Looking for tribe', // The title of the looking for tribe embed.
        embed_description: '{name} is looking for a tribe', // The description of the looking for tribe embed.
        embed_footer_text: '{username} is looking for a tribe', // The footer of the looking for tribe embed.
        embed_footer_icon: '', // The footer icon of the report embed.
        embed_author_name: '', // The author name of the report embed.
        embed_author_url: '', // The author url of the report embed.
        embed_author_icon: '', // The author icon of the report embed.
        embed_timestamp: true, // Whether or not the looking for tribe embed will have a timestamp.
        embed_color: '#038CB5', // The color of the looking for tribe embed.
        embed_url: '', // The url of the responder embed
        embed_fields: [
            {
                name: 'Player Name',
                value: '```{name}```',
                inline: false,
            },
            {
                name: 'Playtime',
                value: '```{playtime}```',
                inline: true,
            },
            {
                name: 'Age',
                value: '```{age}```',
                inline: true,
            },
            {
                name: 'Timezone',
                value: '```{timezone}```',
                inline: true,
            },
            {
                name: 'Language(s)',
                value: '```{languages}```',
                inline: true,
            },
            {
                name: 'Info',
                value: '```{info}```',
                inline: false,
            },
        ],
    },
    looking_for_players: {
        embed_title: 'Looking for players', // The title of the looking for players embed.
        embed_description: '{name} is looking for players', // The description of the looking for players embed.
        embed_footer_text: '{name} is looking for players', // The footer of the looking for players embed.
        embed_footer_icon: '', // The footer icon of the report embed.
        embed_author_name: '', // The author name of the report embed.
        embed_author_url: '', // The author url of the report embed.
        embed_author_icon: '', // The author icon of the report embed.
        embed_timestamp: true, // Whether or not the looking for players embed will have a timestamp.
        embed_color: '#77B255', // The color of the looking for players embed.
        embed_url: '', // The url of the responder embed
        embed_fields: [
            {
                name: 'Tribe Name',
                value: '```{name}```',
                inline: false,
            },
            {
                name: 'Tribe Size',
                value: '```{size}```',
                inline: true,
            },
            {
                name: 'Timezone',
                value: '```{timezone}```',
                inline: true,
            },
            {
                name: 'Language(s)',
                value: '```{languages}```',
                inline: true,
            },
            {
                name: 'Info',
                value: '```{info}```',
                inline: false,
            },
        ],
    },
}

Additional information

Embed fields → The embed fields are a list of fields. Each field has its own configuration options. To remove all the fields you can set the embed_fields option to an empty array ([]). To add more fields you can copy the field object and change the information and place it in the array.

Placeholders

List of placeholder for the looking_for_tribe options.

Placeholder	Description
{name}	The name of the player that is looking for a tribe
{playertime}	The playtime of the player that is looking for a tribe
{age}	The age of the player that is looking for a tribe
{timezone}	The timezone of the player that is looking for a tribe
{language}	The language of the player that is looking for a tribe
{info}	The info of the player that is looking for a tribe
{username}	The username of the player that is looking for a tribe
{userpfp}	The profile picture of the player that is looking for a tribe

List of placeholder for the looking_for_players options.

Placeholder	Description
{name}	The name of the tribe that is looking for players
{size}	The size of the tribe that is looking for players
{timezone}	The timezone of the tribe that is looking for players
{languages}	The language of the tribe that is looking for players
{info}	The info of the tribe that is looking for players
{username}	The username of the tribe that is looking for players
{userpfp}	The profile picture of the tribe that is looking for players

Translations

The translations are located in the translation.js file. The translations are prefixed with module_recruiting_.

translation.js

module_recruiting_command_name: 'recruit',
module_recruiting_command_description: 'Create a recruitment message',
module_recruiting_sub_command_option_tribe_name: 'tribe',
module_recruiting_sub_command_option_tribe_description: 'Looking for tribe',
module_recruiting_sub_command_option_players_name: 'player',
module_recruiting_sub_command_option_players_description: 'Looking for player',
module_recruiting_command_option_name_name: 'name',
module_recruiting_command_option_name_description: 'Your player or tribe name',
module_recruiting_command_option_playtime_name: 'playtime',
module_recruiting_command_option_playtime_description: 'Your playtime',
module_recruiting_command_option_age_name: 'age',
module_recruiting_command_option_age_description: 'Your age',
module_recruiting_command_option_timezone_name: 'timezone',
module_recruiting_command_option_timezone_description: 'Your timezone',
module_recruiting_command_option_languages_name: 'languages',
module_recruiting_command_option_languages_description: 'Your languages',
module_recruiting_command_option_info_name: 'info',
module_recruiting_command_option_info_description: 'Do you have any other infon you want to share?',
module_recruiting_command_option_players_name: 'players',
module_recruiting_command_option_players_description: 'The amount of players in your tribe',
module_recruiting_invalid_channel: '❌ Recruit channel not found!',
module_recruiting_accept_only_recruiter: '❌ Only the recruiter can accept this recruit',
module_recruiting_decline_only_recruiter: '❌ Only the recruiter can decline this recruit',
module_recruiting_not_found: '❌ Recruit not found! Unable to create negotiation channel.',
module_recruiting_already_negotiating: '❌ This recruit is already in negotiation.',
module_recruiting_cant_accept_own_recruit: '❌ You cant contact your own recruit!',
module_recruiting_success: '✅ Successfully created recruitment in {channel}',
module_recruiting_created_negotiation_channel: '✅ Successfully created negotiation channel {channel}',
module_recruiting_no_info_provided: 'No info provided',
module_recruiting_button_contact_player: 'Contact Player',
module_recruiting_button_contact_tribe: 'Contact Tribe',
module_recruiting_button_accept: 'Accept',
module_recruiting_button_decline: 'Decline',
module_recruiting_accept_embed_title: 'Recruitment accepted',
module_recruiting_accept_embed_description: 'The recruit has been accepted by {user}.\n\nThis channel will be deleted in {time}.',
module_recruiting_accept_embed_footer: 'Recruit ID: {id}',
module_recruiting_accept_dm_embed_title: 'Recruitment accepted',
module_recruiting_accept_dm_embed_description: 'Your recruit has been accepted by {user}. You can read the recruitment negotiation below.',
module_recruiting_accept_dm_embed_footer: 'Recruit ID: {id} • Accepted',
module_recruiting_decline_embed_title: 'Recruitment declined',
module_recruiting_decline_embed_description: 'The recruit has been declined by {user}.\n\nThis channel will be deleted in {time}.',
module_recruiting_decline_embed_footer: 'Recruit ID: {id}',
module_recruiting_decline_dm_embed_title: 'Recruitment declined',
module_recruiting_decline_dm_embed_description: 'Your recruit has been declined by {user}. You can read the recruitment negotiation below.',
module_recruiting_decline_dm_embed_footer: 'Recruit ID: {id} • Declined',
module_recruiting_negotiation_channel_topic: 'Negotiation for recruit case {id}',
module_recruiting_negotiation_embed_title: 'Negotiation Channel',
module_recruiting_negotiation_embed_description:
'This is the negotiation channel for recruit case {id}.\n\nPlease use this channel to discuss the details of the recruitment. Once you have come to an agreement, please use the buttons below to accept or decline the recruit.\n\nIf you have any questions, please contact a member of staff.',
module_recruiting_negotiation_embed_footer: 'Recruit ID: {id}',
module_recruiting_negotiation_closing_embed_title: 'Recruit Negotiation ending soon!',
module_recruiting_negotiation_closing_embed_description: 'Your recruit negotiation channel is about to be deleted in {time}.',
module_recruiting_negotiation_closing_embed_footer: 'This channel will be deleted soon',
module_recruiting_negotiation_deleting_embed_title: 'Recruit Negotiation deleting!',
module_recruiting_negotiation_deleting_embed_description: 'Your recruit negotiation channel will be deleted in {time}.',
module_recruiting_negotiation_deleting_embed_footer: 'This channel will be deleted in 10 seconds',

Showcase

Recruiting messages for Players and tribes

Negotiation channel created

Negotiation channel closing

Negotiation transcript