Public landing page live map; docs for Discord, live embeds, email

This commit is contained in:
Claude committed 2026-10-01 01:52:54 +00:00
1 parent cd985a1a7b
commit aae0a5a5ff
11 files changed
+195 -10

No files matched your search

+39
View File
@@ -0,0 +1,39 @@
# Discord messages, live embeds and emails
## Announcements (Admin panel → Discord → Announcements)
Three messages are posted by the panel's webhook (Settings → Discord → webhook): **Achievement unlocked**, **New player** and **New guild**. Each one is fully editable, with a live preview built the way Discord will show it:
- Message text above the box (mentions such as `<@&roleid>` work there), title and link, description, colour, a small picture on the right, a big picture at the bottom, author and footer (with icons), the time, and any number of side-by-side or full-width fields.
- The sender's name and picture.
- **Placeholders** such as `{player}`, `{avatar}`, `{achievement}`, `{achievement_description}`, `{xp}`, `{level}`, `{rank_title}`, `{guild_line}` (achievements), `{members_total}` (new players), `{guild}`, `{leader}`, `{members}`, `{claims}` (guilds) and `{server_name}`, `{time}` everywhere. Click a placeholder to insert it where you are typing. Unknown ones stay as typed so mistakes are easy to spot.
- Player names are cleaned so they can't ping anyone or break the formatting.
Switch each message on or off, and press **Save & send a sample** to see it in your channel.
## Live embeds (Discord → Live embeds)
Four boards that the panel posts once and then **edits in place**, so the channel never fills up:
| Embed | Shows | Rows are set by |
|---|---|---|
| **Server status** | Every server: online, players, TPS, version | the line template |
| **Active guilds** | Top guilds with level, members, land and leader | rows shown |
| **Player leaderboard** | Top players by playtime, level, kills or blocks | ranked by, rows shown |
| **Richest players** | Top balances of one server economy | economy of, rows shown |
Every embed has the same editor as the announcements, plus a **line for each row** (for example `{rank}. **{player}** — {value}`) that fills `{rows}` in the description, an update interval (1 minute to 1 hour), and an optional **own webhook** so each board can live in its own channel. If someone deletes the message, the next update posts a fresh one; **Post as new message** forces it.
## Emails (Admin panel → Emails)
Set up the sender and Resend key under **Settings → Connections** first. Then:
1. Write a **template**: subject and message with placeholders (`{player}`, `{level}`, `{rank_title}`, `{guild}`, `{brand}`, `{panel_url}`…). Simple formatting turns into a branded HTML email in your launcher colours: `# Heading`, `**bold**`, `- list`, `[link](https://…)`, `[button: Label](https://…)`.
2. Check the live **preview**, and **send a test** to yourself.
3. **Send** to everyone with an email, a group, or chosen players. The panel shows how many will receive it first, sends them one by one in the background, and keeps a log with failures and their reasons.
Every email has an unsubscribe link; players who use it are skipped by later emails. Mark a message as an **account notice** to reach everyone regardless, without the unsubscribe link: use that only for things about their account.
## Live map on the landing page
In **Landing page**, add a **Live map** section. Choose the server (or leave it at the first server with a map), the height, and what visitors may see: guild land and places are on by default, **live player positions are off** (they let strangers find players). Visitors can pan and zoom the same map your players see in the launcher; removing the section closes the public map again.