# 新月杀
**Repository Path**: notify-ctrl/FreeKill
## Basic Information
- **Project Name**: 新月杀
- **Description**: GitHub仓库镜像，请勿在此仓库发起PR。
文档请看https://fkbook-all-in-one.readthedocs.io
- **Primary Language**: Lua
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 127
- **Forks**: 19
- **Created**: 2023-02-08
- **Last Updated**: 2025-10-28
## Categories & Tags
**Categories**: games
**Tags**: Qml, Lua, Qt, sanguosha, 三国杀
## README
# FreeKill, 一个开源的桌游框架
[](https://discord.gg/tp35GrQR6v)
___
## 关于本项目
欢迎来到FreeKill，挥洒你的创意！FreeKill是一款开源的桌游引擎，在多个平台可用，
目前支持Linux、Mac、Windows、Android，以及FreeBSD。通过FreeKill，你可以创建自己想要的桌游玩法，
亦可基于已经完成的桌游对其进行进一步的拓展。
利用FreeKill开发的桌游便于联机，框架为你的桌游提供好了断线重连、录像与回放等基本功能，
同时具有基本的游戏大厅。
FreeKill使用Lua语言实现了性能优秀的单线程异步服务端，并且使用Qt Quick
实现GUI界面，充分发挥图形硬件性能。
详细文档请查看。
本Repo主要提供客户端的Qt C++支持，以及服务端的少数支持，服务端仅供进行单机游戏。
因此本Repo中包含的脚本仅供release时打包使用。关于完整功能请移步其他仓库：
- 基于STL的服务端：
- 维护所有脚本文件的仓库：
- 本项目的文档（！需要维护）：
未来可能会从本Repo中删除所有脚本，转而在程序运行时强制要求用户安装freekill-core包。
目前已经实现的桌游玩法的一部分：
- 三国杀（可进行拓展；暂时耦合在项目内部，在未来将成为独立的Repo）
- 中国象棋与国际象棋（）
- 红心大战与桥牌等（）
___
## 安装和使用
Release页面提供Windows版和Android版的打包好的文件，请直接下载使用。
如需版本更新的话，请直接覆盖到原先的安装上更新，无需卸载旧版。
Linux或BSD用户则需要从头开始编译（[详细编译流程在此](https://fkbook-all-in-one.readthedocs.io/zh-cn/latest/develop/02-env.html)）。
以Debian为例：
```sh
$ sudo apt install git gcc g++ cmake swig
$ sudo apt install liblua5.4-dev libsqlite3-dev libreadline-dev libssl-dev libgit2-dev
# qt6-declarative-dev - qml, qt6-tools-dev - LinguistTools
$ sudo apt install qt6-base-dev qt6-declarative-dev qt6-multimedia-dev qt6-tools-dev
```
```sh
$ git clone https://github.com/Qsgs-Fans/FreeKill.git
$ cd FreeKill
$ mkdir build && cd build
$ cmake .. && make -j8
```
此外ArchLinux用户也可从AUR中安装：
```sh
$ yay -S freekill
```
Mac 用户也需要从头开始编译
```sh
# install xcode and homebrew, note: qt need full xcode
$ brew install cmake libgit2 lua qt pkgconfig vulkan-headers swig
$ git clone https://github.com/Qsgs-Fans/FreeKill.git
$ cd FreeKill
$ mkdir build && cd build
$ cmake .. && make -j8
$ cd .. && ./build/FreeKill
```
更多关于游玩细节与操作请[查看这里](https://fkbook-all-in-one.readthedocs.io/zh-cn/latest/for-players/index.html)。
___
## 参与其中
若您能为新月杀做出贡献，我们将不胜感激。以下是关于贡献的一些注意事项：
- 项目的所有lua文件（test/除外）由特殊仓库进行管理，
因此请不要直接修改本仓库中的Lua文件，更多信息请查看freekill-core的README页面
- 只有本仓库是在Github上托管与实际维护的，开发组对其他官方武将的实现则分散在许多小仓库中，
并且在Gitee上维护。这些仓库都在我们的组织账号之下：
- 本项目以及不少拓展包项目的需求都写在Issue中，还请善加查阅。
___
## 许可证
本仓库使用GPLv3作为许可证。详见`LICENSE`文件。
___
## 点一下小星星呗！
[](https://star-history.com/#Qsgs-Fans/FreeKill&Date)