From 2fce503b63f59a3d9972399fe7d305b5b21e9e94 Mon Sep 17 00:00:00 2001
From: printempw <h@prinzeugen.net>
Date: Sat, 23 Jul 2016 17:39:41 +0800
Subject: [PATCH] update README

---
 README.md | 266 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 264 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 45813165..3b64695d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,267 @@
 # Blessing Skin Server
 
-已更新 V3，文档正在撰写中~
+优雅的开源 PHP Minecraft 皮肤站，现已更新至 v3。
 
-V2 文档在 [这里](https://github.com/printempw/blessing-skin-server/tree/v2)。
+![screenshot](https://img.prinzeugen.net/image.php?di=FIQD)
+
+特性：
+-----------
+
+- 支持 [UniSkinAPI](https://github.com/RecursiveG/UniSkinServer/blob/master/doc/UniSkinAPI_zh-CN.md)
+- 支持 [CustomSkinLoader API](https://github.com/xfl03/CustomSkinLoaderAPI/blob/master/CustomSkinAPI/CustomSkinAPI_en.md)
+- 同时支持旧版样式链接
+- ~~支持与 Authme、CrazyLogin、Discuz 等程序进行数据对接~~ V3 的数据对接还在开发中
+- 支持一个用户多个角色
+- 皮肤库、衣柜功能
+- 积分系统，防止用户恶意上传/添加角色
+- 完善的用户管理后台以及配置页面
+- 多种后台配色
+- 可以获取由皮肤生成的头像
+
+面向开发者们的特性：
+-----------
+
+- MVC 设计模式，使用强大的 Blade 模板引擎和 Eloquent ORM
+- 使用 Composer、bower 等包管理器管理依赖
+- 几乎所有请求都使用 ajax 发送
+- 使用 CSS 预处理器 Sass
+- 使用 gulp 作为前端构建工具
+
+
+环境要求：
+-----------
+
+1. 一台支持 URL 重写的主机，Nginx、Apache 或 IIS
+2. **PHP 版本 >= 5.4**
+3. PHP 安装 GD 扩展库
+4. 目录的写权限
+5. 不支持安装在子目录
+
+快速使用：
+-----------
+
+1. 下载发布的打包版源码，重命名 `.env.example` 为 `.env` 并配置你的数据库连接信息
+2. 运行 `./setup/install.php`
+3. 如果你是用的是 Nginx，请配置你的 `nginx.conf` 并加入重写规则
+4. 注册一个新账户或者使用 `安装时所配置的账户` （管理员账户）登录
+5. 在角色管理面板使用你的 Minecraft 角色名添加一个新角色
+6. 在皮肤库上传你的皮肤&披风（可设为私有）并添加至衣柜
+7. 应用皮肤&披风到你的角色
+8. 在你所使用的皮肤 Mod 配置文件中加入你的地址
+9. 完成啦~
+
+自行构建：
+------------
+
+普通用户是用不到的，但是如果你想要自定义 Blessing Skin Server 的一些内容的话，就需要自己由源码构建啦。不推荐不熟悉 shell 操作以及不想折腾的用户使用。
+
+先从 git 上 clone 源码：
+
+`$ git clone https://github.com/printempw/blessing-skin-server.git`
+
+使用 composer 安装 PHP 依赖：
+
+`$ composer install`
+
+使用 bower 安装前端依赖库：
+
+`$ bower install`
+
+使用 gulp 构建前端代码：
+
+`$ gulp copy`
+
+`$ gulp build`
+
+可以开始使用啦~
+
+服务器配置：
+------------
+
+如果你使用 Apache 或者 IIS 作为 web 服务器（大部分的虚拟主机），那么恭喜你，我已经帮你把重写规则写好啦，开箱即用，无需任何配置~
+
+如果你使用 Nginx，请在你的 `nginx.conf` 中加入如下规则**（重要）**：
+
+```
+location / {
+    try_files $uri $uri/ /index.php?$query_string;
+}
+```
+
+现在你可以访问 `http://example.com/{ player_name }.json` 来得到你的首选 API（可在后台配置）的 JSON 用户数据。另外一个 API 的 JSON 数据可以通过访问 `http://example.com/(usm|csl)/{ player_name }.json` 得到。
+
+上传完皮肤后，你就可以访问 `http://example.com/skin/{ player_name }.png` 得到你的首选模型皮肤啦。 披风图片在这里：`http://example.com/cape/{ player_name }.png` 。
+
+客户端配置：
+------------
+
+#### CustomSkinLoader 13.1 及以上（推荐）
+
+CustomSkinLoader 13.1 经过作者的完全重写，支持了 CSL API，并且使用了高端洋气的 JSON 配置文件。你问我 JSON 是什么？为什么不去问问神奇海螺呢。
+
+配置文件位于 `.minecraft/CustomSkinLoader/CustomSkinLoader.json`，你需要在 loadlist 数组最顶端加入你的皮肤站配置。
+
+举个栗子（原来的 JSON 长这样）：
+
+```json
+{
+    "enable": true,
+    "loadlist": [
+        {
+            "name": "Mojang",
+            "type": "MojangAPI"
+        },
+        {
+            "name": "SkinMe",
+            "type": "UniSkinAPI",
+            "root": "http://www.skinme.cc/uniskin/"
+        }
+    ]
+}
+```
+
+你需要将其修改成像这样：
+
+```json
+{
+    "enable": true,
+    "loadlist": [
+        {
+            "name": "YourSkinServer",
+            "type": "CustomSkinAPI",
+            "root": "http://example.com/"
+        },
+        {
+            "name": "Mojang",
+            "type": "MojangAPI"
+        },
+        {
+            "name": "SkinMe",
+            "type": "UniSkinAPI",
+            "root": "http://www.skinme.cc/uniskin/"
+        }
+    ]
+}
+```
+
+`"type"` 字段按照你的后台中配置的首选 API 来填(CustomSkinAPI|UniSkinAPI)，CSL 13.1 版是支持三种加载方式的~~万受♂之王~~
+
+如果还是不会填的话，请查看 CSL 开发者的 [MCBBS 发布贴](http://www.mcbbs.net/thread-269807-1-1.html)。
+
+#### CustomSkinLoader 13.1 版以下：
+
+在 `.minecraft/CustomSkinLoader/skinurls.txt` 中添加你的皮肤站地址：
+
+```
+http://example.com/skin/*.png
+http://skins.minecraft.net/MinecraftSkins/*.png
+http://minecrack.fr.nf/mc/skinsminecrackd/*.png
+http://www.skinme.cc/MinecraftSkins/*.png
+```
+
+注意你需要将你的皮肤站地址放在配置文件最上方以优先加载。
+
+同理在 `.minecraft/CustomSkinLoader/capeurls.txt` 中加入：
+
+```
+http://example.com/cape/*.png
+```
+
+#### UniSkinMod 1.4 版及以上（推荐）
+
+配置文件位于 `.minecraft/config/UniSkinMod/UniSkinMod.json`。
+
+举个栗子（原来的 JSON 长这样）：
+
+```json
+{
+  "rootURIs": [
+    "http://www.skinme.cc/uniskin",
+    "https://skin.prinzeugen.net"
+  ],
+  "legacySkinURIs": [],
+  "legacyCapeURIs": []
+}
+```
+
+你需要在 `rootURIs` 字典中加入你的皮肤站的地址：
+
+```json
+{
+  "rootURIs": [
+    "http://www.skinme.cc/uniskin",
+    "https://skin.prinzeugen.net",
+    "http://example.com"
+  ],
+  "legacySkinURIs": [],
+  "legacyCapeURIs": []
+}
+```
+
+如果你的皮肤站首选 API 为 CustomSkinLoader API 的话，你需要在 UniSkinMod 配置文件中填入类似于 `http://example.com/usm` （添加后缀）来支持 UniSkinMod。
+
+配置 `rootURIs` 后，`legacySkinURIs` 和 `legacyCapeURIs` 可以不用配置。详见[文档](https://github.com/RecursiveG/UniSkinMod/blob/1.9/README.md)。
+
+#### UniSkinMod 1.2 及 1.3 版
+
+在你 MC 客户端的 `.minecraft/config/UniSkinMod.cfg` 中加入你的皮肤站根地址：
+
+举个栗子：
+
+```
+# SkinMe Default
+Root: http://www.skinme.cc/uniskin
+# Your Server
+Root: http://example.com
+```
+
+如果你把皮肤站安装到子目录的话，请一起带上你的子目录。
+
+#### UniSkinMod 1.2 版以下
+
+同样是在 `.minecraft/config/UniSkinMod.cfg` 中配置你的皮肤站地址，但是稍有点不一样。旧版的 UniSkinMod 是不支持 Json API 的，而是使用了传统图片链接的方式（其实这样的话皮肤站也好实现）：
+
+举个栗子：
+
+```
+Skin: http://skins.minecraft.net/MinecraftSkins/%s.png
+Cape: http://skins.minecraft.net/MinecraftCloaks/%s.png
+# Your Server
+Skin: http://example.com/skin/%s.png
+Cape: http://example.com/cape/%s.png
+```
+
+这是通过 URL 重写（伪静态）实现的，所以皮肤站目录下没有 `skin` 和 `cape` 目录也不要惊讶哦。
+
+如果一切都正常工作，你就可以在游戏中看到你的皮肤啦~
+
+顺带一提用户中心有一个自动生成配置的功能哦~
+
+![screenshot2](https://img.prinzeugen.net/image.php?di=42U6)
+
+常见问题：
+------------
+
+#### 访问 `example.com/skin/xxx.png ` 404?
+
+请确认你的伪静态（URL 重写）是否配置正确。
+
+#### 500 错误？
+
+本程序使用了一些 PHP 5.4 的新特性，请确保你的 PHP 版本 >= 5.4
+
+#### 游戏中皮肤不显示？
+
+请先确认你的皮肤站 URL 重写规则已经配置正确，并且可以正常获取皮肤图片。
+
+如果还是不能显示皮肤，请阅读您所使用的皮肤 Mod 的 FAQ。
+
+还是不行的话，请在启动器开启调试模式，并且查看所有关于 skin 的日志， CSL 的日志位于 `.minecraft/CustomSkinLoader/CustomSkinLoader.log`。
+
+一般来说看了就可以明白了，如果还是不明白请邮件 [联系我](mailto:h@prinzeugen.net)（带上你的日志）。
+
+版权：
+------------
+Blessing Skin Server 程序是基于 GUN Public License 3.0 开放源代码的自由软件，你可以遵照 GPL 协议来修改和重新发布这一程序。
+
+程序原作者为 [@printempw](https://prinzeugen.net/)，转载请注明。