mirror of
https://github.com/Qsgs-Fans/FreeKill.git
synced 2024-11-16 03:32:34 +08:00
8aa8775fd6
Add flake.nix to project, so this project can be built with nix. Also: - Fix a died link in README. - Add missing dependencies in docs for Ubuntu and Arch (not tested).
64 lines
2.2 KiB
Markdown
64 lines
2.2 KiB
Markdown
# FreeKill
|
||
|
||
|
||
|
||
|
||
|
||
|
||
[](https://app.gitter.im/#/room/#FreeKill:gitter.im)
|
||
|
||
|
||
___
|
||
|
||
## 关于本项目
|
||
|
||
FreeKill是一款开源的三国杀游戏，但其目的不在于补完官方所有武将，而是着力于提供一个最适合DIY的框架。
|
||
|
||
### 依赖的库
|
||
|
||
以下是FreeKill运行所必不可少的依赖库：
|
||
|
||
* [](https://www.qt.io)
|
||
* [](https://www.lua.org)
|
||
* [](https://www.sqlite.org)
|
||
* [](https://www.libgit2.org)
|
||
* [](https://www.openssl.org)
|
||
|
||
FreeKill在编译过程中，需要用到cmake, flex, bison, swig。
|
||
|
||
___
|
||
|
||
## 安装和使用
|
||
|
||
Release页面提供Windows版和Android版的打包好的文件，请直接下载使用。
|
||
|
||
Linux用户则需要从头开始编译，不过对于ArchLinux上，可以从AUR中安装：
|
||
|
||
$ yay -S freekill
|
||
|
||
初始界面是连入服务器的界面，可以选择加入服务器，也可以单机开始游戏。
|
||
|
||
DIY教程仍在施工中……
|
||
|
||
___
|
||
|
||
## 如何构建
|
||
|
||
关于如何从头构建FreeKill，详见[编译教程](https://notify-ctrl.github.io/FreeKill/dev/compile.html)。
|
||
|
||
___
|
||
|
||
## 参与其中
|
||
|
||
若您能为FreeKill做出贡献，我们将不胜感激。
|
||
|
||
如若您能提出良好的建议，请fork本仓库然后提交PR。您也可以单纯只提出一个issue，或者为repo点一个star。再次感谢您的帮助。
|
||
|
||
有关做出贡献的细节，详见`CONTRIBUTING.md`。（施工中）
|
||
|
||
___
|
||
|
||
## 许可证
|
||
|
||
本仓库使用GPLv3作为许可证。详见`LICENSE`文件。
|