https://github.com/aternosorg/mclogs-integration
A mod/plugin to easily share and analyse your server logs with mclo.gs
https://github.com/aternosorg/mclogs-integration
Last synced: 11 months ago
JSON representation
A mod/plugin to easily share and analyse your server logs with mclo.gs
- Host: GitHub
- URL: https://github.com/aternosorg/mclogs-integration
- Owner: aternosorg
- License: mit
- Created: 2025-02-25T13:40:28.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-18T12:24:22.000Z (12 months ago)
- Last Synced: 2025-06-22T01:44:12.137Z (12 months ago)
- Language: Java
- Homepage: https://mclo.gs
- Size: 353 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-folia - GitHub
README
Server Plugin/Mod
Upload your logs to mclo.gs with a single command to analyze or share them.
Critical information like IP addresses are automatically hidden to ensure safety and privacy.
It's also possible to export old server log files, e.g. after a crash.
« Download Plugin/Mod on Modrinth »
SpigotMC
·
CurseForge (Plugin)
·
CurseForge (Mod)
·
Hangar
## About mclo.gs
mclo.gs allows you to quickly share and analyze logs for Minecraft servers and clients. It highlights different log levels, removes sensitive information like IP-Addresses and detects common problems as well as version information.
## Commands
The Plugin/Mod contains the following commands:
| Command | Arguments | Description | Permission Level | Permission Node |
|--------------|---------------|---------------------------------------------------------------|------------------|-----------------|
| mclogs | | Share the current server log | 2 | mclogs |
| mclogs list | | List server logs, crash- and network protocol error reports | 2 | mclogs.list |
| mclogs share | \ | Share a specific log, crash- or network protocol error report | 2 | mclogs.share |
For special cases, the following commands are available:
| Scenario | Command | Behavior |
|----------------------------------------|---------------------------|--------------------|
| Mod installed client-side | `/mclogsc` | Handle client logs |
| Plugin installed on a Velocity proxy | `/mclogsp` and `/mclogsv` | Handle proxy logs |
| Plugin installed on a BungeeCord proxy | `/mclogsp` and `/mclogsb` | Handle proxy logs |
### Permissions
Commands are not available to players by default. You can give players access to the commands by giving them the
required permissions. Plugin servers permissions use permission nodes for fine-grained access control. The `mclogs`
permission node is required for all other commands as well.
Modded servers use the Vanilla permission level system instead.
## Configuration
If you use a self-hosted instance of mclo.gs or want to use an alternative front-end, you can configure the plugin/mod to use your instance.
The config file is located in `plugins/mclogs/config.toml` for plugin servers and `config/mclogs.toml` for modded servers.
### Default configuration
```toml
# Base URL for the API used to upload logs
apiBaseUrl = "https://api.mclo.gs"
# URL to view logs on the web
# A trailing slash and the log ID will be appended to this URL
viewLogsUrl = "https://mclo.gs"
```
## Requirements
This project requires Java 11 or higher to run, even on Minecraft versions that run on Java 8.
## Contributing
This project is licensed as MIT. Contributions are welcome but if you plan some larger changes please
create an issue for discussion first, to avoid wasting time on something that might not be merged.
### Setting up the Development Environment
1. Clone the repository
2. Import the project in your IDE (IntelliJ IDEA is recommended)
3. Run `./gradlew :forge:genIntellijRuns :neoforge:createLaunchScripts` to generate the Forge/NeoForge runs
### Modules
| Module | Description | Parent Module |
|------------|--------------------------------------------------------------------------------|---------------|
| common | Code shared between all platforms | |
| common-mc | Code shared between all platforms that provide access to the Minecraft classes | common |
| adventure | Code shared between all platforms that use the adventure component library | common |
| bukkit | Bukkit plugin implementation | adventure |
| bungeecord | BungeeCord plugin implementation | adventure |
| velocity | Velocity plugin implementation | adventure |
| forge | Forge mod implementation | common-mc |
| fabric | Fabric mod implementation | common-mc |
| neoforge | NeoForge mod implementation | common-mc |
### Building
To build all modules run `./gradlew buildAll`. Unless specified below all other modules use the `build` task.
Modules with special build task:
| Module | Task |
|------------|-------------|
| bukkit | `shadowJar` |
| bungeecord | `shadowJar` |
| velocity | `shadowJar` |
| forge | `jarJar` |
### Running in development environments
If you're using IntelliJ IDEA you should already see run configurations for most platforms.
For other platforms or other IDEs run their respective gradle tasks:
| Platform | Client Task | Server Task |
|------------|---------------------------------|---------------------------------------|
| Bukkit | | `./gradlew :bukkit:runServer` |
| BungeeCord | | `./gradlew :bungeecord:runBungeeCord` |
| Velocity | | `./gradlew :velocity:runVelocity` |
| Forge | `./gradlew :forge:Client` | `./gradlew :forge:Server` |
| Fabric | `./gradlew :fabric:runClient` | `./gradlew :fabric:runServer` |
| NeoForge | `./gradlew :neoforge:runClient` | `./gradlew :neoforge:runServer` |