Shulkr Companion
一个 Shulkr 的配套插件,支持直接从你的 Minecraft 服务器进行无缝日志管理和上传。该插件与 Shulkr 的安全日志托管服务集成,帮助服务器管理员轻松分享和分析服务器日志。它还兼容 mclo.gs!
功能特性
-
? 快速日志上传
- 直接从游戏内或控制台上传日志
- 即时生成可分享的链接
- 支持多个日志文件
- 自动错误检测与分析
-
? 游戏内日志管理
- 通过图形界面浏览可用日志文件
- 交互式菜单界面
- 快速访问最近日志
- 直接上传功能
-
? 服务兼容性
-
? 用户友好命令
- 简洁的命令结构
- 支持 Tab 补全
- 直观的图形界面
- 点击即可复制链接
运行环境
- Java 14 或更高版本
- Minecraft Server 1.16+
- Paper、Purpur 或其他兼容分支
安装步骤
- 从 发布页面 下载最新版本
- 将
.jar 文件放入服务器的 plugins 文件夹中
- 重启服务器
- (可选)在配置文件中设置实例 URL
命令列表
| 命令 |
权限 |
描述 |
/logs |
shulkr.upload |
将 latest.log 上传至配置的服务 |
/logs list |
shulkr.upload |
打开日志管理图形界面 |
/logs upload [file] |
shulkr.upload |
上传特定的日志文件 |
权限说明
shulkr.upload - 允许用户上传和管理日志
shulkr.* - 授予所有插件权限
配置说明
默认 config.yml:
# 日志托管服务的 URL
# 使用 https://shulkr.notri1.fr/api 对应 Shulkr
# 使用 https://api.mclo.gs 对应 mclo.gs
instance-url: https://shulkr.notri1.fr/api
使用示例
- 快速上传
/logs
上传最新的日志文件并提供可分享的链接。
- 指定文件上传
/logs upload crash-2024-01-01-1.log
从 logs 目录上传特定的日志文件。
- 浏览日志
/logs list
打开交互式图形界面以浏览和管理日志文件。
服务配置
与 Shulkr 配合使用
默认配置已使用 Shulkr。无需更改!
与 mclo.gs 配合使用
若要改用 mclo.gs 而非 Shulkr:
- 打开
config.yml
- 将
instance-url 更改为 https://api.mclo.gs
- 重新加载插件或重启服务器
从源码构建
- 克隆仓库:
git clone https://github.com/Paylicier/ShulkrCompanion.git
cd ShulkrCompanion
- 使用 Gradle 构建:
./gradlew shadowJar
编译后的 jar 包将位于 build/libs 目录中。
贡献指南
我们欢迎贡献!请随时:
- 报告 Bug
- 建议新功能
- 提交拉取请求(Pull Request)
- 改进文档
- Fork 本仓库
- 创建你的功能分支:
git checkout -b feature/AmazingFeature
- 提交你的更改:
git commit -m 'Add AmazingFeature'
- 推送到分支:
git push origin feature/AmazingFeature
- 发起 Pull Request
支持
许可证
本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。
致谢
由 Paylicier ❤️ 制作
Shulkr Companion
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!
Features
-
? Quick Log Upload
- Upload logs directly from in-game or console
- Instant shareable links
- Supports multiple log files
- Automatic error detection and analysis
-
? In-Game Log Management
- Browse available log files through GUI
- Interactive menu interface
- Quick access to recent logs
- Direct upload functionality
-
? Service Compatibility
- Works with Shulkr
- Compatible with mclo.gs
- Easy service switching via config
-
? User-Friendly Commands
- Simple command structure
- Tab completion support
- Intuitive GUI interface
- Click-to-copy links
Requirements
- Java 14 or higher
- Minecraft Server 1.16+
- Paper, Purpur, or compatible fork
Installation
- Download the latest release from the releases page
- Place the
.jar file in your server's plugins folder
- Restart your server
- (Optional) Configure the instance URL in the config file
Commands
| Command |
Permission |
Description |
/logs |
shulkr.upload |
Upload latest.log to configured service |
/logs list |
shulkr.upload |
Open the log management GUI |
/logs upload [file] |
shulkr.upload |
Upload a specific log file |
Permissions
shulkr.upload - Allows users to upload and manage logs
shulkr.* - Grants all plugin permissions
Configuration
Default config.yml:
# The URL of the log hosting service
# Use https://shulkr.notri1.fr/api for Shulkr
# Use https://api.mclo.gs for mclo.gs
instance-url: https://shulkr.notri1.fr/api
Usage Examples
- Quick Upload
/logs
Uploads the latest log file and provides a shareable link.
- Specific File Upload
/logs upload crash-2024-01-01-1.log
Uploads a specific log file from the logs directory.
- Browse Logs
/logs list
Opens an interactive GUI to browse and manage log files.
Service Configuration
Using with Shulkr
The default configuration uses Shulkr. No changes needed!
Using with mclo.gs
To use mclo.gs instead of Shulkr:
- Open
config.yml
- Change the
instance-url to https://api.mclo.gs
- Reload the plugin or restart your server
Building from Source
- Clone the repository:
git clone https://github.com/Paylicier/ShulkrCompanion.git
cd ShulkrCompanion
- Build using Gradle:
./gradlew shadowJar
The compiled jar will be in the build/libs directory.
Contributing
We welcome contributions! Please feel free to:
- Report bugs
- Suggest features
- Submit pull requests
- Improve documentation
- Fork the repository
- Create your feature branch:
git checkout -b feature/AmazingFeature
- Commit your changes:
git commit -m 'Add AmazingFeature'
- Push to the branch:
git push origin feature/AmazingFeature
- Open a Pull Request
Support
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Compatible with mclo.gs
- Built for integration with Shulkr
- Community contributions and feedback
Made with ❤️ by Paylicier
评论 0
登录后参与评分
还没有评论,来抢沙发吧