FerrumC 使用教程

FerrumC 使用教程

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

1. 项目介绍

FerrumC 是一个使用 Rust 编程语言编写的 Minecraft 服务器实现。它充分利用了 Rust 语言的优势，实现了完全的多线程支持，提供了高性能和惊人的内存效率。该项目旨在成为一个完全替代官方服务器的解决方案，并兼容 vanilla Minecraft 客户端（版本 1.21.1）。

2. 项目快速启动

准备工作

• Rust 编译器（最新 nightly 版本）
• Cargo（随 Rust 一起安装）

安装

目前，服务器还不能用于生产环境，因为项目仍处于早期开发阶段。不过，你可以从源代码编译服务器，或者从 Github Actions 下载。

选项1：从 Github Actions 下载

1. 前往 Actions 选项卡。
2. 点击最新的构建。
3. 滚动到最下方的 Artifacts 部分。
4. 下载对应操作系统的构件（Windows、Linux 或 macOS）。

选项2：从源代码编译

1. 克隆仓库：

   git clone https://github.com/ferrumc-rs/ferrumc.git
   cd ferrumc
   

2. 构建项目：

   cargo build --release
   

   二进制文件将位于 target/release/。

使用

使用方法：ferrumc.exe [选项] [命令]

• 命令:

  • setup：设置配置。
  • import：导入世界数据。
  • run：启动服务器（默认命令，如果没有给出任何命令）。
  • help：打印此消息或给定子命令的帮助。

• 选项:

  • --log <日志级别>：[默认：debug] [可能的值：trace, debug, info, warn, error]。
  • -h, --help：打印帮助。

将 FerrumC 二进制文件 (ferrumc.exe 或 ferrumc，取决于操作系统）移动到期望的服务器目录。

在目录中打开终端，执行以下操作：

• （可选）生成配置文件：

  ./ferrumc setup
  

• 编辑生成的 config.toml 文件来自定义服务器设置。
• 导入现有世界：复制世界文件到服务器目录，或在 config.toml 文件中指定世界文件路径。默认导入路径是 import。
• 运行服务器：
  • Windows:

    .\ferrumc.exe
    

  • Linux/macOS:

    ./ferrumc
    

可以通过 --log=<级别> 来改变日志级别，例如：

.\ferrumc.exe --log=info

3. 应用案例和最佳实践

由于项目仍在开发中，具体的应用案例和最佳实践将在未来的文档中提供。目前，建议关注官方 Discord 服务器以获取最新信息和社区支持。

4. 典型生态项目

FerrumC 作为 Minecraft 服务器的开源项目，其生态项目可能包括但不限于：

• 插件开发：允许用户通过插件扩展服务器的功能。
• API 开发：提供程序化接口，使得开发者可以更容易地与服务器交互。
• 管理工具：帮助服务器管理员更有效地管理服务器。

随着项目的成熟，将会有更多生态项目涌现，进一步丰富 FerrumC 的功能和应用场景。

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