Updated to Version 1.1

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 MrAnonymusz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,91 @@
+# SMSBG (Simple Minecraft Server Banner Generator)
+
+*As the name of this project is it's just a simple php script which allows you to create custom banners for your minecarft server. These are live banners so they display live stats of your server. At the moment they display the address of your server, the amount of online players and the version of the server.
+But you may configure these options in the `banner.php` file.*
+
+### Some additional information
+
+* For prettier urls you can make a request without include the file's extension _(Instead of __banner.php?address=localhost:25565__ you can simply just __banner?address=localhost:25565__)_.
+* This project also includes a server query using [mcsrvstat.us](https://mcsrvstat.us/) api.
+* If you enable the `enable_key` option in the config file you can restrict the usage of the banner generator but then you must need to pass the following value for the future request's: `&key=your_app_key`. You can find the `app_key` in the `config.php` file. If you want to use it it's recommended to change it frequently but the actual usage of it is to disable the momentary usage of the generator.
+* This project includes 6 default banners (1-6) and 3 default fonts (Roboto, Ubuntu, Minecraftia)
+
+### Installation
+
+**Just simply drag all the files included form the downloaded zip in to a folder and after the go to the `config.php` and change the `app_url` from `http://localhost/banner/` to the domain for the banner generator. After that rename the `htaccess.txt` to `.htaccess` and you are ready to go!**
+
+### How can you make a request?!
+
+* You can get a custom banner by accessing: `banner?address=your_minecraft_server_ip&background=1&font=roboto&color=27AE60&type=1`
+* You can access the server query by: `query?address=your_minecraft_server_ip`
+* __Note 1:__ You can now simply request a banner by `banner?address=your_minecraft_server_ip` and the default settings in the `config.php` will be applied.
+* __Note 2:__ Now you can also choose from 3 predefined styles for the banner _(type)_, the default type for the banner is 1. Example: `banner?address=your_minecraft_server_ip&type=2`
+
+### How can you add a new banner background?!
+
+**The banner's resolution must be 468x60 and it must a `jpg` file and included in the `img/background` folder with the following name: `banner_(here a custom number).jpg`, example: `banner_11.jpg`. _You can set the background of the banner by changing the `background` variable for example: `banner?address=your_minecraft_server_ip&background=11&font=roboto`_.**
+
+### How can you add a new font for the banner?!
+
+**First you need to add a add your font file to the `fonts` folder and rename it like this: `examplefont-regular.ttf` after this go to the `config.php` and add it to the `fonts` and the name you specify there should be just the font's name without the _-regular.ttf_ and you must make sure it's all lowercase _(The name specified in the config and the actual name of the font file must be all lowercase)_. And now you can change the font by simply changing the `font` variable in the request url for example: `banner?address=your_minecraft_server_ip&background=1&font=your_custom_font`.**
+
+### Request a presetted banner
+
+* __You can request a custom banner specified in the `config.php` like this: `banner?preset=hypixel` *(This is the default banner preset in the `config.php` and you can use it as an example)*__
+* You can add a new preset in the `config.php` by following the example given in the file _(hypixel)_ situated in the **presets** array 
+
+#### Default config
+
+```php
+<?php
+
+$config = [
+  'app_key' => 'K6TdeFXHuqZC7Fam',
+  'enable_key' => false,
+  'query_api' => 'https://api.mcsrvstat.us/2/',
+  'app_url' => 'http://localhost/banner/',
+  'fonts' => ['ubuntu', 'roboto', 'minecraftia'],
+  'defaults' => [
+    'font' => 'ubuntu',
+    'color' => '#fff',
+    'background' => 5,
+    'type' => 1
+  ],
+  'presets' => [
+    'hypixel' => [
+      'address' => 'mc.hypixel.net',
+      'font' => 'minecraftia',
+      'color' => '#e0b450',
+      'background' => 5,
+      'type' => 1
+    ]
+  ],
+];
+```
+
+### Request Examples
+
+* __Banner:__ `http://localhost/banner/banner?address=mc.hypixel.net` _(Note: you may specify other parameters like `font`, `type`, `background` or `color`)_
+* __Query:__ `http://localhost/banner/query?address=mc.hypixel.net`
+
+##### Example Banner
+
+**Default Banner**
+![Default Banner](https://i.ibb.co/MkmYRKW/banner-example.jpg)
+
+**Default Presetted Banner**
+![Default Presetted Banner](https://i.ibb.co/PMRkskY/banner-preset.jpg)
+
+### Nginx Config (Optional)
+
+```nginx
+# nginx configuration
+
+autoindex off;
+
+location / {
+  if (!-e $request_filename){
+    rewrite ^/([^\.]+)$ /$1.php break;
+  }
+}
+```