MacHu-GWU / acore_conf-project

Azerothcore WOW *.conf file management.

---

Welcome to acore_conf Documentation

背景

AzerothCore (acore) 是一个开源的魔兽世界模拟器, 其代码质量以及文档是目前 (2023 年) 我看来所有的开源魔兽世界模拟器中最好的. 它有一个 .conf 配置文件格式用于定义服务器的各种配置. 这个格式不是 acore 独有的, 而是所有的魔兽世界模拟器, 包括各个不同的资料片几乎都用的这个格式.

Links

• How configuration files are composed: AzerothCore 官方对 config file 格式的解释.
• authserver.conf: AzerothCore 官方 GitHub 源码中的初始 authserver.conf 文件.
• worldserver.conf: AzerothCore 官方 GitHub 源码中的初始 worldserver.conf 文件.

关于本项目

本项目是一个简单的 Python 工具, 用于管理, 修改 .conf 文件. 使得开发者可以用业内比较通用的 JSON 格式对 .conf 进行修改.

用法

from acore_conf.api import apply_changes

apply_changes(
    "/path/to/authserver.conf.dist",
    "/path/to/authserver.conf",
    data={"worldserver": {"DataDir": "/home/azeroth-server/data"}},
)

更多 API 详细文档请参考下面的链接

• acore_conf.api.update_config_content
• acore_conf.api.apply_changes

Install

acore_conf is released on PyPI, so all you need is to:

$ pip install acore-conf

To upgrade to latest version:

$ pip install --upgrade acore-conf