mirror of
https://github.com/Qsgs-Fans/FreeKill.git
synced 2024-11-16 03:32:34 +08:00
357c692a69
* fixbug: card use history * doc for doRequest * add badges for readme * update readme
63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
# 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)
|
||
![](https://img.shields.io/github/stars/notify-ctrl/freekill?style=social)
|
||
|
||
___
|
||
|
||
## 关于本项目
|
||
|
||
FreeKill是一款开源的三国杀游戏,但其目的不在于补完官方所有武将,而是着力于提供一个最适合DIY的框架。
|
||
|
||
### 依赖的库
|
||
|
||
以下是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
|
||
|
||
初始界面是连入服务器的界面,可以选择加入服务器,也可以单机开始游戏。
|
||
|
||
DIY教程仍在施工中……
|
||
|
||
___
|
||
|
||
## 如何构建
|
||
|
||
关于如何从头构建FreeKill,详见[编译教程](./doc/dev/compile.md)。
|
||
|
||
___
|
||
|
||
## 参与其中
|
||
|
||
若您能为FreeKill做出贡献,我们将不胜感激。
|
||
|
||
如若您能提出良好的建议,请fork本仓库然后提交PR。您也可以单纯只提出一个issue,或者为repo点一个star。再次感谢您的帮助。
|
||
|
||
有关做出贡献的细节,详见`CONTRIBUTING.md`。(施工中)
|
||
|
||
___
|
||
|
||
## 许可证
|
||
|
||
本仓库使用GPLv3作为许可证。详见`LICENSE`文件。
|