.. SPDX-License-Identifier:	CC-BY-NC-SA-4.0

FreeKill 文档
=================

欢迎来到Freekill文档。Freekill是一个开源的桌游引擎，包含客户端、服务端程序，
并为用户提供了自定义游戏内容的能力。

.. note::

  也称新月之书。FreeKill是新月杀的内部代号，在文档中基本上会用FreeKill称呼项目。

  在项目的规划中，FreeKill应当有能力支持其他类型的桌游（例如五子棋等）。而“新月杀”这个称呼特指FreeKill对三国杀的实现，但是现阶段FreeKill只支持新月杀这一个游戏，因此混用两个称呼亦无不可。

- :doc:`about/index` 包含了关于Freekill的信息、发展历程，以及如何为Freekill做出贡献
- :doc:`for-players/index` 介绍了如何下载客户端、加入服务器、安装拓展包以及其他对玩家有用的内容
- :doc:`for-creators/index` 介绍了如何创造你自己的角色、卡牌、技能、游戏模式、资源包以及更多丰富Freekill内容的方法
- :doc:`for-boardgame-creators/index` 介绍了如何利用Freekill创建全新桌游
- :doc:`for-server-hosts/index` 介绍了如何搭建你的个人服务器（公开服、私服、局域网临时服等）
- :doc:`for-devs/index` 介绍了Freekill的底层运行机制，这些机制影响所有基于Freekill开发的拓展

.. toctree::
   :titlesonly:
   :hidden:

   about/index.rst
   for-players/index.rst
   for-creators/index.rst
   for-boardgame-creators/index.rst
   for-server-hosts/index.rst
   for-devs/index.rst