✨Message Templates

Customize Discord messages with your own templates

Want to customize how your Discord messages look? Message templates let you create your own message format instead of using the default layout. This is completely optional - if you don't include a template, RagnaSync uses its standard formatting.

How It Works

Templates use placeholders wrapped in double curly braces like {{player_name}} that get replaced with actual values when the message is sent. Just add a [template: ...] field to your existing script.

Basic Example

Here's how to add a custom template to a mob item drop script:

Default (no template):

[action: mob_item_drop][channel: 123456789][player_name: Marky][mob_name: Poring][mob_id: 1002][item_name: Apple][item_id: 512][rate: 25][account_id: 1][char_id: 1]

This produces the standard formatted message:

💎 Item Drop:     | Marky            | Poring           | Apple                | 0.25%

With custom template:

[action: mob_item_drop][channel: 123456789][player_name: Marky][mob_name: Poring][mob_id: 1002][item_name: Apple][item_id: 512][rate: 25][account_id: 1][char_id: 1][template: {{mob_name}} dropped {{item_name}}!]

This produces:

Poring dropped Apple!

Available Placeholders

Templates are supported on several script types. Each has its own set of placeholders you can use.

Mob Item Drop (mob_item_drop)

Placeholder	Description	Example
{{player_name}}	Character name	Marky
{{mob_name}}	Monster name	Poring
{{mob_id}}	Monster ID	1002
{{item_name}}	Dropped item name	Apple
{{item_id}}	Item ID	512
{{rate}}	Formatted drop rate	0.25%
{{rate_raw}}	Raw rate value	25

Mercenary Item Drop (merc_item_drop)

Same placeholders as Mob Item Drop - used when a player's mercenary gets the kill.

Placeholder	Description	Example
{{player_name}}	Character name (mercenary owner)	Marky
{{mob_name}}	Monster name	Poring
{{mob_id}}	Monster ID	1002
{{item_name}}	Dropped item name	Apple
{{item_id}}	Item ID	512
{{rate}}	Formatted drop rate	0.25%
{{rate_raw}}	Raw rate value	25

Homunculus Item Drop (hom_item_drop)

Same placeholders as Mob Item Drop - used when a player's homunculus gets the kill.

Placeholder	Description	Example
{{player_name}}	Character name (homunculus owner)	Marky
{{mob_name}}	Monster name	Poring
{{mob_id}}	Monster ID	1002
{{item_name}}	Dropped item name	Apple
{{item_id}}	Item ID	512
{{rate}}	Formatted drop rate	0.25%
{{rate_raw}}	Raw rate value	25

Mob Death (mob_death)

Used for MVP/boss kill announcements.

Placeholder	Description	Example
{{player_name}}	Character who killed the monster	Marky
{{mob_name}}	Monster name	Baphomet
{{mob_id}}	Monster ID	1039
{{account_id}}	Player's account ID	2000001
{{char_id}}	Player's character ID	150001

Example:

[action: mob_death][channel: 123456789][player_name: Marky][mob_name: Baphomet][mob_id: 1039][account_id: 2000001][char_id: 150001][template: :trophy: {{player_name}} defeated {{mob_name}}!]

Result: 🏆 Marky defeated Baphomet!

@Command Log (at_command)

Used for GM command audit logging.

Placeholder	Description	Example
{{name}}	Character name	AdminName
{{command}}	The @command executed	@warp prontera
{{account_id}}	Player's account ID	2000001
{{char_id}}	Player's character ID	150001
{{time}}	Time of execution	14:30:25

Example:

[action: at_command][channel: 123456789][name: AdminName][command: @warp prontera][account_id: 2000001][char_id: 150001][template: :warning: {{name}} used {{command}} at {{time}}]

Result: ⚠️ AdminName used @warp prontera at 14:30:25

Template Ideas

Here are some examples to get you started:

Simple announcement:

[template: {{player_name}} got {{item_name}} from {{mob_name}}!]

Result: Marky got Apple from Poring!

With drop rate:

[template: {{item_name}} ({{rate}}) dropped for {{player_name}}]

Result: Apple (0.25%) dropped for Marky

Minimal - item only:

[template: {{item_name}}]

Result: Apple

Discord markdown formatting:

[template: **{{player_name}}** obtained __{{item_name}}__ from *{{mob_name}}*]

Result: Marky obtained Apple from Poring

Using Emojis in Templates

You can use Discord emoji shortcodes in your templates, and RagnaSync will automatically convert them to Unicode characters. This is especially useful when your template uses code blocks, since Discord doesn't parse emoji shortcodes inside code blocks.

How It Works

Just use Discord's standard emoji shortcodes like :gem: or :fire: in your template. RagnaSync automatically converts them to their Unicode equivalents so they display correctly everywhere - even inside code blocks!

Example with code block:

[template: ```:small_orange_diamond: {{player_name}} | {{mob_name}} | {{item_name}}```]

Result: 🔸 Marky | Poring | Apple

Example without code block:

[template: :gem: {{player_name}} got {{item_name}}!]

Result: 💎 Marky got Apple!

Supported Emojis

Here are some commonly used emojis you can use in your templates:

Shortcode	Emoji	Good For
:small_orange_diamond:	🔸	Item drops, bullets
:small_blue_diamond:	🔹	Info, secondary items
:gem:	💎	Rare drops, valuable items
:star:	⭐	Achievements, highlights
:fire:	🔥	Hot items, streaks
:trophy:	🏆	MVPs, winners
:sparkles:	✨	Special events
:crown:	👑	Top players, VIPs
:tada:	🎉	Celebrations, jackpots
:gift:	🎁	Rewards, loot
:skull:	💀	Deaths, PvP
:zap:	⚡	Speed, critical hits
:crossed_swords:	⚔️	Combat, WoE
:shield:	🛡️	Defense, protection
:warning:	⚠️	Alerts, caution
:heart:	❤️	Health, love
:lock:	🔒	Secured, locked
:key:	🔑	Access, keys
:money_bag:	💰	Zeny, wealth
:scroll:	📜	Quests, items

Template Examples with Emojis

Simple drop announcement:

[template: :gem: {{player_name}} got {{item_name}}!]

Formatted table in code block:

[template: ```:small_orange_diamond: {{player_name}} | {{mob_name}} | {{item_name}} | {{rate}}```]

Card drop celebration:

[template: :tada: CARD DROP! :tada: {{player_name}} obtained {{item_name}} from {{mob_name}}!]

PvP kill message:

[template: :crossed_swords: {{player_name}} defeated the enemy and looted {{item_name}}!]

Finding the Code in Your Source

To add custom templates, you'll need to modify your server's source code. Here's how to find the right spot:

Step 1: Open Your Project

Open your rAthena or Hercules source folder in Visual Studio Code (or your preferred editor).

Step 2: Search for the Action

Use Ctrl+Shift+F (or Cmd+Shift+F on Mac) to open "Search in Files", then search for:

mob_item_drop

This will show you all the places where RagnaSync sends item drop messages.

Step 3: Find the Right Location

Look for the line that builds the RagnaSync message - it will look something like:

sprintf(buf, "[action: mob_item_drop][channel: %s][player_name: %s]...", channel_id, sd->status.name, ...);

This is where you'll add your [template: ...] field.

Step 4: Add Your Template

Append your template to the existing message. For example:

// Before
sprintf(buf, "[action: mob_item_drop][channel: %s][player_name: %s][mob_name: %s][item_name: %s]...",
    channel_id, sd->status.name, mob_name, item_name, ...);

// After - with custom template added
sprintf(buf, "[action: mob_item_drop][channel: %s][player_name: %s][mob_name: %s][item_name: %s]...[template: {{player_name}} got {{item_name}}!]",
    channel_id, sd->status.name, mob_name, item_name, ...);

Advanced: Conditional Templates

The real power comes when you use conditional logic in your server source code to send different templates based on game conditions. Since you control what gets sent to RagnaSync, you can build the template string dynamically.

Example: VIP Player Announcements

Give your VIP players a special announcement format:

// In your source code where mob drops are handled
char template[256];

if (sd->status.group_id >= 3) {
    // VIP players get a fancy template
    sprintf(template, "[template: :star: VIP %s scored a rare {{item_name}} from {{mob_name}}! ({{rate}})]", sd->status.name);
} else {
    // Regular players get standard template
    sprintf(template, "[template: {{player_name}} obtained {{item_name}}]");
}

// Append template to your ragnasync message

Example: Rare Item Highlights

Make ultra-rare drops stand out:

char template[256];

if (rate <= 10) {  // 0.10% or rarer (like cards)
    sprintf(template, "[template: :tada::tada::tada: JACKPOT! {{player_name}} got {{item_name}} from {{mob_name}}! :tada::tada::tada:]");
} else if (rate <= 100) {  // 1% or rarer
    sprintf(template, "[template: :star2: Rare drop! {{player_name}} - {{item_name}} ({{rate}})]");
} else {
    // No template = use default format
    template[0] = '\0';
}

Example: Different Templates by Map

Customize announcements based on where the drop happened:

char template[256];

if (strstr(sd->mapname, "gld_") != NULL) {
    // WoE castle drops
    sprintf(template, "[template: :crossed_swords: Castle drop: {{item_name}} to {{player_name}}]");
} else if (strstr(sd->mapname, "pvp_") != NULL) {
    // PvP map drops
    sprintf(template, "[template: :skull: {{player_name}} looted {{item_name}}]");
}

Example: Item Type-Based Templates

Different formats for different item types:

char template[256];
struct item_data *item = itemdb_search(nameid);

if (item->type == IT_CARD) {
    sprintf(template, "[template: :sparkles: CARD DROP! {{player_name}} got {{item_name}} from {{mob_name}}!]");
} else if (item->type == IT_WEAPON || item->type == IT_ARMOR) {
    sprintf(template, "[template: :crossed_swords: {{player_name}} obtained equipment: {{item_name}}]");
} else {
    sprintf(template, "[template: {{player_name}} picked up {{item_name}}]");
}

Tips

• Keep it readable - Discord has character limits, so don't make templates too long

• Test your templates - Make sure all your placeholders are spelled correctly

• Use Discord formatting - Bold (**text**), italic (*text*), underline (__text__) all work

• Placeholders are case-sensitive - Use {{player_name}} not {{Player_Name}}

• Unknown placeholders stay as-is - If you typo a placeholder like {{playr_name}}, it won't be replaced

Troubleshooting

Template not working?

• Make sure there are no spaces inside the curly braces: {{player_name}} not {{ player_name }}

• Check that your placeholder names match exactly (see the table above)

• Verify the template field is properly formatted: [template: your template here]

Message looks weird?

• Remember that Discord code blocks (` ` `) don't support formatting like bold/italic

• If you want formatting, don't wrap your template in code blocks