# Create Developer Application
Source: https://docs.seraph.si/api-reference/admin/create-developer-application
https://stash.seraph.si/json post /admin/developer/applications
Submits a new developer application with details like owner, name, description, and grants.
# Fetch API Logs for a Player
Source: https://docs.seraph.si/api-reference/admin/fetch-api-logs-for-a-player
https://stash.seraph.si/json get /admin/logs/api/{player}
Retrieves recent API game logs for a specified player UUID, with optional time interval filtering.
# Get database statistics
Source: https://docs.seraph.si/api-reference/admin/get-database-statistics
https://stash.seraph.si/json get /admin/database/stats
Retrieves table names and estimated row counts for tables in the 'user_info' namespace. Requires AdminDatabaseStats permissions.
# Add Player
Source: https://docs.seraph.si/api-reference/api/add-player
https://api.seraph.si/json post /addsniper
Add a sniper to the Database
# Blacklist
Source: https://docs.seraph.si/api-reference/api/blacklist
https://api.seraph.si/json get /{player}/blacklist
Fetch player blacklist information from seraph
# Cubelify Blacklist Information
Source: https://docs.seraph.si/api-reference/api/cubelify-blacklist-information
https://api.seraph.si/json get /cubelify/blacklist/{uuid}
Fetches player blacklist information formatted for Cubelify integration. This endpoint supports both authenticated and public access.
# Cubelify Blacklist Information
Source: https://docs.seraph.si/api-reference/api/cubelify-blacklist-information-1
https://api.seraph.si/json get /{uuid}/cubelify/blacklist
Fetches player blacklist information formatted for Cubelify integration. This endpoint supports both authenticated and public access.
# Safelist
Source: https://docs.seraph.si/api-reference/api/safelist
https://api.seraph.si/json get /{player}/safelist
Add a player to your personal safelist
# Refresh an authentication token
Source: https://docs.seraph.si/api-reference/auth/refresh-an-authentication-token
https://stash.seraph.si/json post /auth/refresh
Refreshes an existing authentication token using a refresh token.
# Get Lobby One Chat (Semi-Live)
Source: https://docs.seraph.si/api-reference/chat/get-lobby-one-chat-semi-live
https://stash.seraph.si/json get /chat/lobby-one
Fetches recent chat messages from 'bedwarslobby1' within the last hour, providing a semi-live view.
# Get Player Chat History
Source: https://docs.seraph.si/api-reference/chat/get-player-chat-history
https://stash.seraph.si/json get /chat/{player}
Fetches the entire chat history for a specific player identified by their UUID.
# Post Chat Messages
Source: https://docs.seraph.si/api-reference/chat/post-chat-messages
https://stash.seraph.si/json post /chat
Submits a batch of player chat messages to be stored.
# Get Cubelify Client Information
Source: https://docs.seraph.si/api-reference/client/get-cubelify-client-information
https://stash.seraph.si/json get /cubelify/{player}/client
Retrieves Cubelify client information for a given player UUID. This includes details like client ID, name, online status, and status message.
# Fetch User Profile
Source: https://docs.seraph.si/api-reference/discord/fetch-user-profile
https://stash.seraph.si/json post /discord/user/{snowflake}
Convert a snowflake to a user profile
# Fetch User Profile and Linked Accounts
Source: https://docs.seraph.si/api-reference/discord/fetch-user-profile-and-linked-accounts
https://stash.seraph.si/json get /discord/user/{snowflake}/profile
Retrieves a user's Discord profile information and all associated linked Minecraft accounts.
# Initiate and Complete Discord OAuth Flow
Source: https://docs.seraph.si/api-reference/discord/initiate-and-complete-discord-oauth-flow
https://stash.seraph.si/json get /discord/oauth
Handles the Discord OAuth callback to exchange an authorization code for user access and refresh tokens. Upon successful authentication, returns the token details.
# Link Discord and Minecraft Accounts
Source: https://docs.seraph.si/api-reference/discord/link-discord-and-minecraft-accounts
https://stash.seraph.si/json post /discord/user/link
Links a Discord user's snowflake ID to a Minecraft UUID. Supports setting a primary account and updates existing links.
# Log Discord Bot Error
Source: https://docs.seraph.si/api-reference/discord/log-discord-bot-error
https://stash.seraph.si/json post /discord/logging/error
Logs error details from the Discord bot for a specific user and interaction.
# Log Discord Bot Interaction
Source: https://docs.seraph.si/api-reference/discord/log-discord-bot-interaction
https://stash.seraph.si/json post /discord/logging/interaction
Logs user and interaction details from the Discord bot, including optional server information.
# Lookup Linked Accounts
Source: https://docs.seraph.si/api-reference/discord/lookup-linked-accounts
https://stash.seraph.si/json get /discord/user/{snowflake}/lookup
Retrieves all Minecraft accounts linked to a Discord snowflake ID or all Discord accounts linked to a Minecraft UUID.
# Set Primary Minecraft Account
Source: https://docs.seraph.si/api-reference/discord/set-primary-minecraft-account
https://stash.seraph.si/json patch /discord/user/{snowflake}/primary/{player}
Sets a specific Minecraft UUID as the primary linked account for a given Discord user.
# Update User Profile
Source: https://docs.seraph.si/api-reference/discord/update-user-profile
https://stash.seraph.si/json patch /discord/user/{snowflake}/profile
Updates the profile information for a given Discord user, such as their locale.
# Fetch Hypixel Guild Data
Source: https://docs.seraph.si/api-reference/hypixel/fetch-hypixel-guild-data
https://stash.seraph.si/json get /hypixel/guild/{player}
Retrieves Hypixel guild data for a given player UUID. The data is cached for improved performance.
# Get Paged Player Leaderboard
Source: https://docs.seraph.si/api-reference/leaderboards/get-paged-player-leaderboard
https://stash.seraph.si/json get /leaderboards/{lbtype}/{pageid}
Retrieves a specific page of player leaderboard data for various game statistics (e.g., Bedwars level, final kills, wins).
# Post Paged Player Leaderboard (Potentially for advanced queries)
Source: https://docs.seraph.si/api-reference/leaderboards/post-paged-player-leaderboard-potentially-for-advanced-queries
https://stash.seraph.si/json post /leaderboards/{lbtype}
Retrieves a specific page of player leaderboard data for various game statistics, allowing for potential advanced queries via POST body.
# Process Minecraft Chat Prompt
Source: https://docs.seraph.si/api-reference/minecraft/process-minecraft-chat-prompt
https://stash.seraph.si/json post /minecraft/chat
Accepts a chat prompt and processes it using OpenAI. The function echoes the received prompt back as a success confirmation.
# Fetch Minecraft Player Data
Source: https://docs.seraph.si/api-reference/mojang/fetch-minecraft-player-data
https://stash.seraph.si/json get /mojang/{player}
Retrieves a Minecraft player's UUID by username or username by UUID. The function utilizes a caching mechanism for performance and stores fetched player data in the database.
# Get All Player Ping History
Source: https://docs.seraph.si/api-reference/ping/get-all-player-ping-history
https://stash.seraph.si/json get /ping/{player}
Fetches comprehensive ping data for a specific player, including daily statistics (max, min, average) and historical records.
# Get Player Recent Ping History (Last 7 Days)
Source: https://docs.seraph.si/api-reference/ping/get-player-recent-ping-history-last-7-days
https://stash.seraph.si/json get /ping/today/{player}
Fetches detailed ping data for a specific player over the last 7 days, including daily statistics and historical records.
# Post Player Pings
Source: https://docs.seraph.si/api-reference/ping/post-player-pings
https://stash.seraph.si/json post /ping
Submits a batch of player ping data to be stored.
# Fetch Hypixel Player Data
Source: https://docs.seraph.si/api-reference/player/fetch-hypixel-player-data
https://stash.seraph.si/json get /player/{player}
Retrieves Hypixel player data, caches it, and updates relevant database entries.
# Fetch Hypixel Player Data for Bot Backend
Source: https://docs.seraph.si/api-reference/player/fetch-hypixel-player-data-for-bot-backend
https://stash.seraph.si/json get /hypixel/player/{player}/bot
Retrieves Hypixel player data specifically for the Bot backend, with caching and database updates. Requires specific permissions.
# Get Player Achievements
Source: https://docs.seraph.si/api-reference/player/get-player-achievements
https://stash.seraph.si/json get /player/{player}/achievements
Retrieves detailed achievement data for a specific player, including one-time, tiered, and legacy achievements, along with meta-information about completed points.
# Player Lookup
Source: https://docs.seraph.si/api-reference/player/player-lookup
https://stash.seraph.si/json post /player/lookup
Retrieves player data based on game mode and applied filters.
# Search for player names
Source: https://docs.seraph.si/api-reference/player/search-for-player-names
https://stash.seraph.si/json post /discord/search
Searches for player names in the database that match the provided query. The query should be a string up to 16 characters long. Results are cached and limited to 25 items.
# Update Hypixel Player Data
Source: https://docs.seraph.si/api-reference/player/update-hypixel-player-data
https://stash.seraph.si/json get /hypixel/skywars/{player}
Fetches and updates Hypixel player data for the updater service, with caching and database updates.
# Get Ranked Bedwars User Data
Source: https://docs.seraph.si/api-reference/ranked-bedwars/get-ranked-bedwars-user-data
https://stash.seraph.si/json get /rankedbedwars/{player}
Retrieves ranked Bedwars data (Elo) for a specific player by UUID, utilising a cache.
# Get skin
Source: https://docs.seraph.si/api-reference/skin/get-skin
https://api.seraph.si/json get /skin
Retrieves a random Minecraft skin as a PNG image.
# Get player's Skyblock Profiles
Source: https://docs.seraph.si/api-reference/skyblock/get-players-skyblock-profiles
https://stash.seraph.si/json get /skyblock/profiles/{player}
Retrieves Hypixel Skyblock profiles for a given player UUID. Data is cached for improved performance.
# Get player's teammates
Source: https://docs.seraph.si/api-reference/teammate/get-players-teammates
https://stash.seraph.si/json get /teammates/{player}
Retrieves a list of teammates for a specified player UUID, optionally including friends data if a valid API key is provided. Data is cached for performance.
# Get websitefetch tags
Source: https://docs.seraph.si/api-reference/website/get-websitefetch-tags
https://api.seraph.si/json get /website/fetch-tags
Retrieves all tags associated with the current user.
# Get websiteuser
Source: https://docs.seraph.si/api-reference/website/get-websiteuser
https://api.seraph.si/json get /website/user
Retrieves general user information for the website portal.
# Patch websiteupdate tag
Source: https://docs.seraph.si/api-reference/website/patch-websiteupdate-tag
https://api.seraph.si/json patch /website/update-tag
Updates an existing user tag or creates a new one for the current user.
# Configuration
Source: https://docs.seraph.si/docs/configuration
Where Seraph stores its files and how to manage your settings.
Seraph keeps a single per-user data folder shared across every supported client (Lunar, Badlion, Forge). Switch clients and your settings come with you.
## File location
| OS | Path |
| ------- | --------------------------------------------------------------- |
| Windows | `%AppData%\Seraph\` |
| macOS | `~/.Seraph/` |
| Linux | `$XDG_DATA_HOME/Seraph/` (defaults to `~/.local/share/Seraph/`) |
Inside:
* `config.json`, your settings.
* `token.json`, Seraph auth token. **Don't share this.**
* `nicknames.json`, saved nick to real-name mappings (only entries you marked permanent).
Blacklist data isn't stored locally, it lives on the Seraph backend and is fetched on demand.
## In-game settings menu
Run `/seraph config` (or `/sconfig`). The menu has six tabs: API, Overlay, Anticheat, Misc, Tags, Experiments.
### Search
The search bar at the top indexes every entry from every tab. Type a keyword (`fkdr`, `cape`, `flag`, `auto gg`) and it'll find every matching setting.
### Conditional entries
Some settings only show in their tab when a parent toggle is on (e.g. the alert sound only appears when alerts are enabled). Search ignores those gates and shows them anyway, with a note explaining what to enable first.
## Manual edits
Don't edit `config.json` while the game is running, Seraph rewrites the file when you change settings, so your edits will be lost.
You can edit `config.json` directly while the game is closed. Seraph picks up changes on the next launch.
If you imported an older config and Seraph complains it's out of date:
```
/seraph migrateconfig
```
## Reset to defaults
Delete `config.json` while the game is closed. On next launch, Seraph rewrites it with defaults.
## Sharing configs
Make sure to remove your API Keys saved in the configuration file.
`config.json` is portable. Copy it to a friend (or a different machine) and they get your exact setup.
**Don't include `token.json`**: it's bound to your account and only works for you.
# Anticheat
Source: https://docs.seraph.si/docs/features/anticheat
Settings on the Anticheat tab.
The Anticheat tab has five entries. Each is a single toggle, except for **Flag Sound** which is a sound picker.
## Settings
* **Auto Block**: toggle.
* **Legit Scaffold**: toggle.
* **No Break Delay**: toggle.
* **Flag Play Sound**: toggle.
* **Flag Sound**: sound picker. Only visible when **Flag Play Sound** is enabled.
The UI doesn't ship descriptions for these entries, so the labels above are all you get on screen.
## Reviewing flags
`/seraph check ` (alias `/sc`) shows whether a player is on your blacklist. Manual entries can be added with `/seraph blacklist ...` (alias `/sblacklist`).
# Commands
Source: https://docs.seraph.si/docs/features/commands
Every chat command Seraph registers.
All Seraph commands are case-insensitive, `/seraph`, `/Seraph`, `/SERAPH` all work. Most have a short alias.
## Discoverability
```
/seraph help [page]
```
Lists every visible command with its description, paginated. Hidden commands (debug, dev tools) don't show but still work and tab-complete.
## Stats & lookup
| Command | Alias | What it does |
| ------------------------------- | ---------- | ------------------------------------------------------ |
| `/seraph stats [mode]` | `/ss` | Print Hypixel stats for a player. Mode filters output. |
| `/seraph check ` | `/sc` | Check if a player is blacklisted. |
| `/seraph apikey` | `/sapikey` | Open the Hypixel Developer Dashboard. |
## Overlay management
| Command | Alias | What it does |
| ------------------------- | ---------- | ------------------------------------- |
| `/seraph add ` | `/sadd` | Add a player to the overlay manually. |
| `/seraph remove ` | `/sremove` | Remove a manually-added player. |
| `/seraph clear` | `/sclear` | Clear all manually-added players. |
## Blacklist
| Command | Alias | What it does |
| ------------------------------------------------------ | ------------- | ------------------------------ |
| `/seraph blacklist ...` | `/sblacklist` | Add a player to the blacklist. |
## Nicknames
| Command | Alias | What it does |
| -------------------------------------------- | -------- | ------------------------------------------------------------------- |
| `/seraph remap [permanent?]` | `/snick` | Map a nick to a real player. `permanent` saves to `nicknames.json`. |
## Settings
| Command | Alias | What it does |
| ----------------------- | ---------- | ------------------------------- |
| `/seraph config` | `/sconfig` | Open the in-game settings menu. |
| `/seraph migrateconfig` | | Migrate a legacy config file. |
## No default keybind
There's no keybind for opening the menu, it's command-only. Use `/seraph config` or the alias `/sconfig`.
# Experiments
Source: https://docs.seraph.si/docs/features/experiments
Settings on the Experiments tab.
The Experiments tab holds toggles for features still being tested.
## Settings
### Player Alert Implementation
Toggle. Enable or disable the player alert implementation experimental feature.
### No Break Delay Implementation
Toggle. Enable or disable the no break delay implementation experimental feature.
# Misc utilities
Source: https://docs.seraph.si/docs/features/misc
Every entry on the Misc tab, grouped by section.
The Misc tab is grouped into sections. Each entry below uses the label and description as they appear in the UI.
## Colors
* **Primary Color**: main color for Seraph branding. Picks from Minecraft color codes.
* **Accent Color**: secondary color for Seraph branding.
## Automation
* **Randomised Auto GG**: send "GG" with random capitalisation at game end.
* **Auto Safelist Final Kills**: add final kills to safelist automatically.
* **Auto Who Command**: run `/who` when Bedwars games start.
## Game Alerts & Timers
* **Trap Replacement Reminder**: remind to buy a new trap 30s after activation.
* **Magic Milk Duration Timer**: show on-screen timer for magic milk effect.
* **Magic Milk Alert Types**: pick which notification channels fire (Chat, Title, Sound).
* **Magic Milk Alert Sound**: sound for the milk alert. Visible when Sound is selected in Alert Types.
## HUD
* **Trade Indicator**: show HP difference between you and your opponent during fights.
## Visuals & Rendering
* **Team-Colored Hitboxes**: color hitboxes by team in Bedwars.
* **Hide Own Hitbox**: hide your hitbox in F3+B debug mode.
* **Show Cape When Nicked**: display Mojang cape with nick skins.
* **Display Nickname with Real Name**: show nicknames alongside real names.
## Interface
* **Middle Click for Bedwars Menus**: use middle click for quick purchasing in shops.
* **Clean Chat Messages**: hide repetitive Hypixel system messages.
## Performance & Audio
* **Duels Glyph Filter**: remove glyph particles in Duels.
* **Mute Portal Sounds in Lobbies**: silence portal sounds in lobbies.
## Network & Data
* **Enhanced Ping Display**: use Seraph API for accurate ping data.
* **Legacy Network Compatibility**: use legacy network compatibility mode for restricted internet service providers.
## Replay Mod
* **Fix Player Name Autocomplete**: fix name suggestions in Replay Mod commands.
* **Enable /who in Replays**: allow `/who` command in replays.
## Keybinds
* **Pat Pat Mod**: enable or disable Pat Pat Mod.
* **Pat Action**: keybind that triggers the pat action.
## walter7addons, Alert Settings
* **Jump Boost Expiration Alert**: pick which channels fire (Chat, Title, Sound).
* **Jump Boost Alert Sound**: visible when Sound is selected.
* **Mining Fatigue Applied Alert**: pick which channels fire.
* **Mining Fatigue Alert Sound**: visible when Sound is selected.
* **No Arrows Remaining Alert**: pick which channels fire.
* **No Arrows Alert Sound**: visible when Sound is selected.
## walter7addons, Gameplay Enhancements
* **Prevent Bow Dropping**: block accidental bow drops.
* **Arrow Distance Indicator**: show distance when arrows hit players.
## walter7addons, Visual & Audio
* **Hide Glyph & Sponge Particles**: remove dream defender and sponge particles.
* **Simplified Tab List**: remove header and footer from tab menu.
* **Mute Own Footsteps**: silence your footstep sounds.
## walter7addons, Keybinds
* **Random Nick Generator**: keybind that generates a random nickname.
# Stats overlay
Source: https://docs.seraph.si/docs/features/stats-overlay
The tab-list replacement and everything you can configure on the Overlay tab.
The stats overlay replaces Minecraft's vanilla tab list with a configurable grid of Hypixel statistics for the lobby or game you're in.
## How it works
When you press Tab in a supported Hypixel game, Seraph cancels the vanilla render and draws its own table. Players are picked up from the live tab list as well as scoreboard scans, so the overlay stays accurate as people join and leave.
## Game modes
The overlay swaps its columns based on the Hypixel game you're in:
* **Bedwars**
* **Skywars**
* **Duels**
Each mode has its own enable toggle, compact-mode toggle, and column list.
## The Overlay tab
In the settings menu, the **Overlay** tab is split into three sub-tabs.
### General
* **Custom Cubelify API URLs**: list of full API paths used as additional tag sources. Use the dashed entry to add a new URL; clearing one removes it. Format: `https://api.seraph.si/{{id}}/cubelify/blacklist`.
* **Highlight Snipers**: highlight players with one or more tags.
* When on, a **Sniper Highlight Color** picker appears with 16 Minecraft colors.
* **Highlight Players**: highlight players based on the highlight rules you define in the Modes sub-tab. Required for those rules to do anything.
* **Background Opacity**: slider from 0 to 255 controlling the overlay's background opacity.
### Modes
For each of Bedwars, Skywars, and Duels:
* **Enabled**: turns the overlay on for that mode.
* **Compact Mode** (visible when enabled): displays the overlay in compact mode.
* **Display Timers** (Bedwars only, when enabled): shows Bedwars resource timers in the overlay header.
* **Compact Timers** (Bedwars only, when enabled): displays the timers in compact form.
* **Highlight rules editor**: define rules that color rows based on stat conditions. Rules use stat names with operators `+ - * / ( ) <= >= < > = && ||`. Each rule has a color from a 9-color preset palette and can be enabled/disabled or reordered.
### Columns
Pick a mode (Bedwars, Skywars, Duels) using the tabs at the top. Each tab shows its current column count.
* If **Compact Mode** is on for that mode: a **Compact Stat** dropdown lets you pick the single statistic shown next to player names.
* Otherwise: a column editor lets you pick which columns appear, in what order. Available columns vary per mode.
#### Available columns per mode
**Bedwars**: Stars, Name, HP, Finals, FKDR, Wins, WLR, Beds, BBLR, KDR, WS, Ping, Tags, Custom Tags, Client, Guild, Network Level.
**Skywars**: Level, Name, HP, Wins, Kills, KDR, WLR, WS, Ping, Tags, Custom Tags, Client, Guild, Network Level.
**Duels**: Name, HP, Wins, Kills, KDR, WLR, WS, Ping, Tags, Custom Tags, Client, Guild, Network Level.
## Sorting
Players are grouped by team first, then sorted within each group:
* **Bedwars**: by stars, descending.
* **Skywars**: by Skywars EXP, descending.
* **Duels**: no secondary sort.
## Custom players
`/seraph add ` adds someone to the overlay manually. They render at the bottom of the table and stay until you `/seraph clear` or change worlds.
## Nicked players
When someone joins under a nick, the overlay shows them as `?` until Seraph can resolve them through skin lookups, your saved nick map, or a manual `/seraph remap`. Mappings marked permanent are saved to `nicknames.json`.
# Tags
Source: https://docs.seraph.si/docs/features/tags
Settings on the Tags tab.
The Tags tab controls when alerts fire for reported and nicknamed players, and how tags render in the overlay.
## Settings
### Blacklist Alerts
Alerts you in chat when a reported player joins your game.
### Only Alert on Verified Reports
Only trigger alerts for players with verified reports.
### Play Sound on Report Alerts
Play an audio notification when a reported player is detected.
### Report Alert Sound
Sound picker. Only visible when **Play Sound on Report Alerts** is enabled.
### Report Alerts for Teammates
Show alerts when reported players are on your team.
### Report Alerts in Lobbies
Show alerts when reported players are in your lobby.
### Nick Alerts in Lobbies
Show alerts when nicknamed players are in your lobby.
### Render MDI Icons in Tab
Display Material Design Icons in the tags tab.
## Adding to the blacklist
```
/seraph blacklist ...
```
Alias: `/sblacklist`.
## Mapping a nick
```
/seraph remap [permanent?]
```
Alias: `/snick`. Pass `permanent` to save the mapping to `nicknames.json`.
# API keys & login
Source: https://docs.seraph.si/docs/getting-started/api-keys
Sign in to Seraph, get your Seraph API key from Discord, and hook up your Hypixel key.
Seraph pulls stats from two official sources, configured under the **API** tab in the settings menu:
1. **Hypixel API**: for player stats, guild data, and most overlay columns.
2. **Seraph API**: for tags, reports, ping data, and the live socket.
## Seraph login
`token.json` is your authorisation token, you'll NEVER be asked for it.
Signing in happens automatically the first time you run the launcher. It prompts you for Discord, and after you authorise, it writes your auth token to `token.json` in your Seraph folder.
If the mod ever throws an authentication error on startup, re-run the launcher and sign in again. Your config and other data stay intact.
## Seraph API key
You'll only need this on external applications such as Cubelify.
The Seraph API key is a separate value from the login token. To get one:
Open the Seraph Discord server. The invite link is on [seraph.si](https://seraph.si) or in the launcher.
Type `/generate-key` in any channel where the Seraph bot is present. The bot DMs you a fresh key.
Open `/seraph config`, go to the **API** tab, and paste the key into **Seraph API Key**.
The key field is masked. Click the eye icon to reveal it for editing or copying.
If you ever need to change your key, Open a ticket and an Administrator will guide you through the process.
## Hypixel API key
Sharing this key with untrusted sources is risky and if abused, will permanently ban you from the Hypixel API
A Hypixel API key is **required** for the overlay to fill in stats. Without one, columns like FKDR, wins, and ratios stay blank.
Run `/seraph apikey` (alias `/sapikey`). It opens [developer.hypixel.net](https://developer.hypixel.net/) so you can claim or view your key.
Sign in with your Minecraft account and copy your API key from the dashboard.
Back in `/seraph config`, on the **API** tab, paste the key into **Hypixel API Key**.
## API Merger
The API tab also has **Enable API Merger (port 3005)**. When on, Seraph runs a local HTTP server on `localhost:3005` that aggregates tag data from every Custom Cubelify API URL you've configured (under the Overlay tab, General sub-tab) and serves the merged result at `/api/merger?name=&id=`.
Leave it off unless an external tool you're using needs to consume that combined feed.
## Verifying
Open any Hypixel lobby or game and bring up the tab list. Players should populate with stats within a second or two. If everything stays blank, double-check:
* Your Hypixel key is valid (rerun `/seraph apikey`).
* Your Seraph API key is set (rerun `/generate-key` if needed).
* `token.json` exists in your Seraph folder (re-run the launcher if not).
* Your network can reach Hypixel and Seraph.
# Installation
Source: https://docs.seraph.si/docs/getting-started/installation
Install Seraph through the official launcher.
Seraph installs through the **Seraph Launcher**. It handles everything: signing you in, picking your client, and injecting or installing the mod for you.
## Download the launcher
Only download from official links, other downloads may compromise your own security. Our official domains will always end in `seraph.si`.
Scammers use similar looking domains to compromise your account.
[Download for Windows x64](https://dl.seraph.si/launcher/0.1.0/windows/x64/seraph-launcher.exe)
Coming soon.
Coming soon.
## First launch
Double-click `seraph-launcher.exe`. The first launch may take a few seconds while it sets itself up.
On startup the launcher prompts you to sign in with your Discord account. This creates your Seraph account and writes your auth token to disk so the mod can talk to the Seraph backend.
Once you're signed in, you'll see three options:
* **Download Forge**: installs Minecraft Forge 1.8.9 and drops the Seraph jar into your `mods/` folder.
* **Inject for Lunar Client**: launches Lunar and injects Seraph into the running process.
* **Inject for Badlion Client**: launches Badlion and injects Seraph into the running process.
Pick whichever client you actually play on.
In any world, run `/seraph help`. If the help menu appears, Seraph is loaded.
## Where files live
The launcher creates a per-user data folder used by every Seraph install on your machine, no matter which client:
| OS | Path |
| ------- | --------------------------------------------------------------- |
| Windows | `%AppData%\Seraph\` |
| macOS | `~/.Seraph/` |
| Linux | `$XDG_DATA_HOME/Seraph/` (defaults to `~/.local/share/Seraph/`) |
Inside the folder you'll see:
* `config.json`, your settings.
* `token.json`, Seraph auth token. Don't share this.
* `nicknames.json`, saved nick to real-name mappings (only "permanent" ones).
Because the folder is shared, your settings carry over automatically when you switch between Lunar, Badlion, and Forge.
## Updating
Re-run the launcher. It checks for new versions of the mod and re-installs or re-injects as needed. Your config is preserved across updates.
## Switching clients
Quit Minecraft, run the launcher again, and pick a different option. You can have Seraph running on Lunar one day and Forge the next without losing any settings.
# Quickstart
Source: https://docs.seraph.si/docs/getting-started/quickstart
First five minutes with Seraph, open the menu, find a setting, run a command.
Once Seraph is installed and your Hypixel key is in, here's the fastest path to making it useful.
## Open the settings menu
```
/seraph config
```
Alias: `/sconfig`. Both work case-insensitively (`/Seraph`, `/SCONFIG`, etc).
The menu has six tabs:
| Tab | What's in it |
| --------------- | ------------------------------------------------------------------- |
| **API** | Hypixel + Seraph keys, API merger toggle |
| **Overlay** | General settings, per-mode toggles, column editor, highlight rules |
| **Anticheat** | Auto Block, Legit Scaffold, No Break Delay, flag sound |
| **Misc** | Auto GG, trade indicator, hitbox tweaks, audio, walter7addons, more |
| **Tags** | Blacklist & nick alert settings, MDI icon rendering |
| **Experiments** | Opt-in experimental implementations |
## Search
Hit the search bar at the top. It indexes every entry from every tab, type a keyword like `cape`, `auto gg`, or `flag` and it'll find every related setting.
## Run a stats lookup
```
/seraph stats [mode]
```
Alias: `/ss`. Prints a stats summary in chat. Add a gamemode to focus the output (e.g. `/ss notch bedwars`).
## Add a player to your lobby manually
If a friend just joined and isn't in tab yet:
```
/seraph add
```
Alias: `/sadd`. They'll show up in the overlay until you `/seraph clear` or leave the world.
## Other day-to-day commands
| Command | What it does |
| ----------------------------------------------- | ---------------------------------- |
| `/seraph check ` (`/sc`) | Show blacklist status for a player |
| `/seraph blacklist ...` | Add to blacklist |
| `/seraph remap ` | Map a nick to a real player |
| `/seraph apikey` (`/sapikey`) | Open Hypixel Developer Dashboard |
See the [full command reference](/features/commands) for everything.
# Introduction
Source: https://docs.seraph.si/docs/introduction
A Minecraft 1.8.9 mod with a Hypixel stats overlay, anticheat, and a clean settings UI.
![Seraph]()
Seraph is a Minecraft 1.8.9 mod focused on Hypixel. It replaces the tab list with a detailed stats overlay, flags suspicious players, tags known cheaters and threats, and bundles dozens of quality-of-life features into a clean in-game settings menu.
It runs on **Lunar Client**, **Badlion Client**, and **Forge**, and shares a single config across all three.
Install Seraph in a few minutes through the launcher.
Join the community for support, announcements, and `/generate-key`.
The tab-list replacement and everything you can configure.
Every chat command Seraph registers.
## Highlights
Live tab list with per-mode columns, sorting, and configurable colors.
Flags scaffold and break-delay cheaters in real time, with optional auto-block.
Surfaces known cheaters and threats with colored tags in tab and on nametags.
Searchable settings menu for everything the mod does.
## Supported clients
| Client | Version | How it installs |
| ------------ | ------- | --------------------------- |
| Lunar Client | 1.8.9 | Through the Seraph Launcher |
| Badlion | 1.8.9 | Through the Seraph Launcher |
| Forge | 1.8.9 | Through the Seraph Launcher |
Your settings and saved nicknames carry over between clients automatically.
# Introduction
Source: https://docs.seraph.si/how-to-stay-safe/introduction
## Staying Safe with Seraph
Security is a paramount concern when using third party modifications. To ensure your account and personal data remain protected, please adhere to the following safety protocols.
***
### Official Sources Only
The most common vector for account compromise is the use of "cracked" or unofficial versions of software.
* **Verify the Domain:** Always ensure you are downloading from `seraph.si`.
* **Avoid Third Party Reuploads:** Never download the launcher from Discord attachments, file sharing sites (like MediaFire or Mega), or YouTube descriptions.
* **Checksums:** Verify the SHA-256 hash of your download to ensure the file hasn't been tampered with.
* **Certification:** On Windows, Right click the file, Click properties and Check the file has a valid signature.
### Protecting Your Authentication Token
**Never share your `token.json` file.** If someone gains access to this file, they can impersonate your account on the Seraph backend. We will never ask you to send us this file for support.
When you sign in via Discord, the launcher generates a `token.json` file. This token is a **credential** that allows the client to communicate with our servers as "you."
### Understanding Process Injection
Seraph utilises process injection for clients like Lunar Client and Badlion Client (BLC). While this is a standard technique for sideloading mods, it can sometimes trigger "False Positives" in antivirus software.
* **Heuristic Scanning:** Some antivirus tools may flag the launcher because it interacts with other running applications (Minecraft).
* **Whitelisting:** If the official launcher is blocked, add an exception for `%AppData%\Seraph\` rather than disabling your firewall entirely.
### Social Safety
Beyond technical security, be wary of "Social Engineering" within the community.
1. **Staff Identification:** Official staff members will have unique roles in the Discord. Anyone DMing you claiming to be "Support" and asking for files or passwords is a bad actor.
2. **Plugin Safety:** If you use Seraph alongside other Forge mods, ensure those mods are also from reputable sources (CurseForge, Modrinth). A malicious mod in your `mods` folder can read your Seraph configuration.
# Official sources
Source: https://docs.seraph.si/how-to-stay-safe/official-sources
Scammers use similar domains to trick you in to giving your personal information, such as your Email Address or Password.
### Seraph Resources
These links represent the only verified domains for Seraph software and documentation.
* **Official Website:** [seraph.si](https://seraph.si)
* **Documentation:** [docs.seraph.si](https://docs.seraph.si)
* **Downloads:** [dl.seraph.si]()
* **Community Discord:** [discord.gg/seraph](https://discord.gg/seraph)
### Hypixel Resources
Official resources for the Hypixel Network and support.
* **Hypixel Website:** [hypixel.net](https://hypixel.net)
* **Hypixel Support:** [support.hypixel.net](https://support.hypixel.net)
* **Server Address:** `mc.hypixel.net`
### Discord Resources
Official resources for Discord
* **Discord App:** [discord.com](discord.com)
* **Discord Authorisation:** [discord.com/oauth2/authorize]()
# Privacy Policy
Source: https://docs.seraph.si/legal/privacy
How Seraph handles your data.
Your privacy matters to us. Our full Privacy Policy covers the website, dashboard, and APIs.
Read the complete, up-to-date Privacy Policy at **seraph.si/privacy**.
We keep the official version of this policy at [seraph.si/privacy](https://seraph.si/privacy). If anything here ever disagrees with that page, the seraph.si version is the one that counts.
***
## What the mod collects
The Seraph mod itself is intentionally minimal. It only ever sends **one piece of information**:
* Your **Discord Snowflake ID**, used during the initial login from the launcher
Nothing else is collected or transmitted.
If you choose to use the **Player Cache** feature, the mod will fetch Hypixel player data from our backend.
## Crash reports
For crash reports we use [Sentry](https://sentry.io). These reports only contain:
* A **randomly generated ID**
* The **stack trace** associated with the crash
No personally identifiable information is intentionally collected through crash reports.
# Terms of Service
Source: https://docs.seraph.si/legal/terms
The terms you agree to when you use Seraph
When you use Seraph - the website, launcher, mod, stats dashboard, and our APIs and Discord integrations - our Terms of Service apply.
Read the complete, up-to-date Terms of Service at **seraph.si/terms**.
We keep the official version of the Terms at [seraph.si/terms](https://seraph.si/terms). If anything here ever disagrees with that page, the seraph.si version is the one that counts.