Formatting Reference

During the configuration of the Blind Auctioneer bot and when setting up auctions, certain fields support the use of placeholders. These placeholders allow for dynamic content insertion, making your messages more informative and personalized.

Supported Fields

Placeholders can be used in the following areas:

  • Configuration: Bid Reactions, Auction Start Message, Auction End Message

  • Setup Auction: Auction Title, Auction Description

Placeholder
Description
Usage

{USER}

Replaced with a link to the user who placed the bid

Bid Reaction messages

{TITLE}

Displays the auction title

All message types

{DESCRIPTION}

Shows the auction description

All message types

{CURRENCY}

Indicates the currency used for auction bids

All message types

{WINNER_NAME}

Replaced with a link to the auction winner

Auction End Message

{WINNER_AMOUNT}

Displays the winning bid amount

Auction End Message

{LEADERBOARD}

Generates a leaderboard of top 5 bidders

Auction End Message

Usage Examples

Bid Reaction Message

Wow! {USER} just placed a bid on the {TITLE} auction!

Auction Start Message

🚀 New Auction Alert! 🚀
"{TITLE}" has just begun!

Description: {DESCRIPTION}

Place your bids in {CURRENCY}. May the odds be ever in your favor!

Auction End Message

🏆 Auction Ended: {TITLE} 🏆

Congratulations to our winner, {WINNER_NAME}, with a winning bid of {WINNER_AMOUNT} {CURRENCY}!

Final Leaderboard:
{LEADERBOARD}

Thank you all for participating!

Formatting Tips

  1. Discord Markdown: You can use Discord's markdown syntax in your messages for additional formatting:

    • **bold**

    • *italic*

    • __underline__

    • ~~strikethrough~~

  2. Emojis: Feel free to use emojis in your messages to make them more engaging.

  3. Line Breaks: Use line breaks to structure your messages for better readability.

  4. Placeholder Flexibility: Placeholders can be used multiple times in a single message if needed.

  5. Custom Text: Mix placeholders with your own text to create personalized and informative messages.

  6. Additional Formatting: Messages can be additionally formatted by using special Discord's markdown subset to mention users or channels, use a specific role(s), use custom emojis, format a specific time, etc:

    • <#CHANNEL_ID> (link a specific channel)

    • <@&ROLE_ID> (use specific role)

    • <:NAME:ID> (custom emoji)

    • </NAME:COMMAND_ID> (link to a slash command)

Best Practices

  1. Test Your Messages: After setting up custom messages, run a test auction to ensure all placeholders are working as expected.

  2. Keep It Concise: While customization is great, remember to keep messages clear and not too lengthy.

  3. Consistency: Try to maintain a consistent style across all your auction messages for a cohesive user experience.

  4. Accessibility: Ensure your formatting choices (like color mentions) are accessible to all users.

  5. Update Regularly: Periodically review and update your message formats to keep them fresh and engaging.

Remember, effective use of these placeholders and formatting options can significantly enhance the user experience in your auctions. Experiment with different combinations to find what works best for your community!

Last updated