server/mangos
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Antz 2021-02-23 00:37:58 +00:00 committed by GitHub
parent df20a5b97f
commit 3675c4bfdf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 91 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

163
README.md
View File

@ -1,49 +1,43 @@
<table border=0 cellpadding=0 cellspacing=0 valign='top'><tr>
<td><a href='https://www.getmangos.eu' target='getmangos.eu'><img src='https://www.getmangos.eu/!assets_mangos/logo.png' border=0></a></td>
<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-zero/' target='getmangos.tracker'><img src='/icons/TRACKER.gif' border=0></a>
<br />Build Status: <br/>Linux
<a href='https://travis-ci.org/mangoszero/server/builds' target='MangosZero'><img src='https://travis-ci.org/mangoszero/server.png' border=0></a>
Windows
<a href='https://ci.appveyor.com/project/MaNGOS/server-9fytl/history' target='MangosZero'><img src='https://ci.appveyor.com/api/projects/status/github/mangoszero/server?branch=develop21&svg=true' border=0></a>
Codacy Status <a href="https://www.codacy.com/app/MaNGOS/MangosZero?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mangoszero/server&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/895a7434531a456ba12410ac585717c8"/></a>
</td></tr></table>
[<img src='https://www.getmangos.eu/!assets_mangos/currentlogo.gif' width="48" border=0>](https://www.getmangos.eu)
[<img src='https://www.getmangos.eu/!assets_mangos/logo.png' border=0>](https://www.getmangos.eu)
VANILLA WOW BRANCH
Build Status:<br><b>Linux/MAC:</b>
[<img src='https://travis-ci.org/mangoszero/server.png' border=0 valign="middle">](https://travis-ci.org/mangoszero/server/builds)
<b>Windows:</b>
[<img src='https://ci.appveyor.com/api/projects/status/github/mangoszero/server?branch=develop21&svg=true' border=0 valign="middle">](https://ci.appveyor.com/project/MaNGOS/server-9fytl/history)
<b>Codacy Status:</b>
[<img src='https://api.codacy.com/project/badge/Grade/895a7434531a456ba12410ac585717c8' border=0 valign="middle"/>](https://www.codacy.com/app/MaNGOS/MangosZero?utm_source=github.com&utm_medium=referral&utm_content=mangoszero/server&utm_campaign=Badge_Grade)
---
[<img src="https://www.getmangos.eu/!assets_mangos/Mangos0.png" width="48" valign="middle"/>](http://getmangos.eu)
**MangosZero - Vanilla World of Warcraft server**
===
### A World of Warcraft server for Vanilla WoW
----
*Mangos* is an 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 vanilla versions, namely [patch 1.12.1][5] and [patch 1.12.2][6].
If you liked the first incarnation of [World of Warcraft][2] and still want to play
[vanilla WoW][4], this is the branch for you. We provide an authentication
server where you can manage your users, and a world server which serves game
content just like the original did back then.
**Mangos** is an open source project written in [C++][7]. It's fast, runs on multiple
platforms and stores game data in [MySQL][40] or [MariaDB][41]. It also has
optional support for SOAP.
On top of that each update is built by [Travis CI][16] as you can see by the
image next to the chapter's heading! We do love green builds, and working things.
To complement this, we push builds through [Coverity][17] to find and fix any
possible security issues.
If you liked the original incarnation of [World of Warcraft][2] and still want to play it,
this is the branch for you. We provide an authentication server where you can manage your users,
and a world server which serves game content just like the original did back then.
World of Warcraft, and all World of Warcraft or Warcraft art, images, and lore are
copyrighted by [Blizzard Entertainment, Inc.][1]
It aims to be 100% compatible with the 3 final versions of Vanilla [World of Warcraft][2],
namely [patch 1.12.1][4], [patch 1.12.2][5] & [patch 1.12.3][6].
<br>**IT DOES NOT SUPPORT 1.13.x** and beyond which is the newly released Classic Experience (NuClassic).
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
------------
The *Mangos* server supports a wide range of operating systems, and various
compiler platforms. In order to do that, we use various free cross-platform
libraries and use [CMake][19] to provide a cross-platform build system which
adapts to your chosen operating system and compiler.
The server supports a wide range of operating systems, and various compiler platforms.
In order to do that, we use various free cross-platform libraries and use [CMake][19] to provide
a cross-platform build system which adapts to your chosen operating system and compiler.
Operating systems
-----------------
Currently we support running *Mangos* on the following 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.
* **Linux**, 32 bit and 64 bit. [Debian 7][21] and [Ubuntu 12.04 LTS][22] are
@ -55,22 +49,21 @@ server versions will work, too.
Compilers
---------
Building *Mangos* is currently possible with these compilers:
Building the server is currently possible with these compilers:
* **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
supported operating system.[^2]
supported operating system.
Dependencies
------------
The *Mangos* server stands on the shoulders of well-known Open Source
libraries, and a few awesome, but less known libraries to prevent us from
inventing the wheel again.
The server stands on the shoulders of several well-known Open Source libraries plus
a few awesome, but less known libraries to prevent us from inventing the wheel again.
*Please note that Linux and Mac OS X users should install packages using
their systems package management instead of source packages.*
**Please note that Linux and Mac OS X users should install packages using
their systems package management instead of source packages.**
* **MySQL** / **MariaDB**: to store content, and user data, we rely on
[MySQL][40]/[MariaDB][41] to handle data.
@ -82,7 +75,7 @@ their systems package management instead of source packages.*
rendering, pathing, etc.
* **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
* **Stormlib**: [Stormlib][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.
@ -90,29 +83,54 @@ their systems package management instead of source packages.*
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.
Optional dependencies
---------------------
* **Doxygen**: if you want to export HTML or PDF formatted documentation for the
*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.
Mangos API, you should install [Doxygen][49].
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**
----
[![Widget for the Discord API guild](https://discord.com/api/guilds/286167585270005763/widget.png?style=banner2)](https://discord.gg/CzXcBXq)
**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-zero/)
**Installation Guides**
----
Installation instructions for various operation systems can be found here.
* [**Installation Guides**](https://www.getmangos.eu/wiki/documentation/installation-guides/)
License
-------
@ -129,7 +147,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
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
*Mangos* with the OpenSSL project's [OpenSSL library][48] (or with modified
@ -137,25 +160,25 @@ 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
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!"
[2]: http://blizzard.com/games/wow/ "World of Warcraft · Classic / Vanilla"
[3]: http://wowpedia.org/Beta#World_of_Warcraft "World of Warcraft - Classic Beta"
[4]: http://www.wowpedia.org/Patch_1.12.0 "Vanilla WoW · Patch 1.12.0 release notes"
[5]: http://www.wowpedia.org/Patch_1.12.1 "Vanilla WoW · Patch 1.12.1 release notes"
[6]: http://www.wowpedia.org/Patch_1.12.2 "Vanilla WoW · Patch 1.12.2 release notes"
[4]: http://www.wowpedia.org/Patch_1.12.1 "Vanilla WoW · Patch 1.12.1 release notes"
[5]: http://www.wowpedia.org/Patch_1.12.2 "Vanilla WoW · Patch 1.12.2 release notes"
[6]: http://www.wowpedia.org/Patch_1.12.3 "Vanilla WoW · Patch 1.12.3 release notes"
[7]: http://www.cppreference.com/ "C / C++ reference"
[10]: https://getmangos.eu/ "mangos · project site"
[12]: https://github.com/mangoszero "MaNGOS Zero · github organization"
[13]: https://github.com/mangoszero/server "MaNGOS Zero · server repository"
[15]: https://github.com/mangoszero/database "MaNGOS Zero · content database repository"
[16]: https://travis-ci.org/mangoszero/server "Travis CI . MaNGOS Zero build status"
[17]: https://scan.coverity.com/ "Coverity Scan · Static Code Analysis"
[16]: https://travis-ci.org/mangoszero/server "Travis CI · Linux/MAC build status"
[17]: https://ci.appveyor.com/ "AppVeyor Scan · Windows build status"
[19]: http://www.cmake.org/ "CMake · Cross Platform Make"
[20]: http://windows.microsoft.com/ "Microsoft Windows"
[21]: http://www.debian.org/ "Debian · The Universal Operating System"
@ -174,15 +197,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"
[44]: http://github.com/memononen/recastnavigation "Recast · Navigation-mesh Toolset for Games"
[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"
[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"
[52]: http://gnuwin32.sourceforge.net/packages/bzip2.htm "Bzip2 for Windows"
[53]: http://www.zlib.net/ "Zlib"
[54]: http://www.bzip.org/ "Bzip2"
[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"