2016-01-22 16:33:22 +08:00
# Blessing Skin Server
2016-01-17 16:18:03 +08:00
2016-09-10 23:35:43 +08:00
Blessing Skin Server is a web application for storing and managing skins in Minecraft. You can get your skin back easily even in an offline Minecraft server with Blessing Skin Server.
2016-04-11 17:29:40 +08:00
2016-09-10 23:35:43 +08:00
The framework used by this project is Laravel. Older versions of Blessing Skin Server are available on other branches.
中文版 README 在[这里](https://github.com/printempw/blessing-skin-server/wiki/README---zh_CN)。
2016-08-30 16:25:49 +08:00
2016-07-24 14:00:14 +08:00
![screenshot ](https://img.prinzeugen.net/image.php?di=VH7Z )
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Feature
2016-07-23 17:39:41 +08:00
-----------
2016-09-10 23:35:43 +08:00
- Support [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 ) and legacy links
- Adapt to Authme, CrazyLogin, Discuz and so on
- One user, many players
- Skin library and user closets
- Score system to provent evil requests
- Easy-using user management and option pages
- Many color schemes
- Avatars generated from skins
Requirements
2016-07-23 17:39:41 +08:00
-----------
2016-09-10 23:35:43 +08:00
Blessing Skin Server has a few system requirements.
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
1. Web server which supports URL rewriting
2. **PHP version >= 5.5.9**
3. GD PHP Extension
4. Writeable directory
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Quick Start Install
2016-07-23 17:39:41 +08:00
-----------
2016-09-10 23:35:43 +08:00
1. Download the latest release and unzip it to the location you want to install
2. Rename `.env.example` to `.env` and configure your database there.(For windows, just rename it to `.env.` , the last dot will be removed automatically)
3. For Nginx users, add rewrite rules to your `nginx.conf`
4. Access `/setup/index.php` in your browser
5. Congratulations! Upload your skins and have fun!
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Developer Install
2016-07-23 17:39:41 +08:00
------------
2016-09-10 23:35:43 +08:00
Download and deploy from git only if you want to modify something in Blessing Skin Server.
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
**You'd better have some experience on shell to continue.**
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Clone the code from GitHub:
2016-07-23 17:39:41 +08:00
2016-07-23 17:57:59 +08:00
```
$ git clone https://github.com/printempw/blessing-skin-server.git
```
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Install php dependencies using composer:
2016-07-23 17:39:41 +08:00
2016-07-23 17:57:59 +08:00
```
$ composer install
```
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Install front-end dependencies using bower:
2016-07-23 17:39:41 +08:00
2016-07-23 17:57:59 +08:00
```
$ bower install
```
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Build the things!
2016-07-23 17:39:41 +08:00
2016-07-23 17:57:59 +08:00
```
2016-08-30 16:25:49 +08:00
$ gulp
2016-07-23 17:57:59 +08:00
```
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Congrats! You made it. More general install docs here in case you got stuck.
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
Configure the Web Server
2016-07-23 17:39:41 +08:00
------------
2016-09-10 23:35:43 +08:00
For Apache(most of the virtual hosts) and IIS users, there is already some pre-configured files for you, and what you need to do is just to enjoy!
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
For Nginx users, **please add the below rules** to your `nginx.conf` :
2016-07-23 17:39:41 +08:00
```
location / {
try_files $uri $uri/ /index.php?$query_string;
}
2016-07-28 23:10:54 +08:00
# Protect .env file
2016-09-10 23:35:43 +08:00
location ~ /\.env {
2016-07-28 23:10:54 +08:00
deny all;
}
2016-07-23 17:39:41 +08:00
```
2016-09-10 23:35:43 +08:00
Mod Configuration
2016-07-23 17:39:41 +08:00
------------
2016-09-10 23:35:43 +08:00
See [Wiki - Mod Configuration ](https://github.com/printempw/blessing-skin-server/wiki/Mod-Configuration )
2016-07-23 17:39:41 +08:00
2016-09-10 23:35:43 +08:00
> BTW, generating configs is available at user center~
2016-07-23 17:39:41 +08:00
![screenshot2 ](https://img.prinzeugen.net/image.php?di=42U6 )
2016-09-10 23:35:43 +08:00
Copyright & License
2016-07-23 17:39:41 +08:00
------------
2016-09-10 23:35:43 +08:00
Copyright (c) 2016 [@printempw ](https://prinzeugen.net/ ) - Released under the GUN General Public License v3.0.