mangos-mirror/server
0
0
Fork 0
mirror of https://github.com/mangosfour/server.git synced 2025-12-12 10:37:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update Badges and cleanup Dependancy Descriptions

Browse source
This commit is contained in:
Antz 2021-02-24 09:24:07 +00:00
parent ecba1586f7
commit 35ef8de745
1 changed files with 106 additions and 101 deletions
Download patch file Download diff file Expand all files Collapse all files

207
README.md
View file

@ -1,50 +1,44 @@
<table border=0 cellpadding=0 cellspacing=0 valign='top'><tr> [<img src='https://www.getmangos.eu/!assets_mangos/currentlogo.gif' width="48" border=0>](https://www.getmangos.eu)
<td><a href='https://www.getmangos.eu' target='getmangos.eu'><img src='https://www.getmangos.eu/!assets_mangos/logo.png' border=0></a></td> [<img src='https://www.getmangos.eu/!assets_mangos/logo.png' border=0>](https://www.getmangos.eu)
<td valign='top'>
<a href='https://www.getmangos.eu/forums/' target='getmangos.forum'><img src='/icons/FORUM.gif' border=0></a>
<a href='https://www.getmangos.eu/wiki' target='getmangos.wiki'><img src='/icons/WIKI.gif' border=0></a>
<a href='https://www.getmangos.eu/github-activity/' target='getmangos.activity'><img src='/icons/ACTIVITY.gif' border=0></a>
<a href='https://www.getmangos.eu/bug-tracker/mangos-three/' target='getmangos.tracker'><img src='/icons/TRACKER.gif' border=0></a>
<br />Build Status: <br/>Linux
<a href='https://travis-ci.org/mangosfour/server/builds' target='MangosFour'><img src='https://travis-ci.org/mangosfour/server.png' border=0></a>
Windows
<a href='https://ci.appveyor.com/project/MaNGOS/server/history' target='MangosFour'><img src='https://ci.appveyor.com/api/projects/status/cnri6idn1h7eyr6c/branch/master?svg=true' border=0></a>
Codacy Status <a href="https://www.codacy.com/app/MaNGOS/MangosFour?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mangosfour/server&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/58227f14b9024384a22e4e12e3cf7a89"/></a>
</td></tr></table>
Mists of Pandaria WOW BRANCH &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Build Status:</b>
Linux/MAC: [<img src='https://travis-ci.org/mangosfour/server.png' border=0 valign="middle">](https://travis-ci.org/mangosfour/server/builds)
Windows: [<img src='https://ci.appveyor.com/api/projects/status/github/mangosfour/server?branch=master&svg=true' border=0 valign="middle">](https://ci.appveyor.com/project/MaNGOS/server/history)
<br><b>Repository Status:</b>
[<img src='https://api.codacy.com/project/badge/Grade/24c2748fb6164216878f28ab4f6cb0f9' border=0 valign="middle"/>](https://app.codacy.com/gh/mangosfour/server/dashboard)
[<img src='https://www.codefactor.io/repository/github/mangosfour/server/badge' border=0 valign="middle"/>](https://www.codefactor.io/repository/github/mangosfour/server)
[<img src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat' border=0 valign="middle"/>](http://makeapullrequest.com)
[<img src='https://img.shields.io/discord/286167585270005763.svg' border=0 valign="middle"/>](https://discord.gg/fPxMjHS8xs "Our community hub on Discord")
---
[<img src="https://www.getmangos.eu/!assets_mangos/Mangos4.png" width="48" valign="middle"/>](http://getmangos.eu)
**MangosFour - The Mists of Pandaria WoW server**
=== ===
### A World of Warcraft server for the Mists of Pandaria Expansion of WoW
----
*Mangos* is open source project, built in [C++][7], it's fast, runs on multiple
platforms, can store game data in [MySQL][40] and [MariaDB][41]. It also has
optional support for SOAP, and aims to be 100% compatible with [World of Warcraft][2]
in its Cataclysm version supporting clients from the [patch 4.3.4][5] branch,
specifically patch 4.3.4.
If you liked the fourth incarnation of [World of Warcraft][2] and still want to play **Mangos** is an open source project written in [C++][7]. It's fast, runs on multiple
[cata WoW][5], this is the branch for you. We provide an authentication platforms and stores game data in [MySQL][40] or [MariaDB][41]. It also has
server where you can manage your users, and a world server which serves game optional support for SOAP.
content just like the original did back then.
On top of that each update is built by [Travis CI][16] as you can see by the If you liked the fifth incarnation of [World of Warcraft][2] and still want to play it,
image next to the chapter's heading! We do love green builds, and working things. this is the branch for you. We provide an authentication server where you can manage your users,
To complement this, we push builds through [Coverity][17] to find and fix any and a world server which serves game content just like the original did back then.
possible security issues.
World of Warcraft, and all World of Warcraft or Warcraft art, images, and lore are It aims to be 100% compatible with the final version of MOP [World of Warcraft][2]
copyrighted by [Blizzard Entertainment, Inc.][1] namely [patch 5.4.8][4].
On top of that each update is automatically built by [Travis CI][16] (Linux/MAC) and [AppVeyor][17] (Windows)
as you can see by the images in the heading above! We do love green builds, and working things.
Requirements Requirements
------------ ------------
The *Mangos* server supports a wide range of operating systems, and various The server supports a wide range of operating systems, and various compiler platforms.
compiler platforms. In order to do that, we use various free cross-platform In order to do that, we use various free cross-platform libraries and use [CMake][19] to provide
libraries and use [CMake][19] to provide a cross-platform build system which a cross-platform build system which adapts to your chosen operating system and compiler.
adapts to your chosen operating system and compiler.
Operating systems Operating systems
----------------- -----------------
Currently we support running *Mangos* on these operating systems: Currently we support running the server on the following operating systems:
* **Windows**, 32 bit and 64 bit. [Windows][20] Server 2008 (or newer) or Windows 7 (or newer) is recommended. * **Windows**, 32 bit and 64 bit. [Windows][20] Server 2008 (or newer) or Windows 7 (or newer) is recommended.
* **Linux**, 32 bit and 64 bit. [Debian 7][21] and [Ubuntu 12.04 LTS][22] are * **Linux**, 32 bit and 64 bit. [Debian 7][21] and [Ubuntu 12.04 LTS][22] are
@ -56,66 +50,81 @@ server versions will work, too.
Compilers Compilers
--------- ---------
Building *Mangos* is currently possible with these compilers: Building the server is currently possible with these compilers:
* **Microsoft Visual Studio (Express[^1])**, 32 bit and 64 bit. Both
[Visual Studio][30] and the Express editions of [Visual Studio][31] are
supported. Only Visual Studio 2012 and above are now officially supported.
* **Microsoft Visual Studio 32 bit and 64 bit.** All editions of [Visual Studio][31] * **Microsoft Visual Studio 32 bit and 64 bit.** All editions of [Visual Studio][31]
are supported. Only Visual Studio 2015 and above are now officially supported. from 2015 upwards are officially supported.
* **Clang**, 32 bit and 64 bit. The [Clang compiler][33] can be used on any * **Clang**, 32 bit and 64 bit. The [Clang compiler][33] can be used on any
supported operating system.[^2] supported operating system.
Dependencies Dependencies
------------ ------------
The *Mangos* server stands on the shoulders of well-known Open Source The server stands on the shoulders of several well-known Open Source libraries plus
libraries, and a few awesome, but less known libraries to prevent us from a few awesome, but less known libraries to prevent us from inventing the wheel again.
inventing the wheel again.
*Please note that Linux and Mac OS X users should install packages using **Please note that Linux and Mac OS X users should install packages using
their systems package management instead of source packages.* their systems package management instead of source packages.**
* **MySQL** / **MariaDB**: to store content, and user data, we rely on * **[MySQL][40]** / **[MariaDB][41]**: These databases are used to store content and user data.
[MySQL][40]/[MariaDB][41] to handle data. * **[ACE][43]**: aka Adaptive Communication Environment, provides us with a solid cross-platform framework for abstracting operating system specific details.
* **ACE**: the [ADAPTIVE Communication Environment][43] aka. *ACE* provides us * **[Recast][44]**: In order to create navigation data from the client's map files Recast is userd to do the dirty work. It provides functions for rendering, pathing, etc.
with a solid cross-platform framework for abstracting operating system * **[G3D][45]**: This engine provides the basic framework for handling 3D data and is used to handle basic map data.
specific details. * **[Stormlib][46]**: Provides an abstraction layer for reading from the client's data files.
* **Recast**: in order to create navigation data from the client's map files, * **[Zlib][53]/[Zlib for Windows][51]** provides compression algorithms used in both MPQ archive handling and the client/server protocol.
we use [Recast][44] to do the dirty work. It provides functions for * **[Bzip2][54]/[Bzip2 for Windows][52]** provides compression algorithms used in MPQ archives.
rendering, pathing, etc. * **[OpenSSL][48]/[OpenSSL for Windows][55]** provides encryption algorithms used when authenticating clients.
* **G3D**: the [G3D][45] engine provides the basic framework for handling 3D
data, and is used to handle basic map data.
* **libmpq**: [libmpq][46] provides an abstraction layer for reading from the
client's data files.
* **Zlib**: [Zlib][53] ([Zlib for Windows][51]) provides compression algorithms
used in both MPQ archive handling and the client/server protocol.
* **Bzip2**: [Bzip2][54] ([Bzip2 for Windows][52]) provides compression
algorithms used in MPQ archives.
* **OpenSSL**: [OpenSSL][48] ([OpenSSL for Windows][55]) provides encryption
algorithms used when authenticating clients.
* **Lua**: [Lua 5.2][56] ([Lua 5.2 for Windows][57]) provides a convenient, fast
scripting environment, which allows us to make live changes to scripted
content.
*ACE*, *Recast*, *G3D* and *libmpq* are included in the *Mangos* distribution as **ACE**, **Recast**, **G3D**, **Stormlib**, **Zlib** and **Bzip2** are included in the standard distribution as
we rely on specific versions. we rely on specific versions.
Optional dependencies Optional dependencies
--------------------- ---------------------
* **Doxygen**: if you want to export HTML or PDF formatted documentation for the * **Doxygen**: if you want to export HTML or PDF formatted documentation for the
*Mangos* API, you should install [Doxygen][49]. Mangos API, you should install [Doxygen][49].
* **Lua**: if you want to test drive how *Mangos* feels with [Lua][50] as
scripting language instead of the scripting library, you will need Lua **5.2.3**
installed. Although an internal version is included.
Discuss
-------
If you need help with building and installing *Mangos* there are thousands of
users out there already running *Mangos* and many more you can find on our
project website and discussion forum to assist with any issues you may have.
* [getmangos.eu][10] <br>We have a small, but extremely friendly and helpful community managed by MadMax and Antz.
<br>Any trolling or unpleasantness is swiftly dealt with !!
* Our discord/forum motto is "Be nice or Be somewhere else"
**Official Website**
----
We welcome anyone who is interested in enjoying older versions of wow or contributing and helping out !
* [**Official MaNGOS Website**](https://getmangos.eu/)
**Discord Server**
----
We also have a Discord server where many of us hang out and discuss Mangos related stuff.
* [**Discord Server**](https://discord.gg/fPxMjHS8xs)
**Main Wiki**
----
The repository of as much information as we can pack in. Details regarding the Database, file type definitions, packet definitons etc.
* [**Wiki Table of Contents**](http://getmangos.eu/wiki)
**Bug / Issue Tracker**
----
Found an issue or something which doesn't seem right, please log it in the relevant section of the Bug Tracker.
* [**Bug Tracker**](https://www.getmangos.eu/bug-tracker/mangos-four/)
**Installation Guides**
----
Installation instructions for various operation systems can be found here.
* [**Installation Guides**](https://www.getmangos.eu/wiki/documentation/installation-guides/)
License License
------- -------
@ -132,7 +141,12 @@ You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301 USA. Street, Fifth Floor, Boston, MA 02110-1301 USA.
The full license is included in the file `License.md`. The full license is included in the file [LICENSE](LICENSE).
We have all put in hundreds of hours of time for free to make the server what it
is today.
<br>All we ask is that if you modify the code and make improvements, please have
the decency to feed those changes back to us.
In addition, as a special exception, permission is granted to link the code of In addition, as a special exception, permission is granted to link the code of
*Mangos* with the OpenSSL project's [OpenSSL library][48] (or with modified *Mangos* with the OpenSSL project's [OpenSSL library][48] (or with modified
@ -140,22 +154,21 @@ versions of it that use the same license as the OpenSSL library), and distribute
the linked executables. You must obey the GNU General Public License in all the linked executables. You must obey the GNU General Public License in all
respects for all of the code used other than [OpenSSL][48]. respects for all of the code used other than [OpenSSL][48].
Acknowledgements
--------
World of Warcraft, and all related art, images, and lore are copyright [Blizzard Entertainment, Inc.][1]
[^2]: Clang support for Windows is experimental. Failure to compile Mangos
may also relate to the experimental state of the port.
[1]: http://blizzard.com/ "Blizzard Entertainment Inc. · we love you!" [1]: http://blizzard.com/ "Blizzard Entertainment Inc. · we love you!"
[2]: http://battle.net/wow/ "World of Warcraft" [2]: https://worldofwarcraft.com/ "World of Warcraft"
[5]: http://www.wowpedia.org/Patch_4.3.4 "WoW Cataclysm· Patch 4.3.4 release notes" [45]: http://www.wowpedia.org/Patch_5.4.8 "WoW Mists of Pandaria · Patch 5.4.8 release notes"
[7]: http://www.cppreference.com/ "C / C++ reference" [7]: http://www.cppreference.com/ "C / C++ reference"
[10]: https://getmangos.eu/ "mangos · project site" [10]: https://getmangos.eu/ "mangos · project site"
[12]: http://github.com/mangosfour "MaNGOS Four· github organization" [12]: https://github.com/mangosthree "MaNGOS Three· github organization"
[13]: http://github.com/mangosfour/server "MaNGOS Four · server repository" [13]: https://github.com/mangosthree/server "MaNGOS Three · server repository"
[15]: http://github.com/mangosfour/database "MaNGOS four · content database repository" [15]: https://github.com/mangosthree/database "MaNGOS Three · content database repository"
[16]: https://travis-ci.org/mangosfour/server "Travis CI . MaNGOS Four build status" [16]: https://travis-ci.org/mangosthree/server "Travis CI · Linux/MAC build status"
[17]: https://scan.coverity.com/ "Coverity Scan · Static Code Analysis" [17]: https://ci.appveyor.com/ "AppVeyor Scan · Windows build status"
[19]: http://www.cmake.org/ "CMake · Cross Platform Make" [19]: http://www.cmake.org/ "CMake · Cross Platform Make"
[20]: http://windows.microsoft.com/ "Microsoft Windows" [20]: http://windows.microsoft.com/ "Microsoft Windows"
[21]: http://www.debian.org/ "Debian · The Universal Operating System" [21]: http://www.debian.org/ "Debian · The Universal Operating System"
@ -163,11 +176,7 @@ respects for all of the code used other than [OpenSSL][48].
[23]: http://www.freebsd.org/ "FreeBSD · The Power To Serve" [23]: http://www.freebsd.org/ "FreeBSD · The Power To Serve"
[24]: http://www.netbsd.org/ "NetBSD · The NetBSD Project" [24]: http://www.netbsd.org/ "NetBSD · The NetBSD Project"
[25]: http://www.openbsd.org/ "OpenBSD · Free, functional and secure" [25]: http://www.openbsd.org/ "OpenBSD · Free, functional and secure"
[26]: http://www.dragonflybsd.org/ "DragonFlyBSD" [31]: https://visualstudio.microsoft.com/vs/older-downloads/ "Visual Studio Downloads"
[30]: http://www.microsoft.com/visualstudio/eng/ "Visual Studio 2012"
[31]: http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products "Visual Studio Express 2012 for Windows Desktop"
[32]: http://www.microsoft.com/en-us/download/details.aspx?id=8279 "Windows SDK for Windows 7 and .NET Framework 4"
[33]: http://clang.llvm.org/ "clang · a C language family frontend for LLVM" [33]: http://clang.llvm.org/ "clang · a C language family frontend for LLVM"
[34]: http://git-scm.com/ "Git · Distributed version control system" [34]: http://git-scm.com/ "Git · Distributed version control system"
[35]: http://windows.github.com/ "github · windows client" [35]: http://windows.github.com/ "github · windows client"
@ -178,15 +187,11 @@ respects for all of the code used other than [OpenSSL][48].
[43]: http://www.dre.vanderbilt.edu/~schmidt/ACE.html "ACE · The ADAPTIVE Communication Environment" [43]: http://www.dre.vanderbilt.edu/~schmidt/ACE.html "ACE · The ADAPTIVE Communication Environment"
[44]: http://github.com/memononen/recastnavigation "Recast · Navigation-mesh Toolset for Games" [44]: http://github.com/memononen/recastnavigation "Recast · Navigation-mesh Toolset for Games"
[45]: http://sourceforge.net/projects/g3d/ "G3D · G3D Innovation Engine" [45]: http://sourceforge.net/projects/g3d/ "G3D · G3D Innovation Engine"
[46]: http://github.com/ge0rg/libmpq "libmpq · A library for reading data from MPQ archives" [46]: http://zezula.net/en/mpq/stormlib.html "Stormlib · A library for reading data from MPQ archives"
[48]: http://www.openssl.org/ "OpenSSL · The Open Source toolkit for SSL/TLS" [48]: http://www.openssl.org/ "OpenSSL · The Open Source toolkit for SSL/TLS"
[49]: http://www.stack.nl/~dimitri/doxygen/ "Doxygen · API documentation generator" [49]: http://www.stack.nl/~dimitri/doxygen/ "Doxygen · API documentation generator"
[50]: http://www.lua.org/ "Lua · The Programming Language"
[51]: http://gnuwin32.sourceforge.net/packages/zlib.htm "Zlib for Windows" [51]: http://gnuwin32.sourceforge.net/packages/zlib.htm "Zlib for Windows"
[52]: http://gnuwin32.sourceforge.net/packages/bzip2.htm "Bzip2 for Windows" [52]: http://gnuwin32.sourceforge.net/packages/bzip2.htm "Bzip2 for Windows"
[53]: http://www.zlib.net/ "Zlib" [53]: http://www.zlib.net/ "Zlib"
[54]: http://www.bzip.org/ "Bzip2" [54]: http://www.bzip.org/ "Bzip2"
[55]: http://slproweb.com/products/Win32OpenSSL.html "OpenSSL for Windows" [55]: http://slproweb.com/products/Win32OpenSSL.html "OpenSSL for Windows"
[56]: http://www.lua.org/ "Lua"
[57]: https://code.google.com/p/luaforwindows/ "Lua for Windows"