README_CN.md

   __   _       __        ____             _        
  / /  (_)_ _  / /  ___  / __/__ _____  __(_)______ 
 / /__/ /  ' \/ _ \/ _ \_\ \/ -_) __/ |/ / / __/ -_)
/____/_/_/_/_/_.__/\___/___/\__/_/  |___/_/\__/\__/ 

README LANGUAGES [ English | 中文 ]

LimboService

🌆 专为 Minecraft 打造的轻量级独立 LIMBO 服务。

Note

本项目基于 Limbo 项目开发， 后续将由 YourCraftMC 团队进行重大改动与维护。

使用指南

请从此处下载最新服务端 Jar 文件， 或通过发布页获取历史版本。

1. 将下载的服务器 Jar 文件放置于目标运行目录。
   • 可将世界模板文件放置于服务器世界目录（与 Jar 文件同级）。
2. 使用如下命令启动服务器（与常规 Minecraft 服务端启动方式一致）：

   java -Xms64M -Xmx512M -jar LimboService-<VERSION>-<MINECRAFT>.jar

3. 在 config.yml 中配置服务器参数，在 messages.yml 中自定义消息。
4. 通过您配置的服务器地址加入游戏，体验 LIMBO 世界！

其他开发者可通过 LimboService 提供的 API 开发第三方插件， 您可将编译后的插件置于 plugins/ 目录下， 插件将在LimboService启动时加载。

如您也想开发 LimboService 的第三方插件，请移步 开发指南 。

Caution

LimboService 未实现也绝不计划实现任何 Bukkit/Spigot/BungeeCord/Velocity 的 API， 且完全无法兼容这些平台的插件！

永远不要提交任何关于与其他平台插件兼容性问题的工单！

内置命令

# version
@ limbo.command.version
- 显示服务器版本信息

# spawn [player]
@ limbo.command.spawn (自用权限)
@ limbo.command.spawn.others
- 将玩家传送至出生点

# say <message>
@ limbo.command.say
- 向全体玩家广播消息

# gamemode <mode> [player]
@ limbo.command.gamemode (自用权限)
@ limbo.command.gamemode.others
- 切换玩家游戏模式

# allowlist toggle
@ limbo.command.allowlist
- 切换名单模式（允许名单/拒绝名单）

# allowlist <add|remove> <player>
@ limbo.command.allowlist
- 添加/移除名单中的玩家

# allowlist reload
@ limbo.command.allowlist
- 重载名单配置

# kick <player> [reason]
@ limbo.command.kick
- 踢出指定玩家

# stop
@ limbo.command.stop
- 关闭服务器

开发指南

LimboService 可作为开发库使用，其插件开发模式与 Bukkit/Spigot 类似。

以下为插件开发的最小化示例：

package com.example.myplugin;

import com.loohp.limbo.plugins.LimboPlugin;

public class MyPlugin extends LimboPlugin {
    @Override
    public void onLoad() {
        // 插件加载时触发
    }

    @Override
    public void onEnable() {
        // 插件启用时触发
    }

    @Override
    public void onDisable() {
        // 插件停用时触发
    }
}

同时，您需在 src/resources/ 目录下创建 plugin.yml 或 limbo.yml 文件：

main: com.example.myplugin.MyPlugin
name: MyPlugin
version: 1.0
author: MyCoolName
description: LimboService 基础插件模板

至此，您已可使用 LimboService API 进行插件开发！

Note

您可从 GitHub Packages 查看、获取Maven的依赖包，还可以在 这里 找到本项目的 Javadoc。

使用时记得将下方配置中的 VERSION 替换为实际版本号。

Maven 依赖配置

<project>
    <repositories>
        <repository>
            <!-- 推荐使用 Maven 中央仓库获取稳定版本（需注意同步延迟） -->
            <id>maven</id>
            <name>Maven Central</name>
            <url>https://repo1.maven.org/maven2</url>
        </repository>

        <repository>
            <!-- 使用 GitHub 仓库获取实时更新（需配置认证） -->
            <id>limboservice-repo</id>
            <name>GitHub Packages for LimboService</name>
            <url>https://maven.pkg.github.com/YourCraftMC/LimboService</url>
        </repository>
    </repositories>

    <dependencies>
        <dependency>
            <groupId>cn.ycraft</groupId>
            <artifactId>limboservice</artifactId>
            <version>[VERSION]</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>
</project>

Gradle 依赖配置

repositories {
    // 推荐使用 Maven 中央仓库获取稳定版本（需注意同步延迟）
    mavenCentral()

    // 使用 GitHub 仓库获取实时更新（需配置认证）
    maven { url 'https://maven.pkg.github.com/YourCraftMC/LimboService' }
}

dependencies {
    api "cn.ycraft:limboservice:[LATEST RELEASE]"
}

第三方开源库依赖

• MCProtocolLib: 用于实现基本的 MineCraft 游戏功能。
• adventure: 消息组件功能支持。
• EasyConfiguration: 配置文件实现。
• EasyPlugin-Color: 通用颜色代码解析支持。

完整依赖列表请参见 依赖关系图。

致谢与支持

特别感谢 LoohpJames(@LOOHP) 与 其他贡献者 对原项目的卓越贡献。

衷心感谢 JetBrains 为本项目及其他开源项目提供开发工具授权。

本项目目前由 YourCraftMC(你的世界) 团队主导维护。

开源协议

本项目源代码遵循 GNU 宽通用公共许可证(LGPL) 3.0 发布。