mirror of
https://github.com/bs-community/blessing-skin-server.git
synced 2024-12-21 06:19:38 +08:00
248 lines
8.4 KiB
Markdown
248 lines
8.4 KiB
Markdown
# Blessing Skin Server
|
||
|
||
由于开发者学业原因，本项目已经暂停开发。开源协议已改为 MIT。
|
||
|
||
优雅的开源 PHP Minecraft 皮肤站。[演示地址](https://skin.prinzeugen.net/)
|
||
|
||
|
||
|
||
特性：
|
||
-----------
|
||
|
||
- 支持 [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 等程序进行数据对接
|
||
- 完善的用户管理后台以及配置页面
|
||
- 多种后台配色
|
||
- 可以获取由用户皮肤生成的头像（example.com/avatar/{{size}}/username.png）
|
||
|
||
环境要求：
|
||
-----------
|
||
|
||
1. 一台支持 URL 重写的主机，Nginx、Apache 或 IIS
|
||
2. **PHP 版本 >= 5.4**
|
||
3. 目录的写权限~~（SAE 等不可写应用引擎的支持正在开发中）~
|
||
|
||
快速使用：
|
||
-----------
|
||
|
||
1. 下载源码，重命名 `config.example.php` 为 `config.php` 并配置你的数据库连接信息
|
||
2. 运行 `./setup/install.php`
|
||
3. 如果你是用的是 Nginx，请配置你的 `nginx.conf` 并加入重写规则
|
||
4. 注册一个新账户或者使用 `安装时所配置的账户` （管理员账户）登录
|
||
5. 可以上传你的皮肤&披风啦
|
||
6. 在你所使用的皮肤 Mod 配置文件中加入你的地址
|
||
7. 完成啦~
|
||
|
||
服务器配置：
|
||
------------
|
||
|
||
如果你使用 Apache 或者 IIS 作为 web 服务器（大部分的虚拟主机），那么恭喜你，我已经帮你把重写规则写好啦，开箱即用，无需任何配置~
|
||
|
||
如果你使用 Nginx，请在你的 `nginx.conf` 中加入如下 rewrite 规则**（重要）**：
|
||
|
||
```
|
||
rewrite ^/([^/]*).json$ /get.php?type=json&uname=$1 last;
|
||
rewrite ^/(skin|cape)/([^/-]*)(|-)(|alex|steve).png$ /get.php?type=$1&model=$4&uname=$2 last;
|
||
rewrite ^/(usm|csl)/([^/]*).json$ /get.php?type=json&uname=$2&api=$1 last;
|
||
rewrite ^/(usm|csl)/textures/(.*)$ /textures/$2 last;
|
||
# 用于获取皮肤头像
|
||
rewrite ^/avatar/(|[0-9]*/)([^/-]*).png$ /get.php?type=avatar&uname=$2&size=$1 last;
|
||
```
|
||
|
||
如果你将皮肤站放在子目录中，你需要把重写规则改成类似于**这样**：
|
||
|
||
```
|
||
rewrite ^/subdir/([^/]*).json$ /subdir/get.php?type=json&uname=$1 last;
|
||
```
|
||
|
||
注意 `^/` 后和 `/get.php` 前都要加上你的子目录名。
|
||
|
||
现在你可以访问 `http://example.com/username.json` 来得到你的首选 API 的 JSON 用户数据。另外一个 API 的 JSON 数据可以通过访问 `http://example.com/(usm|csl)/username.json` 得到。
|
||
|
||
上传完皮肤后，你就可以访问 `http://example.com/skin/username.png` 得到你的首选模型皮肤啦。 披风图片在这里：`http://example.com/cape/username.png` 。你还可以访问 `http://example.com/skin/username-(alex|steve).png` 来得到用户的 Alex/Steve 模型的皮肤文件（用户没上传则返回 404）。
|
||
|
||
数据对接：
|
||
------------
|
||
|
||
Blessing Skin Server 支持与 Authme、CrazyLogin、Discuz 等程序进行数据对接，只需在 `/admin/options.php` 中进行相应配置即可。
|
||
|
||
如果在插件配置中修改过用户名或者密码的字段，请自行修改 `对接数据表用户名字段` 等信息。
|
||
|
||
注意，`config.php` 中填写的数据库连接信息必须与被对接的程序的连接信息相同**（即同一个数据库）**。
|
||
|
||
如需适配其他程序，继承 `Database` 类并实现 `EncryptInterface` 与 `SyncInterface` 两个接口即可。
|
||
|
||
客户端配置：
|
||
------------
|
||
|
||
#### 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"` 字段按照你的 `config.php` 中配置的首选 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` 目录也不要惊讶哦。
|
||
|
||
如果一切都正常工作，你就可以在游戏中看到你的皮肤啦~
|
||
|
||
|
||
|
||
常见问题：
|
||
------------
|
||
|
||
#### 访问 `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 程序是基于 The MIT License 开放源代码的自由软件，你可以遵照 MIT 协议来修改和重新发布这一程序。
|
||
|
||
程序原作者为 [@printempw](https://prinzeugen.net/)，转载请注明。
|