blessing-skin-server/README.md

175 lines
6.3 KiB
Markdown
Raw Normal View History

- <b>简体中文</b>
2018-09-24 08:38:47 +08:00
- [English](./README_EN.md)
2017-01-21 13:55:34 +08:00
2017-01-01 23:09:18 +08:00
<p align="center"><img src="https://img.blessing.studio/images/2017/01/01/bs-logo.png"></p>
2016-01-17 16:18:03 +08:00
2017-01-01 23:09:18 +08:00
<p align="center">
2019-04-22 19:29:54 +08:00
<a href="https://circleci.com/gh/bs-community/blessing-skin-server"><img src="https://flat.badgen.net/circleci/github/bs-community/blessing-skin-server" alt="Circle CI Status"></a>
<a href="https://codecov.io/gh/bs-community/blessing-skin-server/branch"><img src="https://flat.badgen.net/codecov/c/github/bs-community/blessing-skin-server" alt="Codecov" /></a>
2019-03-15 11:48:59 +08:00
<a href="https://github.com/bs-community/blessing-skin-server/releases"><img src="https://flat.badgen.net/github/release/bs-community/blessing-skin-server" alt="Latest Stable Version"></a>
2019-02-28 09:32:40 +08:00
<img src="https://flat.badgen.net/badge/PHP/7.1.8+/orange" alt="PHP 7.1.8+">
2018-11-25 15:12:53 +08:00
<img src="https://flat.badgen.net/github/license/bs-community/blessing-skin-server" alt="License">
2017-01-01 23:09:18 +08:00
</p>
2016-09-15 11:21:39 +08:00
优雅的开源 Minecraft 皮肤站,现在,回应您的等待。
2016-04-11 17:29:40 +08:00
Blessing Skin 是一款能让您上传、管理和分享您的 Minecraft 皮肤和披风的 Web 应用程序。与修改游戏材质包不同的是,所有人都能在游戏中看到各自的皮肤和披风(当然,前提是玩家们要使用同一个皮肤站)。
2016-09-10 23:35:43 +08:00
2019-03-15 11:48:59 +08:00
Blessing Skin 是一个开源的 PHP 项目,这意味着您可以自由地在您的服务器上部署它。
2016-08-30 16:25:49 +08:00
2019-03-26 15:55:59 +08:00
## 特性
- 完整实现了一个皮肤站该有的功能
- 支持单用户多个角色
- 通过皮肤库来分享您的皮肤和披风!
- 易于使用
- 可视化的用户、角色、材质管理页面
- 详细的站点配置页面
- 多处 UI/UX 优化只为更好的用户体验
- 安全
- 支持多种安全密码 Hash 算法
2019-03-17 12:49:15 +08:00
- 注册可要求 Email 验证
- 防止恶意请求的积分系统
- 强大的可扩展性
- 多种多样的插件
2019-03-17 12:49:15 +08:00
- 支持与 Authme/Discuz 等程序的用户数据对接(插件)
- 支持自定义 Yggdrasil API 外置登录系统(插件)
2019-03-26 15:55:59 +08:00
## 环境要求
Blessing Skin 对您的服务器有一定的要求。_在大多数情况下下列所需的 PHP 扩展已经开启。_
2016-07-23 17:39:41 +08:00
- 一台支持 URL 重写的主机Nginx、Apache 或 IIS
2019-02-28 09:32:40 +08:00
- **PHP >= 7.1.8** [(服务器不支持?)](https://github.com/bs-community/blessing-skin-server/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E)
- 安装并启用如下 PHP 扩展:
- OpenSSL
- PDO
- Mbstring
- Tokenizer
- GD
2018-07-20 17:32:27 +08:00
- XML
- Ctype
- JSON
- fileinfo
2016-07-23 17:39:41 +08:00
2019-03-26 15:55:59 +08:00
## 快速使用
2018-11-25 15:12:53 +08:00
请参阅 [Wiki - 快速安装向导](https://github.com/bs-community/blessing-skin-server/wiki/%E5%BF%AB%E9%80%9F%E5%AE%89%E8%A3%85%E5%90%91%E5%AF%BC)。
![screenshot](https://img.blessing.studio/images/2017/07/29/2017-06-16_15.54.16.png)
2016-07-23 17:39:41 +08:00
2019-03-26 15:55:59 +08:00
## 插件系统
2017-07-30 15:39:44 +08:00
Blessing Skin 提供了强大的插件系统,您可以通过添加多种多样的插件来为您的皮肤站添加功能。
2017-07-30 15:39:44 +08:00
2018-11-25 15:12:53 +08:00
详情请参阅 [Wiki - 插件系统介绍](https://github.com/bs-community/blessing-skin-server/wiki/%E6%8F%92%E4%BB%B6%E7%B3%BB%E7%BB%9F%E4%BB%8B%E7%BB%8D)。
2017-07-30 15:39:44 +08:00
2019-03-26 15:55:59 +08:00
## 支持并赞助 Blessing Skin
如果您觉得这个软件对您很有帮助,欢迎通过赞助来支持开发!
目前可在 [爱发电](https://afdian.net/@blessing-skin) 上赞助。
### Sponsors
2019-03-29 16:58:50 +08:00
<table>
<tbody>
<tr>
<td align=center>
<a href="https://afdian.net/u/68d07bf851fc11e98e5652540025c377">
2019-04-10 12:48:37 +08:00
<img src="https://pic.afdiancdn.com/user/68d07bf851fc11e98e5652540025c377/avatar/59b21c3d053a595086d4b6cf88877bfa_w640_h640_s57.jpg?imageView2/1/w/120/h/120">
2019-03-29 16:58:50 +08:00
<br>
2019-04-10 12:48:37 +08:00
dz_paji
2019-03-29 16:58:50 +08:00
</a>
</td>
</tr>
</tbody>
</table>
2019-03-26 15:55:59 +08:00
### Backers
2019-03-29 16:58:50 +08:00
<table>
<tbody>
<tr>
<td align=center>
<a href="https://afdian.net/u/a08078a051fc11e9ab4c52540025c377">
<img src="https://pic.afdiancdn.com/default/avatar/default-avatar@2x.png?imageView2/1/w/75/h/75">
<br>
pppwaw
</a>
</td>
<td align=center>
<a href="https://afdian.net/@tnqzh123">
<img src="https://pic.afdiancdn.com/user/97a0416ca47211e8849452540025c377/avatar/d2f6d8d489cb952ff29740e715b067c0_w768_h768_s211.jpg?imageView2/1/w/75/h/75">
<br>
Little_Qiu
</a>
</td>
2019-03-31 08:47:16 +08:00
<td align=center>
<a href="https://afdian.net/@hempflower">
<img src="https://pic.afdiancdn.com/user/0f396eb2a37c11e8b93452540025c377/avatar/bee35eb0f5cd2a506eb34c6e13de1154_w160_h160_s0.jpg?imageView2/1/w/75/h/75">
<br>
麻花
</a>
</td>
2019-04-05 08:41:48 +08:00
<td align=center>
<a href="https://afdian.net/@mgcraft">
<img src="https://pic.afdiancdn.com/user/de46a20a56f111e981a452540025c377/avatar/ab13b606230af1b5f5879538d9e37c43_w640_h640_s22.jpeg?imageView2/1/w/75/h/75">
<br>
Mangocraft
</a>
</td>
2019-03-29 16:58:50 +08:00
</tr>
</tbody>
</table>
2019-03-26 15:55:59 +08:00
## 自行构建
2018-09-23 23:54:54 +08:00
如果你想为此项目作贡献,或者抢先尝试未发布的新功能,你应该先用 GitHub 上的代码部署。
2016-07-23 17:39:41 +08:00
**不推荐不熟悉 shell 操作以及不想折腾的用户使用。**
2016-07-23 17:39:41 +08:00
2018-09-23 23:54:54 +08:00
请先确保您安装好以下工具:
2016-07-23 17:39:41 +08:00
2018-09-23 23:54:54 +08:00
- [Git](https://git-scm.org)
- [Node.js](https://nodejs.org)
- [Yarn](https://yarnpkg.com)
- [Composer](https://getcomposer.org)
2016-07-23 17:39:41 +08:00
2018-09-23 23:54:54 +08:00
从 GitHub 上 clone 源码并安装依赖:
2017-07-29 21:10:14 +08:00
2017-11-08 19:10:15 +08:00
```bash
2018-11-25 15:12:53 +08:00
git clone https://github.com/bs-community/blessing-skin-server.git
2018-09-23 23:54:54 +08:00
cd blessing-skin-server
composer install
yarn
2017-07-29 21:10:14 +08:00
```
构建前端代码!
2016-07-23 17:39:41 +08:00
2017-11-08 19:10:15 +08:00
```bash
2018-09-23 23:54:54 +08:00
yarn build
2016-07-23 17:57:59 +08:00
```
2016-07-23 17:39:41 +08:00
接下来请参考「快速安装向导」进行后续安装。
2017-01-02 10:53:19 +08:00
2019-03-26 15:55:59 +08:00
## 国际化i18n
2019-03-17 12:49:15 +08:00
Blessing Skin 可支持多种语言,当前支持英语(`en`)和简体中文(`zh_CN`)。
当然,您也可以添加您自己的语言。请参阅 [Wiki - 添加其它语言 [i18n]](https://github.com/bs-community/blessing-skin-server/wiki/%E6%B7%BB%E5%8A%A0%E5%85%B6%E4%BB%96%E8%AF%AD%E8%A8%80-%5Bi18n%5D)
如果您愿意将您的翻译贡献出来,欢迎参与 [我们的 Crowdin 项目](https://crowdin.com/project/bs-i18n)。
2019-03-26 15:55:59 +08:00
## 问题报告
2018-11-25 15:12:53 +08:00
请参阅 [Wiki - 报告问题的正确姿势](https://github.com/bs-community/blessing-skin-server/wiki/%E6%8A%A5%E5%91%8A%E9%97%AE%E9%A2%98%E7%9A%84%E6%AD%A3%E7%A1%AE%E5%A7%BF%E5%8A%BF)。
2017-01-02 10:53:19 +08:00
2019-03-26 15:55:59 +08:00
## 版权
2019-03-30 13:20:46 +08:00
MIT License
2019-03-30 13:20:46 +08:00
Copyright (c) 2016-present The Blessing Skin Community
2017-11-07 21:20:32 +08:00
程序原作者为 [@printempw](https://blessing.studio/),转载请注明。