Community listing page, reviews may not be monitored by the author.
Discord Connect Templete
No reviews yet
A lightweight Minecraft mod that exposes API endpoints for seamless Discord integration.
Community voices
Reviews
No reviews yet. Be the first to review this project!
Get it on
Available Platforms
About
Project Details
For authors
Embed Badge
If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.
Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.
Identifiers
Platform IDs
Resources
External Links
About
Description
Discord Connect Template
Discord Connect Template is a server-side Minecraft Forge mod that sends Minecraft server and player events to a customizable Discord integration API.
This project is provided as a template for server administrators and developers who want to connect Minecraft with Discord using their own API implementation.
## Features
- Sends server start and stop events
- Sends player join and leave events
- Sends periodic heartbeat events
- Generates Discord account linking codes with
/discord link - Supports English and Japanese in- game messages
- Uses configurable API endpoints and authentication
- Skips API requests when no API URL is configured
Configuration
The mod does not include a hosted API, database, database credentials, or private server configuration.
After starting the server once, edit the generated configuration file:
``text config/discord_connector- server.toml
Configure the following values:
server_id = "your-server-id"
api_url = "https://your-api.example.com"
api_key = "your-api-key"
``
The default configuration leaves api_url and api_key empty. API communication remains disabled until you provide your own compatible API.
In-Game Usage
Run the following command in Minecraft:
/discord link
The mod will generate a temporary linking code and display the Discord command to use:
/link code:YOUR_CODE
The linking code is valid for 10 minutes.
API Endpoints
A compatible API should implement the following endpoints:
- POST /v1/minecraft/events/server- start
- POST /v1/minecraft/events/server- stop
- POST /v1/minecraft/events/join
- POST /v1/minecraft/events/leave
- POST /v1/minecraft/heartbeat
- POST /v1/minecraft/link-code
The request and response formats are documented in the project source and README.
Important Notes
- This mod does not provide a hosted API or database.
- You are responsible for hosting and securing your own API.
- Never publish API keys, database credentials, or private configuration files.
- This mod is intended for server-side and client-side use.
License
See the included license file for usage and redistribution terms.
Versions
Files
Relations
Project Relations
More like this
Similar Mods
Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.
On ModDex
Community snapshot
By the numbers
Statistics
Get it on
Available Platforms
On ModDex
Community snapshot
By the numbers
Statistics
Resources