https://github.com/cyteon/forge-serverlogger
https://github.com/cyteon/forge-serverlogger
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cyteon/forge-serverlogger
- Owner: Cyteon
- License: mit
- Created: 2024-03-10T13:19:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T20:43:35.000Z (over 2 years ago)
- Last Synced: 2025-02-25T08:19:31.181Z (over 1 year ago)
- Language: Java
- Size: 49.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# forge-serverlogger
forge-serverlogger is a Forge mod for Minecraft 1.18.2 that sends notifications to a Discord server for various in-game events, including:
- Server start/stop
- Player join/leave
- Player death
- Player advancements
- Chat messages
- When a player finds netherite
## Installation
1. Download the mod file from the [releases page](https://github.com/Cyteon/forge-serverlogger/releases).
2. Place the downloaded JAR file in the `mods` folder of your Minecraft Server.
3. Start the Minecraft Server.
## Configuration
Upon first launch, the mod will create a configuration file named `forge-serverlogger.toml` in the `config` folder of your Minecraft instance. Open this file and configure the following settings:
```toml
[Discord]
# Discord webhook URL for server logs
"Logs Webhook URL" = "YOUR_LOGS_WEBHOOK_URL_HERE"
# Discord webhook URL for chat messages
"Chat Webhook URL" = "YOUR_CHAT_WEBHOOK_URL_HERE"
```
Replace YOUR_LOGS_WEBHOOK_URL_HERE with the Discord webhook URL you want to use for server events. Replace YOUR_CHAT_WEBHOOK_URL_HERE with the Discord webhook URL you want to use for chat messages.
Usage
Once the mod is installed and configured, it will automatically send notifications to the specified Discord webhooks for the events listed above.
Building from Source
If you want to build the mod from source, you'll need to have the following tools installed:
- Java Development Kit (JDK) 17 or later
- Gradle
1. Clone the repository: `git clone https://github.com/Cyteon/forge-serverlogger.git`
2. Navigate to the project directory: `cd forge-serverlogger`
3. Build the mod: `./gradlew build`
The built JAR file will be located in the build/libs directory.
Contributing
Contributions are welcome! Please open an issue or submit a pull request on the GitHub repository.