diff --git a/README-en.md b/README-en.md new file mode 100644 index 00000000..52a53f4e --- /dev/null +++ b/README-en.md @@ -0,0 +1,110 @@ +- [简体中文](https://github.com/printempw/blessing-skin-server/blob/master/README.md) +- English + +

+ +

+Latest Stable Version +PHP 5.5.9+ +License +Twitter Follow +

+ +Are you puzzled by losing your custom skins in Minecraft servers runing in offline mode? Now you can easily get them back with the help of Blessing Skin Server! + +Blessing Skin Server is a web application where you can upload, manage and share your custom skins & capes! Unlike modifying a resource pack, everyone in the game will see the different skins of each other (of course they should register at the same website too). + +Blessing Skin Server is an open-source project written in PHP, which means you can deploy it freely on your own web server! Here is a [live demo](http://skin.prinzeugen.net/). + +Features +----------- +- Multiple player names can be owned by one user on the website +- Share your skins and capes online with skin library! +- Easy-to-use + - Visual page for user/player/texture management + - Detailed option pages +- Security + - User passwords will be well encrypted + - Email verification for registration (available as plugin) + - Score system for preventing evil requests +- Extensible + - Plenty of plugins available + - Integration with Authme/CrazyLogin/Discuz + +Requirements +----------- +Blessing Skin Server has a few system requirements. In most cases, these PHP extensions are already enabled. + +- Web server with URL rewriting enabled +- **PHP >= 5.5.9** (use v2.x branch if your server doesn't meet the requirements) +- OpenSSL PHP Extension +- PDO PHP Extension +- Mbstring PHP Extension +- Tokenizer PHP Extension +- GD PHP Extension (for generating CAPTCHA) + +Quick Install +----------- +1. Download our [latest release](https://github.com/printempw/blessing-skin-server/releases), extract to where you like to installed on. +2. Rename `.env.example` to `.env` and configure your database information. (For windows users, just rename it to `.env.`, and the last dot will be removed automatically) +3. For Nginx users, add [rewrite rules](#configure-the-web-server) to your Nginx configuration +4. Navigate to `http://your-domain.com/setup` in your browser. If 404 is returned, please check whether the rewrite rules works correctly. +5. Follow the setup wizard and your website is ready-to-go. + +Developer Install +------------ +If you'd like make some contribution on the project, please deploy it from git first. + +**You'd better have some experience on shell operations to continue.** + +Clone the code from GitHub and install dependencies: + +``` +$ git clone https://github.com/printempw/blessing-skin-server.git +$ composer install +$ npm install +$ bower install +``` + +Build the things! + +``` +$ gulp +``` + +Congrats! You made it. Next, please refer to No.2 of [Quick Install]. + +Configure the Web Server +------------ +For Apache (most of the virtual hosts) and IIS users, there is already a pre-configured file for you. What you need is just to enjoy! + +For Nginx users, **please add the following rules** to your Nginx configuration file: + +``` +location / { + try_files $uri $uri/ /index.php?$query_string; +} + +# Protect .env file +location ~ /\.env { + deny all; +} +``` + +Mod Configuration +------------ +See [Wiki - Mod Configuration](https://github.com/printempw/blessing-skin-server/wiki/Mod-Configuration) + +![screenshot2](https://img.prinzeugen.net/image.php?di=42U6) + +FAQ +------------ +Read [Wiki - FAQ](https://github.com/printempw/blessing-skin-server/wiki/FAQ) and double check if your situation doesn't suit any case mentioned there before reporting. + +Report Bugs +------------ +Please attach your log file (located at `storage/logs/laravel.log`) when reporting a bug. You should also provide the information of your server where the error occured on. Bugs will be addressed ASAP. + +Copyright & License +------------ +Copyright (c) 2016 [@printempw](https://prinzeugen.net/) - Released under the GUN General Public License v3.0. diff --git a/README-zh.md b/README-zh.md deleted file mode 100644 index 2801b1f2..00000000 --- a/README-zh.md +++ /dev/null @@ -1,112 +0,0 @@ -- 中文 -- [English](https://github.com/printempw/blessing-skin-server/blob/master/README.md) - -

- -

-Latest Stable Version -PHP 5.5.9+ -License -Twitter Follow -

- -优雅的开源 Minecraft 皮肤站，现在，回应您的等待。 - -Blessing Skin Server 是一款能让您上传、管理和分享您的 Minecraft 皮肤和披风的 Web 应用程序。与修改游戏材质包不同的是，所有人都能在游戏中看到各自的皮肤和披风（当然，前提是玩家们要使用同一个皮肤站）。 - -Blessing Skin Server 是一个开源的 PHP 项目，这意味着您可以自由地在您的服务器上部署它。这里有一个[演示站点](http://skin.prinzeugen.net/)。 - -特性 ------------ -- 支持单用户多个角色 -- 通过皮肤库来分享您的皮肤和披风！ -- 易于使用 - - 可视化的用户、角色、材质管理页面 - - 详细的站点配置页面 -- 安全 - - 只保存 Hash 后的用户密码 - - 注册可要求 Email 验证（以插件的形式实现） - - 防止恶意请求的积分系统 -- 可扩展 - - 多种多样的插件 - - 支持与 Authme/CrazyLogin/Discuz 的数据对接 - -环境要求 ------------ -Blessing Skin Server 对您的服务器有一定的要求。在大多数情况下，下列所需的 PHP 扩展已经开启。 - -- 一台支持 URL 重写的主机，Nginx、Apache 或 IIS -- **PHP >= 5.5.9** （如果服务器不支持，你可以用 v2.x 版本） -- PHP 的 OpenSSL 扩展 -- PHP 的 PDO 扩展 -- PHP 的 Mbstring 扩展 -- PHP 的 Tokenizer 扩展 -- PHP 的 GD 扩展（用于生成验证码） - -快速使用 ------------ -1. 下载皮肤站的 [最新版本](https://github.com/printempw/blessing-skin-server/releases)，并解压到你想要安装到的位置。 -2. 将 `.env.example` 重命名为 `.env` 并**配置你的数据库信息**。（Windows 用户请重命名为 `.env.`，最后的小数点会自动消失） -3. Nginx 用户请添加 [Rewrite 规则](##%E6%9C%8D%E5%8A%A1%E5%99%A8%E9%85%8D%E7%BD%AE) 到你的 Nginx 的配置文件中。 -4. 在浏览器中打开 `http://your-domain.com/setup` 。如果出现 404，请检查 Rewrite 规则是否正确并有效。 -5. 按照提示执行安装程序 - -自行构建 ------------- -如果你想为此项目作贡献，你应该先用 Git 上的代码部署。 - -**不推荐不熟悉 shell 操作以及不想折腾的用户使用。** - -从 Git 上 clone 源码并安装依赖: - -``` -$ git clone https://github.com/printempw/blessing-skin-server.git -$ composer install -$ npm install -$ bower install -``` - -构建代码！ - -``` -$ gulp -``` - -恭喜，构建完成！接下来请参考「快速使用」的第二点进行后续安装。 - -服务器配置 ------------- -如果你使用 Apache 或者 IIS 作为 web 服务器（大部分的虚拟主机），那么恭喜你，我已经帮你把重写规则写好啦，开箱即用，无需任何配置~ - -如果你使用 Nginx，请在你的 nginx.conf 中加入如下规则**（重要）**： - -``` -location / { - try_files $uri $uri/ /index.php?$query_string; -} - -# Protect .env file -location ~ /\.env { - deny all; -} -``` - -Mod 配置 ------------- -请前往 [Wiki - Mod Configuration](https://github.com/printempw/blessing-skin-server/wiki/Mod-Configuration) - -![screenshot2](https://img.prinzeugen.net/image.php?di=42U6) - -FAQ ------------- -阅读 [Wiki - FAQ](https://github.com/printempw/blessing-skin-server/wiki/FAQ) 并在报告问题之前再次确认 FAQ 中确实没有提到你的情况。 - -Bug 报告 ------------- -请带上你的日志文件（位于 `storage/logs/laravel.log`）联系我。你还应该提供错误发生时服务器的一些信息。Bug 将会被尽快解决。 - -版权 ------------- -Blessing Skin Server 程序是基于 GUN General Public License v3.0 开放源代码的自由软件，你可以遵照 GPLv3 协议来修改和重新发布这一程序。 - -程序原作者为 [@printempw](https://prinzeugen.net/)，转载请注明。 diff --git a/README.md b/README.md index 36a4b1f6..31b6249a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -- [中文](https://github.com/printempw/blessing-skin-server/blob/master/README-zh.md) -- English +- 简体中文 +- [English](https://github.com/printempw/blessing-skin-server/blob/master/README-en.md)

@@ -10,54 +10,54 @@ Twitter Follow

-Are you puzzled by losing your custom skins in Minecraft servers runing in offline mode? Now you can easily get them back with the help of Blessing Skin Server! +优雅的开源 Minecraft 皮肤站，现在，回应您的等待。 -Blessing Skin Server is a web application where you can upload, manage and share your custom skins & capes! Unlike modifying a resource pack, everyone in the game will see the different skins of each other (of course they should register at the same website too). +Blessing Skin Server 是一款能让您上传、管理和分享您的 Minecraft 皮肤和披风的 Web 应用程序。与修改游戏材质包不同的是，所有人都能在游戏中看到各自的皮肤和披风（当然，前提是玩家们要使用同一个皮肤站）。 -Blessing Skin Server is an open-source project written in PHP, which means you can deploy it freely on your own web server! Here is a [live demo](http://skin.prinzeugen.net/). +Blessing Skin Server 是一个开源的 PHP 项目，这意味着您可以自由地在您的服务器上部署它。这里有一个[演示站点](http://skin.prinzeugen.net/)。 -Features +特性 ----------- -- Multiple player names can be owned by one user on the website -- Share your skins and capes online with skin library! -- Easy-to-use - - Visual page for user/player/texture management - - Detailed option pages -- Security - - User passwords will be well encrypted - - Email verification for registration (available as plugin) - - Score system for preventing evil requests -- Extensible - - Plenty of plugins available - - Integration with Authme/CrazyLogin/Discuz +- 支持单用户多个角色 +- 通过皮肤库来分享您的皮肤和披风！ +- 易于使用 + - 可视化的用户、角色、材质管理页面 + - 详细的站点配置页面 +- 安全 + - 只保存 Hash 后的用户密码 + - 注册可要求 Email 验证（以插件的形式实现） + - 防止恶意请求的积分系统 +- 可扩展 + - 多种多样的插件 + - 支持与 Authme/CrazyLogin/Discuz 的数据对接 -Requirements +环境要求 ----------- -Blessing Skin Server has a few system requirements. In most cases, these PHP extensions are already enabled. +Blessing Skin Server 对您的服务器有一定的要求。在大多数情况下，下列所需的 PHP 扩展已经开启。 -- Web server with URL rewriting enabled -- **PHP >= 5.5.9** (use v2.x branch if your server doesn't meet the requirements) -- OpenSSL PHP Extension -- PDO PHP Extension -- Mbstring PHP Extension -- Tokenizer PHP Extension -- GD PHP Extension (for generating CAPTCHA) +- 一台支持 URL 重写的主机，Nginx、Apache 或 IIS +- **PHP >= 5.5.9** （如果服务器不支持，你可以用 v2.x 版本） +- PHP 的 OpenSSL 扩展 +- PHP 的 PDO 扩展 +- PHP 的 Mbstring 扩展 +- PHP 的 Tokenizer 扩展 +- PHP 的 GD 扩展（用于生成验证码） -Quick Install +快速使用 ----------- -1. Download our [latest release](https://github.com/printempw/blessing-skin-server/releases), extract to where you like to installed on. -2. Rename `.env.example` to `.env` and configure your database information. (For windows users, just rename it to `.env.`, and the last dot will be removed automatically) -3. For Nginx users, add [rewrite rules](#configure-the-web-server) to your Nginx configuration -4. Navigate to `http://your-domain.com/setup` in your browser. If 404 is returned, please check whether the rewrite rules works correctly. -5. Follow the setup wizard and your website is ready-to-go. +1. 下载皮肤站的 [最新版本](https://github.com/printempw/blessing-skin-server/releases)，并解压到你想要安装到的位置。 +2. 将 `.env.example` 重命名为 `.env` 并**配置你的数据库信息**。（Windows 用户请重命名为 `.env.`，最后的小数点会自动消失） +3. Nginx 用户请添加 [Rewrite 规则](##%E6%9C%8D%E5%8A%A1%E5%99%A8%E9%85%8D%E7%BD%AE) 到你的 Nginx 的配置文件中。 +4. 在浏览器中打开 `http://your-domain.com/setup` 。如果出现 404，请检查 Rewrite 规则是否正确并有效。 +5. 按照提示执行安装程序 -Developer Install +自行构建 ------------ -If you'd like make some contribution on the project, please deploy it from git first. +如果你想为此项目作贡献，你应该先用 Git 上的代码部署。 -**You'd better have some experience on shell operations to continue.** +**不推荐不熟悉 shell 操作以及不想折腾的用户使用。** -Clone the code from GitHub and install dependencies: +从 Git 上 clone 源码并安装依赖: ``` $ git clone https://github.com/printempw/blessing-skin-server.git @@ -66,19 +66,19 @@ $ npm install $ bower install ``` -Build the things! +构建代码！ ``` $ gulp ``` -Congrats! You made it. Next, please refer to No.2 of [Quick Install]. +恭喜，构建完成！接下来请参考「快速使用」的第二点进行后续安装。 -Configure the Web Server +服务器配置 ------------ -For Apache (most of the virtual hosts) and IIS users, there is already a pre-configured file for you. What you need is just to enjoy! +如果你使用 Apache 或者 IIS 作为 web 服务器（大部分的虚拟主机），那么恭喜你，我已经帮你把重写规则写好啦，开箱即用，无需任何配置~ -For Nginx users, **please add the following rules** to your Nginx configuration file: +如果你使用 Nginx，请在你的 nginx.conf 中加入如下规则**（重要）**： ``` location / { @@ -91,20 +91,22 @@ location ~ /\.env { } ``` -Mod Configuration +Mod 配置 ------------ -See [Wiki - Mod Configuration](https://github.com/printempw/blessing-skin-server/wiki/Mod-Configuration) +请前往 [Wiki - Mod Configuration](https://github.com/printempw/blessing-skin-server/wiki/Mod-Configuration) ![screenshot2](https://img.prinzeugen.net/image.php?di=42U6) FAQ ------------ -Read [Wiki - FAQ](https://github.com/printempw/blessing-skin-server/wiki/FAQ) and double check if your situation doesn't suit any case mentioned there before reporting. +阅读 [Wiki - FAQ](https://github.com/printempw/blessing-skin-server/wiki/FAQ) 并在报告问题之前再次确认 FAQ 中确实没有提到你的情况。 -Report Bugs +Bug 报告 ------------ -Please attach your log file (located at `storage/logs/laravel.log`) when reporting a bug. You should also provide the information of your server where the error occured on. Bugs will be addressed ASAP. +请带上你的日志文件（位于 `storage/logs/laravel.log`）联系我。你还应该提供错误发生时服务器的一些信息。Bug 将会被尽快解决。 -Copyright & License +版权 ------------ -Copyright (c) 2016 [@printempw](https://prinzeugen.net/) - Released under the GUN General Public License v3.0. +Blessing Skin Server 程序是基于 GUN General Public License v3.0 开放源代码的自由软件，你可以遵照 GPLv3 协议来修改和重新发布这一程序。 + +程序原作者为 [@printempw](https://prinzeugen.net/)，转载请注明。