Auctions

Information

Auctions is a module that allows players to auction their items and dinos. When a player auctions an item or dino the module will create a new auction in the auctions channel.

Once the auction is created players can bid on the auction by clicking on the button under the auction embed. Everytime someone places a bid the auction message will be updated with the new bid listing them in a list inside the embed.

When the auction ends the auction message will be updated and the auction will be closed. Once ended the module will create a negotiation channel where the seller has to select a winner. Once the winner is selected the module will add the winner to the negotiation channel so both players can negotiate the trade.

Once the trade is completed the seller can close the negotiation channel, this will remove the channel and the auction message to keep the auctions channel clean. If the seller does not close the negotiation channel the module will close it after X amount of hours (configurable).

Command(s)

<> Required () Optional

/auction <item> <amount> <price> <map> (image) - Creates an auction for the specified item inside the auctions channel.

Configuration

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

Options

config.js → modules → auction

auction: {
    enabled: true, // Whether or not the auction module will be enabled.
    channel_id: '1145022237708128266', // The ID of the channel where the auction messages will be sent.
    category_id: '1139515434522116179', // The ID of the category where the negotiation channels will be created.
    auction_duration_hours: 24, // The amount of hours the auction will last.
    negotiation_duration_hours: 1, // The amount of hours the negotiation channels will last.
    embed_title: 'Active Auction', // The title of the active auction embed.
    embed_description: 'New auction has started by {user}', // The description of the active auction embed.
    embed_footer_text: 'Auction by {username}', // The footer of the active auction 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_color: '#77B255', // The color of the active auction embed.
    embed_timestamp: true, // Whether or not the active auction embed will have a timestamp.
    embed_url: '', // The url of the responder embed
    embed_fields: [
    // To delete all fields just leave the array empty. []
        {
            name: 'Ends At', // The name of the field.
            value: '{date} | {time}',
            inline: false, // Whether or not the field will be inline.
        },
        {
            name: 'Item', // The name of the field.
            value: '```{item}```', // The value of the field.
            inline: false, // Whether or not the field will be inline.
        },
        {
            name: 'Amount', // The name of the field.
            value: '```{amount}```', // The value of the field.
            inline: true, // Whether or not the field will be inline.
        },
        {
            name: 'Starting Price', // The name of the field.
            value: '```{price}```', // The value of the field.
            inline: true, // Whether or not the field will be inline.
        },
        {
            name: 'Map', // The name of the field.
            value: '```{map}```', // The value of the field.
            inline: true, // Whether or not the field will be inline.
        },
        {
            name: 'Bidders', // The name of the field.
            value: '```{bidders}```', // The value of the field.
            inline: false, // Whether or not the field will be inline.
        },
    ],
}

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

This is a list of all the placeholders that you can use in the configuration shown above.

Placeholder	Description
{user}	The user who created the sale.
{username}	The username of the user who created the sale.
{userpfp}	The profile picture of the user who created the sale.
{item}	The item that is being sold.
{amount}	The amount of items that are being sold.
{price}	The price of the item.
{map}	The map where the item is located.
{bidders}	The list of bidders.
{date}	The auction end date. (Thursday, August 24, 2023 2:20 PM)
{time}	The relative end time. (in 5 days)

Translations

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

translation.js

module_auction_command_name: 'auction',
module_auction_command_description: 'Create a new auction',
module_auction_command_option_item_name: 'item',
module_auction_command_option_item_description: 'The item or dino that is being auctioned',
module_auction_command_option_amount_name: 'amount',
module_auction_command_option_amount_description: 'The amount of the item or dino that is being auctioned',
module_auction_command_option_price_name: 'price',
module_auction_command_option_price_description: 'The starting price of the item or dino that is being auctioned',
module_auction_command_option_map_name: 'map',
module_auction_command_option_map_description: 'The map where the item or dino that is being auctioned is located',
module_auction_command_option_image_name: 'image',
module_auction_command_option_image_description: 'The image of the item or dino that is being auctioned',
module_auction_invalid_image: '❌ Invalid image url. Provide a direct link to the image.',
module_auction_invalid_channel: '❌ Auction channel not found!',
module_auction_no_bidders_yet: 'No bidders yet',
module_auction_button_place_bid: 'Place Bid',
module_auction_success: '✅ Successfully created auction in {channel}',
module_auction_modal_title: 'Place a bid',
module_auction_modal_field_name: 'Your bid',
module_auction_cant_bid_own_auction: '❌ You cant bid on your own auction!',
module_auction_finish_only_owner: '❌ Only the owner of the auction can mark the auction as finished',
module_auction_finish_embed_title: 'Auction finished',
module_auction_finish_embed_description: 'The auction has been finished by {user}.\n\nThis channel will be deleted in {time}.',
module_auction_finish_embed_footer: 'Auction ID: {id} • Finished',
module_auction_finish_dm_embed_title: 'Auction finished',
module_auction_finish_dm_embed_description: 'Your auction has been finished by {user}. You can read the auction negotiation below.',
module_auction_finish_dm_embed_footer: 'Auction ID: {id} • Finished',
module_auction_negotiation_channel_topic: 'Negotiation for auction case {id}',
module_auction_negotiation_button_finish: 'Finish Negotiation',
module_auction_negotiation_button_cancel: 'Cancel auction',
module_auction_negotiation_select_winner: 'Select a Winner',
module_auction_negotiation_winner_embed_title: 'Auction winner',
module_auction_negotiation_winner_embed_description: 'The winner of the auction is {user}.\n\nYou can now both negotiate the auction, once you are done, click the finish button above to finish the auction.',
module_auction_negotiation_winner_embed_footer: 'Auction ID: {id} • Winner Selected',
module_auction_negotiation_only_author_can_cancel: '❌ Only the author of the auction can cancel the auction',
module_auction_negotiation_cancelled_embed_title: 'Auction cancelled',
module_auction_negotiation_cancelled_embed_description: 'The auction has been cancelled by {user}.\n\nThis channel will be deleted in {time}.',
module_auction_negotiation_cancelled_embed_footer: 'Auction ID: {id} • Cancelled',
module_auction_negotiation_cancelled_dm_embed_title: 'Auction cancelled',
module_auction_negotiation_cancelled_dm_embed_description: 'Your auction has been cancelled by {user}.',
module_auction_negotiation_cancelled_dm_embed_footer: 'Auction ID: {id} • Cancelled',
module_auction_negotiation_only_author_can_select_winner: '❌ Only the author of the auction can select a winner',
module_auction_negotiation_already_selected_winner: '❌ A winner has already been selected for this auction',
module_auction_negotiation_invalid_channel: '❌ Invalid channel type, make sure the channel is a normal text channel.',
module_auction_negotiation_select_winner_embed_title: 'Select a new winner',
module_auction_negotiation_select_winner_embed_description: 'The auction winner has been removed by {user}.\n\nYou can now select a new winner for the auction below.',
module_auction_negotiation_select_winner_embed_footer: 'Auction ID: {id} • Winner Removed',
module_auction_negotiation_selected_invalid: '❌ Failed to find the winner or member left the server.',
module_auction_negotiation_new_winner_embed_title: 'New Auction winner',
module_auction_negotiation_new_winner_embed_description: 'The new winner of the auction is {user}.\n\nYou can now both negotiate the auction, once you are done, click the finish button above to finish the auction.',
module_auction_negotiation_new_winner_embed_footer: 'Auction ID: {id} • Winner Selected',
module_auction_negotiation_embed_title: 'Auction Negotiation',
module_auction_negotiation_embed_description: 'Your auction has ended! Now its time to negotiate with the winner, you first need to select the winner below.',
module_auction_negotiation_embed_field_title: 'Auction Information',
module_auction_negotiation_embed_field_value: 'Item: `{item}`\nAmount: `{amount}`\nPrice: `{price}`\nMap: `{map}`\nImage: {image}',
module_auction_negotiation_deleting_embed_title: 'Auction Negotiation deleting!',
module_auction_negotiation_deleting_embed_description: 'Your auction negotiation channel will be deleted in {time}.',
module_auction_negotiation_deleting_embed_footer: 'This channel will be deleted in 10 seconds',
module_auction_negotiation_closing_embed_title: 'Auction Negotiation ending soon!',
module_auction_negotiation_closing_embed_description: 'Your auction negotiation channel is about to be deleted in {time}.',
module_auction_negotiation_closing_embed_footer: 'This channel will be deleted soon',
module_auction_ended_embed_title: 'Auction ended',
module_auction_ended_embed_description: 'The auction has ended!',
module_auction_no_bidders: 'No bidders',
module_auction_bid: 'Bid',

Showcase

Auction created by player

Auction ended and negotiation channel created