# Shulkr Companion<\/p>\n
A companion plugin for Shulkr that enables seamless log management and uploading directly from your Minecraft server. This plugin integrates with Shulkr’s secure log hosting service to help server administrators easily share and analyze their server logs. It’s also compatible with mclo.gs!<\/p>\n
## Features<\/p>\n
– \ud83d\ude80 **Quick Log Upload**
\n – Upload logs directly from in-game or console
\n – Instant shareable links
\n – Supports multiple log files
\n – Automatic error detection and analysis<\/p>\n
– \ud83d\udcc2 **In-Game Log Management**
\n – Browse available log files through GUI
\n – Interactive menu interface
\n – Quick access to recent logs
\n – Direct upload functionality<\/p>\n
– \ud83d\udd04 **Service Compatibility**
\n – Works with Shulkr
\n – Compatible with mclo.gs
\n – Easy service switching via config<\/p>\n
– \ud83c\udfae **User-Friendly Commands**
\n – Simple command structure
\n – Tab completion support
\n – Intuitive GUI interface
\n – Click-to-copy links<\/p>\n
## Requirements<\/p>\n
– Java 14 or higher
\n– Minecraft Server 1.16+
\n– Paper, Purpur, or compatible fork<\/p>\n
## Installation<\/p>\n
1. Download the latest release from the releases page
\n2. Place the `.jar` file in your server’s `plugins` folder
\n3. Restart your server
\n4. (Optional) Configure the instance URL in the config file<\/p>\n
## Commands<\/p>\n
| Command | Permission | Description |
\n|———|————|————-|
\n| `\/logs` | `shulkr.upload` | Upload latest.log to configured service |
\n| `\/logs list` | `shulkr.upload` | Open the log management GUI |
\n| `\/logs upload [file]` | `shulkr.upload` | Upload a specific log file |<\/p>\n
## Permissions<\/p>\n
– `shulkr.upload` – Allows users to upload and manage logs
\n– `shulkr.*` – Grants all plugin permissions<\/p>\n
## Configuration<\/p>\n
Default `config.yml`:
\n“`yaml
\n# The URL of the log hosting service
\n# Use https:\/\/shulkr.notri1.fr\/api for Shulkr
\n# Use https:\/\/api.mclo.gs for mclo.gs
\ninstance-url: https:\/\/shulkr.notri1.fr\/api
\n“`<\/p>\n
## Usage Examples<\/p>\n
1. **Quick Upload**
\n“`bash
\n\/logs
\n“`
\nUploads the latest log file and provides a shareable link.<\/p>\n
2. **Specific File Upload**
\n“`bash
\n\/logs upload crash-2024-01-01-1.log
\n“`
\nUploads a specific log file from the logs directory.<\/p>\n
3. **Browse Logs**
\n“`bash
\n\/logs list
\n“`
\nOpens an interactive GUI to browse and manage log files.<\/p>\n
## Service Configuration<\/p>\n
### Using with Shulkr
\nThe default configuration uses Shulkr. No changes needed!<\/p>\n
### Using with mclo.gs
\nTo use mclo.gs instead of Shulkr:
\n1. Open `config.yml`
\n2. Change the `instance-url` to `https:\/\/api.mclo.gs`
\n3. Reload the plugin or restart your server<\/p>\n
## Building from Source<\/p>\n
1. Clone the repository:
\n“`bash
\ngit clone https:\/\/github.com\/Paylicier\/ShulkrCompanion.git
\ncd ShulkrCompanion
\n“`<\/p>\n
2. Build using Gradle:
\n“`bash
\n.\/gradlew shadowJar
\n“`<\/p>\n
The compiled jar will be in the `build\/libs` directory.<\/p>\n
## Contributing<\/p>\n
We welcome contributions! Please feel free to:
\n– Report bugs
\n– Suggest features
\n– Submit pull requests
\n– Improve documentation<\/p>\n
1. Fork the repository
\n2. Create your feature branch: `git checkout -b feature\/AmazingFeature`
\n3. Commit your changes: `git commit -m ‘Add AmazingFeature’`
\n4. Push to the branch: `git push origin feature\/AmazingFeature`
\n5. Open a Pull Request<\/p>\n
## Support<\/p>\n
– For bug reports and feature requests, use GitHub Issues<\/p>\n
## License<\/p>\n
This project is licensed under the MIT License – see the [LICENSE](LICENSE) file for details.<\/p>\n
## Acknowledgments<\/p>\n
– Compatible with mclo.gs
\n– Built for integration with Shulkr
\n– Community contributions and feedback<\/p>\n
—
\nMade with \u2764\ufe0f by Paylicier<\/p>\n","protected":false},"excerpt":{"rendered":"
A companion plugin for Shulkr\/Mclo.gs that enables seamless log management and uploading directly from your Minecraft server.<\/p>\n","protected":false},"featured_media":139206,"template":"","meta":{"_minecraft_slug":"shulkr","_minecraft_project_id":"kveRxtH0","_minecraft_author":"Paylicier","_minecraft_license":"MIT","_minecraft_downloads":132,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"shulkr.zip","_minecraft_size_bytes":1332382,"_minecraft_version_count":2,"_minecraft_updated_at":"2026-05-15T18:59:59.127598Z","_minecraft_date_created":"2024-11-25T21:33:22.706461Z","_minecraft_date_modified":"2024-12-10T17:27:51.152121Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/shulkr","_minecraft_icon_attachment_id":139206,"_minecraft_imported_at":"2026-06-08T05:55:27+00:00","_minecraft_import_hash":"2547be64b0276efbf774ab006e521fcc","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,126,90,127,128,129,92],"mod_loader":[130,132,133,134],"minecraft_version":[118,119,120,46,47,48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,73,74,38],"class_list":["post-139205","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-management","mod_category-optimization","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-utility","mod_loader-bukkit","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-16","minecraft_version-1-16-1","minecraft_version-1-16-2","minecraft_version-1-16-3","minecraft_version-1-16-4","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4"],"yoast_head":"\n