# minecraft-server-lib

**Repository Path**: colidstudio/minecraft-server-lib

## Basic Information

- **Project Name**: minecraft-server-lib
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-28
- **Last Updated**: 2025-10-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Minecraft 服务器控制库

## 项目简介
这是一个用于控制 Minecraft 服务器的 Python 库，提供了 Minecraft 服务器的安装、配置和启动功能。

## 主要功能
- 安装指定版本的 Minecraft 服务器
- 配置服务器设置和 EULA
- 读取和写入 server.properties 文件
- 生成启动服务器的命令行参数

## 安装方法
请确保已安装 Python 3 环境，然后使用 pip 安装：
```bash
pip install git+https://gitee.com/colidstudio/minecraft-server-lib.git
```

## 使用示例

### 测试demo
1. `test1.py` 测试是否安装成功
2. `test2.py` 测试下载服务器
3. `test3.py` 测试启动服务器
4. `test4.py` 修改并写入 server.properties

### 安装 Minecraft 服务器
```python
from minecraft_server_lib import install

def callback(status, progress, max_progress):
    print(f"Status: {status}, Progress: {progress}/{max_progress}")

install.install_minecraft_server("1.16.5", "/path/to/server", callback)
```

### 启动 Minecraft 服务器
```python
from minecraft_server_lib import launcher

command = launcher.get_launcher_minecraft_server_command(
    "1.16.5", 
    "/path/to/server",
    nougui=True,
    other_args=["-Xmx2048M", "-Xms2048M"],
    java="java"
)
print(" ".join(command))
```

### 配置服务器
```python
from minecraft_server_lib import utils

# 设置 EULA
utils.setup_minecraft_server_eula("1.16.5", "/path/to/server")

# 读取 server.properties
properties = utils.read_minecraft_server_properties("1.16.5", "/path/to/server")
print(properties)

# 修改并写入 server.properties
properties["motd"] = "我的 Minecraft 服务器"
utils.write_minecraft_server_properties("1.16.5", "/path/to/server", properties)
```

## 异常处理
该库定义了以下异常类：
- `ConnectionError`: 网络连接问题
- `RequestException`: 请求异常
- `ThisServerVersionDoesNotExistError`: 指定的服务器版本不存在
- `ThisServerServerPropertiesDoesNotExistError`: server.properties 文件不存在

## 贡献代码
欢迎贡献代码！如果您有意改进此库，请提交 Pull Request。

## 许可协议
本项目采用 MIT 许可协议，请参阅 LICENSE 文件了解详细信息。