Skip to content

Commit cefff0c

Browse files
committed
Update README
1 parent bdbed77 commit cefff0c

File tree

1 file changed

+45
-50
lines changed

1 file changed

+45
-50
lines changed

README.md

Lines changed: 45 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,56 @@
11
[![Logo Image](https://cdn.pterodactyl.io/logos/Banner%20Logo%20Black@2x.png)](https://pterodactyl.io)
22

3-
[![Build Status](https://travis-ci.org/Pterodactyl/Panel.svg?branch=develop)](https://travis-ci.org/Pterodactyl/Panel) [![StyleCI](https://styleci.io/repos/47508644/shield?branch=develop)](https://styleci.io/repos/47508644) [![codecov](https://codecov.io/gh/Pterodactyl/Panel/branch/develop/graph/badge.svg)](https://codecov.io/gh/Pterodactyl/Panel)
3+
[![Build Status](https://travis-ci.org/pterodactyl/panel.svg?branch=develop)](https://travis-ci.org/pterodactyl/panel) [![StyleCI](https://styleci.io/repos/47508644/shield?branch=develop)](https://styleci.io/repos/47508644) [![codecov](https://codecov.io/gh/pterodactyl/panel/branch/develop/graph/badge.svg)](https://codecov.io/gh/Pterodactyl/Panel)
44

5-
## Pterodactyl Panel
6-
Pterodactyl Panel is the free, open-source, game agnostic, self-hosted control panel for users, networks, and game service providers. Pterodactyl supports games and servers such as Minecraft (including Spigot, Bungeecord, and Sponge), ARK: Evolution Evolved, CS:GO, Team Fortress 2, Insurgency, Teamspeak 3, Mumble, and many more. Control all of your games from one unified interface.
5+
# Pterodactyl Panel
6+
Pterodactyl is the open-source game server management panel built with PHP7, Nodejs, and Go. Designed with security in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful and intuitive UI to administrators and users.
7+
What more are you waiting for? Make game servers a first class citizen on your platform today.
8+
9+
![Image](https://cdn.pterodactyl.io/site-assets/mockup-macbook-grey.png)
710

811
## Support & Documentation
9-
Support for using Pterodactyl can be found on our [Documentation Website](https://docs.pterodactyl.io) or via our [Discord Chat](https://discord.gg/QRDZvVm).
12+
Support for using Pterodactyl can be found on our [Documentation Website](https://docs.pterodactyl.io), [Guides Website](https://guides.pterodactyl.io), or via our [Discord Chat](https://discord.gg/QRDZvVm).
13+
14+
### Supported Games
15+
We support a huge variety of games by utilizing Docker containers to isolate each instance, giving you the power to host your games across the world without having to bloat each physcial machine with additional dependencies.
16+
17+
Some of our core supported games include:
18+
19+
* Minecraft — including Spigot, Sponge, Bungeecord, Waterfall, and more
20+
* Rust
21+
* Terraria
22+
* Teamspeak
23+
* Mumble
24+
* Team Fortress 2
25+
* Counter Strike: GO
26+
* Garrys Mod
27+
* Ark: Survival Evolved
28+
29+
In addition to our standard nest of supported games, our community is constantly pushing the limits of this software and there are plenty more games available provided by the community. Some of these games include:
30+
31+
* Factorio
32+
* San Andreas: MP
33+
* Pocketmine MP
34+
* Squad
35+
* FiveM
36+
* Xonotic
37+
* Discord ATLBot
38+
39+
## Credits
40+
A huge thank you to [PhraseApp](https://phraseapp.com) who provide us the software to help translate this project. This software would not be possible
41+
without the work of other open-source authors who provide tools such as:
42+
43+
[Ace Editor](https://ace.c9.io), [AdminLTE](https://almsaeedstudio.com), [Animate.css](http://daneden.github.io/animate.css/), [AnsiUp](https://github.com/drudru/ansi_up), [Async.js](https://github.com/caolan/async),
44+
[Bootstrap](http://getbootstrap.com), [Bootstrap Notify](http://bootstrap-notify.remabledesigns.com), [Chart.js](http://www.chartjs.org), [FontAwesome](http://fontawesome.io),
45+
[FontAwesome Animations](https://github.com/l-lin/font-awesome-animation), [jQuery](http://jquery.com), [Laravel](https://laravel.com), [Lodash](https://lodash.com),
46+
[Select2](https://select2.github.io), [Socket.io](http://socket.io), [Socket.io File Upload](https://github.com/vote539/socketio-file-upload), [SweetAlert](http://t4t5.github.io/sweetalert),
47+
[Typeahead](https://github.com/bassjobsen/Bootstrap-3-Typeahead), and [Particles.js](http://vincentgarreau.com/particles.js).
48+
49+
Some Javascript and CSS used within the panel is licensed under a `MIT` or `Apache 2.0` license. Please check their respective header files for more information.
1050

1151
## License
1252
```
13-
Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
53+
Copyright (c) 2015 - 2018 Dane Everitt <dane@daneeveritt.com>.
1454
1555
Permission is hereby granted, free of charge, to any person obtaining a copy
1656
of this software and associated documentation files (the "Software"), to deal
@@ -30,48 +70,3 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
3070
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
3171
SOFTWARE.
3272
```
33-
34-
### Credits
35-
![](http://static.s3.pterodactyl.io/PhraseApp-parrot.png)
36-
A huge thanks to [PhraseApp](https://phraseapp.com) who provide us the software to help translate this project.
37-
38-
Ace Editor — [license](https://github.com/ajaxorg/ace/blob/master/LICENSE)[homepage](https://ace.c9.io)
39-
40-
AdminLTE — [license](https://github.com/almasaeed2010/AdminLTE/blob/master/LICENSE)[homepage](https://almsaeedstudio.com)
41-
42-
Animate.css — [license](https://github.com/daneden/animate.css/blob/master/LICENSE)[homepage](http://daneden.github.io/animate.css/)
43-
44-
AnsiUp — [license](https://github.com/drudru/ansi_up/blob/master/Readme.md#license)[homepage](https://github.com/drudru/ansi_up)
45-
46-
Async.js — [license](https://github.com/caolan/async/blob/master/LICENSE)[homepage](https://github.com/caolan/async/)
47-
48-
Bootstrap — [license](https://github.com/twbs/bootstrap/blob/master/LICENSE)[homepage](http://getbootstrap.com)
49-
50-
BootStrap Notify — [license](https://github.com/mouse0270/bootstrap-notify/blob/master/LICENSE)[homepage](http://bootstrap-notify.remabledesigns.com)
51-
52-
Chart.js — [license](https://github.com/chartjs/Chart.js/blob/master/LICENSE.md)[homepage](http://www.chartjs.org)
53-
54-
FontAwesome — [license](http://fontawesome.io/license/)[homepage](http://fontawesome.io)
55-
56-
FontAwesome Animations — [license](https://github.com/l-lin/font-awesome-animation#license)[homepage](https://github.com/l-lin/font-awesome-animation)
57-
58-
jQuery — [license](https://github.com/jquery/jquery/blob/master/LICENSE.txt)[homepage](http://jquery.com)
59-
60-
Laravel Framework — [license](https://github.com/laravel/framework/blob/5.4/LICENSE.md)[homepage](https://laravel.com)
61-
62-
Lodash — [license](https://github.com/lodash/lodash/blob/master/LICENSE)[homepage](https://lodash.com/)
63-
64-
Select2 — [license](https://github.com/select2/select2/blob/master/LICENSE.md)[homepage](https://select2.github.io)
65-
66-
Socket.io — [license](https://github.com/socketio/socket.io/blob/master/LICENSE)[homepage](http://socket.io)
67-
68-
Socket.io File Upload — [license](https://github.com/vote539/socketio-file-upload/blob/master/server.js#L1-L27)[homepage](https://github.com/vote539/socketio-file-upload)
69-
70-
SweetAlert — [license](https://github.com/t4t5/sweetalert/blob/master/LICENSE)[homepage](http://t4t5.github.io/sweetalert/)
71-
72-
Typeahead — [license](https://github.com/bassjobsen/Bootstrap-3-Typeahead/blob/master/bootstrap3-typeahead.js)[homepage](https://github.com/bassjobsen/Bootstrap-3-Typeahead)
73-
74-
particles.js — [license](https://github.com/VincentGarreau/particles.js/blob/master/LICENSE.md)[homepage](http://vincentgarreau.com/particles.js/)
75-
76-
### Additional License Information
77-
Some Javascript and CSS used within the panel is licensed under a `MIT` or `Apache 2.0`. Please check their respective header files for more information.

0 commit comments

Comments
 (0)