FerrumC 使用与配置教程

FerrumC 使用与配置教程

ferrumc A reimplementation of the minecraft server in rust. 项目地址: https://gitcode.com/gh_mirrors/fe/ferrumc

1. 项目的目录结构及介绍

FerrumC 是一个用 Rust 编写的 Minecraft 服务器实现。以下是项目的目录结构及其简要说明：

ferrumc/
├── .etc/               # 系统级别的配置文件
├── .github/            # GitHub 专用的配置文件
├── assets/             # 静态资源文件，如图片等
├── scripts/            # 脚本文件
├── src/                # 源代码目录
├── .gitignore          # Git 忽略文件列表
├── CODE_OF_CONDUCT.md  # 行为准则
├── CONTRIBUTING.md     # 贡献指南
├── Cargo.toml          # Rust 项目配置文件
├── Dockerfile          # Docker 容器构建文件
├── LICENSE             # 项目许可证文件
├── README.md           # 项目说明文件
├── icon-64.png         # 项目图标
└── icon.png            # 项目图标

2. 项目的启动文件介绍

FerrumC 的启动文件通常为项目根目录下的 ferrumc（Linux/macOS）或 ferrumc.exe（Windows）。以下是启动服务器的基本步骤：

• 确保已经安装了 Rust 编译器和 Cargo。
• 克隆仓库到本地：git clone https://github.com/ferrumc-rs/ferrumc.git。
• 进入项目目录：cd ferrumc。
• 构建项目：cargo build --release。
• 运行服务器：在 Windows 上使用 .\\ferrumc.exe，在 Linux/macOS 上使用 ./ferrumc。

启动服务器时，可以使用不同的命令和选项，如：

• setup：设置配置文件。
• import：导入世界数据。
• run：启动服务器（默认命令，如果没有给定其他命令）。
• help：打印帮助信息。

3. 项目的配置文件介绍

FerrumC 的配置文件为 config.toml。该文件在服务器目录中，可以通过以下命令生成：

./ferrumc setup

以下是 config.toml 文件的一些基本配置项：

• log：日志级别，可能的值有 trace、debug、info、warn、error。
• server_name：服务器名称。
• server_port：服务器端口。
• online_mode：是否在线模式，用于验证玩家身份。
• world_path：世界文件路径。

配置文件的具体内容可以根据个人需要进行编辑，以定制服务器的设置。

确保正确配置文件后，按照之前的启动步骤运行服务器，即可开始你的 Minecraft 服务器之旅。

ferrumc A reimplementation of the minecraft server in rust. 项目地址: https://gitcode.com/gh_mirrors/fe/ferrumc