FreeKill/README.md

66 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# FreeKill
![](https://img.shields.io/github/repo-size/notify-ctrl/freekill?color=green)
![](https://img.shields.io/github/languages/top/Notify-ctrl/FreeKill)
![](https://img.shields.io/github/license/notify-ctrl/freekill)
![](https://img.shields.io/github/v/tag/notify-ctrl/freekill)
![](https://img.shields.io/github/issues/notify-ctrl/freekill)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://app.gitter.im/#/room/#FreeKill:gitter.im)
![](https://img.shields.io/github/stars/notify-ctrl/freekill?style=social)
___
## 关于本项目
FreeKill是一款开源的三国杀游戏但其目的不在于补完官方所有武将而是着力于提供一个最适合DIY的框架。
## 项目文档
[FreeKill文档](https://qsgs-fans.github.io/FreeKill/usr/index.html)
### 依赖的库
以下是FreeKill运行所必不可少的依赖库
* [![](https://img.shields.io/badge/qt6-50D160?style=for-the-badge&logo=qt&logoColor=white)](https://www.qt.io)
* [![](https://img.shields.io/badge/lua5.4-030380?style=for-the-badge&logo=lua)](https://www.lua.org)
* [![](https://img.shields.io/badge/sqlite3-7ABEEA?style=for-the-badge&logo=sqlite)](https://www.sqlite.org)
* [![](https://img.shields.io/badge/libgit2-FFFFFF?style=for-the-badge&logo=git)](https://www.libgit2.org)
* [![](https://img.shields.io/badge/openssl-721412?style=for-the-badge&logo=openssl)](https://www.openssl.org)
FreeKill在编译过程中需要用到cmake, flex, bison, swig。
___
## 安装和使用
Release页面提供Windows版和Android版的打包好的文件请直接下载使用。
Linux用户则需要从头开始编译不过对于ArchLinux上可以从AUR中安装
$ yay -S freekill
初始界面是连入服务器的界面,可以选择加入服务器,也可以单机开始游戏。
___
## 如何构建
关于如何从头构建FreeKill详见[编译教程](https://qsgs-fans.github.io/FreeKill/inner/01-compile.html)。
___
## 参与其中
若您能为FreeKill做出贡献我们将不胜感激。
如若您能提出良好的建议请fork本仓库然后提交PR。您也可以单纯只提出一个issue或者为repo点一个star。再次感谢您的帮助。
有关做出贡献的细节,详见`CONTRIBUTING.md`。(施工中)
___
## 许可证
本仓库使用GPLv3作为许可证。详见`LICENSE`文件。