关于FreeKill#
FreeKill是一款免费开源的桌游引擎(至少现阶段愿景如此)。本文档介绍了FreeKill的方方面面, 目标是让玩家、拓展作者、开发者以及想要参与其中的人找到入手FreeKill的参考点。
本文档使用 Sphinx 构建,选用的主题是 Book 。 文档的源码可以在 Github 和 Gitee 找到。 我们十分欢迎大家来贡献文档(并且十分需要贡献者)。有关对文档的贡献,详见 向文档做出贡献 。
开始阅读#
本文档是根据目标受众的不同而组织的:
写给玩家 主要为玩家讲述游戏的下载与使用。
写给拓展主 讲述了拓展和资源包的开发,以及其他编程相关指引等。
写给服主 讲述联机服务器搭建方法。
写给开发者 讲述了FreeKill的C++层运行逻辑,以及如何贡献。
FreeKill文档的目标#
FreeKill文档的目标是作为FreeKill项目的核心参考手册,为感兴趣的人提供尽可能详尽的指引。 代码贡献者以及文档编写者都可以来共同编写这份文档。
文档的内容预计会包含:
API参考,示例与教程等
针对底层运行原理的说明与贡献指引
客户端与服务端后台的使用方法