diff options
| -rw-r--r-- | .github/README.md | 154 |
1 files changed, 32 insertions, 122 deletions
diff --git a/.github/README.md b/.github/README.md index f193319122..948a86f9a9 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,166 +1,76 @@ #  AzerothCore [](https://www.codefactor.io/repository/github/azerothcore/azerothcore-wotlk) -[](https://github.com/azerothcore/azerothcore-wotlk/actions?query=workflow%3Acore-build+branch%3Amaster+event%3Apush) +[](https://www.bountysource.com/teams/azerothcore/bounties "Put money on issues or get paid for fixing them") +[](https://stackoverflow.com/questions/tagged/azerothcore?sort=newest "Ask / browse questions here") +[](https://discord.gg/gkt4y2x "Our community hub on Discord") + +## Build Status + +[](https://github.com/azerothcore/azerothcore-wotlk/actions/workflows/core_matrix_build.yml) [](https://github.com/azerothcore/azerothcore-wotlk/actions?query=workflow%3Acore-modules-build+branch%3Amaster+event%3Apush) [](https://github.com/azerothcore/azerothcore-wotlk/actions?query=workflow%3Awindows-build+branch%3Amaster+event%3Apush) [](https://github.com/azerothcore/azerothcore-wotlk/actions?query=workflow%3Amacos-build+branch%3Amaster+event%3Apush) [](https://github.com/azerothcore/azerothcore-wotlk/actions?query=workflow%3Adocker-build+branch%3Amaster+event%3Apush) -[](https://www.bountysource.com/teams/azerothcore/bounties "Put money on issues or get paid for fixing them") -[](https://stackoverflow.com/questions/tagged/azerothcore?sort=newest "Ask / browse questions here") -[](https://discord.gg/gkt4y2x "Our community hub on Discord") - ## Introduction -AzerothCore (AC) is an open-source game-server application for World of Warcraft, currently supporting the 3.3.5a game version. - -It is written in C++ and is based on MaNGOS, TrinityCore and SunwellCore. - - -## Why AzerothCore? - -1. Stability -1. The authenticity of the content -1. [Modularity](https://en.wikipedia.org/wiki/Modular_programming) -1. A lot of modules to choose from -1. Better configuration files system -1. Compatibility with other emulators -1. Friendly and helpful community - -### Stability - -As players and administrators ourselves, we take great care into the stability of our core. Other projects focus on the development side of things and tend to forget that users want stability above everything else. - -Hence why nobody is allowed to push commits directly to the core. All changes are reviewed and tested before they get to the `master` branch which means we need as many testers as possible to avoid stalling issues. - -### Authenticity - -Fixing and implementing missing blizzlike content is one of our priorities, and we can boast to offer the most content-complete open-source emulator. -<!-- Not sure for this below --> -<!-- We were the first open-source emulator to have almost every dungeon and raid working. --> - -### Modules - -Modules are essential to AzerothCore's success. Modules allow users to plug them in and out easily, and do not require to modify the core files. It also means users can keep pulling the git changes from the main repository and only develop their modules. - -We have a lot of modules already made, some of them are very important and will ease your work: - -* [Transmogrification](https://github.com/azerothcore/mod-transmog) -* [Eluna (lua engine) support](https://github.com/azerothcore/mod-eluna/ "Creator of Eluna is part of our core team") -* Full list available in the AzerothCore catalogue (link at the end) - -### Configuration files - -Our configuration file system allows the user to use a tiny configuration file for better readability and maintenance. - -### Compatibility with other emulators - -Not very far from its ancestor TrinityCore, most scripts can be adapted quite easily. For MaNGOS compatibility, it might require more knowledge but it shares a common base. +AzerothCore is an open-source game server application and framework designed for hosting massively multiplayer online role-playing games (MMORPGs). It is based on the popular MMORPG World of Warcraft (WoW) and seeks to recreate the gameplay experience of the original game from patch 3.3.5a. +The original code is based on MaNGOS, TrinityCore, and SunwellCore and has since then had extensive development to improve stability, in-game mechanics, and modularity to the game. AC has also grown into a community-driven project with a significant number of contributors and developers. It is written in C++ and provides a solid foundation for creating private servers that mimic the mechanics and behavior of the official WoW servers. ## Philosophy -Our main goal is to create a playable game server, offering a fully working game experience. +Our main goal is to create a playable game server, offering a fully working in-game experience. Here are the main points we focus on: * Stability -* Ease of use / Practicability -* Playability (in-game content) -* Customization -* Community-driven software (check our discord) - -We also welcome new users (even non-English speaking users!) and help them learn/improve their skills (C++, SQL, Git, software collaboration, tutoring/wiki, etc...). - -Unlike other projects which focus more on the developer's side of things, we want users to be able to run their server with as few troubles as possible. All of our contributors run their private servers (local or public). + * We make sure all changes pass the CIs before being merged into the master branch. -That's why AzerothCore is easier to use, to maintain, to understand, to develop on, and to customize to suit your needs, than other emulators. - -In short, we focus on the **user experience (UX)**, whether it be the **player's experience**, the **developer's experience**, or the **administrator's experience**. - - -## How to Thank us - -Being an open-source project, we rely on volunteers to pursue development. Here are ways to help us if you use AzerothCore: - -### Github Star - -Click on the "star this repository" button to help us gain more visibility on Github! - -### By contributing - -Check the **CONTRIBUTING** section below. - -### Financially :moneybag: - -You can support the AzerothCore by [donating](https://www.paypal.com/donate/?hosted_button_id=L69ANPSR8BJDU). -The money will be used to pay freelance developers for more open-source fixes. - -### Advertising - -By talking about us on different platforms or to people who would like to get involved. - - -## Contributing - -AzerothCore is a learning project, and there are lots of different ways to contribute to the project: - -* By [testing our fixes](http://www.azerothcore.org/wiki/How-to-test-a-PR) (we can teach you how to correctly use Git to help us but that will also help you out tremendously) -* By developing directly to the core or the modules -* By reporting bugs within the project -* By [creating new modules](http://www.azerothcore.org/wiki/Create-a-Module) -* By improving our wiki -* By providing direct support to our community (on Discord, StackOverflow or specialized forums) -* By making extra content (video tutorial for example) -* By putting bounties on issues +* Blizzlike content + * We strive to make all in-game content to be blizzlike. Therefore we have a high standard for fixes being made. +* Customization + * It is easy to customize your experience using [modules](#modules). -If you want to contribute to the project, you will find a lot of resources that will guide you in our wiki. +* Community driven + * AzerothCore has an active community of developers, contributors, and users who collaborate, share knowledge, and provide support through forums, Discord channels, and other communication platforms. -Feel free to join us on [our Discord chat server](https://discord.gg/gkt4y2x) where we teach a lot of new people how to get started and who are now important contributors! +### Modules -<!-- TO UNCOMMENT LATER --> -<!-- As we put a big emphasis on community, there are also special rewards for contributors such as reputation ranks (displayed in our Discord and our website), reputation badges (to display on your project/portfolio), premium software licenses, private modules access, private tools access and a lot of small private repositories access. --> +AzerothCore is designed to be highly modular, allowing developers to extend and customize the game to suit their preferences or create unique gameplay experiences. This flexibility enables the addition of custom features, content, and modifications. +We have a lot of modules already made by the community, many of which can be found in the [Module Catalogue](https://www.azerothcore.org/catalogue.html#/). ## Installation -Installation instructions are available [here](http://www.azerothcore.org/wiki/Installation). +Detailed installation instructions are available [here](http://www.azerothcore.org/wiki/installation). -We also have an auto-installation bash script [here](/apps/installer/main.sh) (*Warning: try it/analyze it before running it*). - -Dockerization of AzerothCore is fully supported, and we have various community-made tutorials (eg: AWS / Digital Ocean installation). +## Contributing +AzerothCore can also serve as a learning resource for aspiring developers who want to understand how WoW servers work, how MMORPGs are structured, how game server emulators are created, or to improve their C++ and SQL knowledge. -## Support +If you want to contribute to the project, you will find a lot of resources that will guide you in our [wiki](https://www.azerothcore.org/wiki/contribute). -Our self-made wiki probably has a lot of answers for you. +We also recommend you read our [Contributor Covenant Code of Conduct](https://github.com/azerothcore/azerothcore-wotlk/blob/master/.github/CODE_OF_CONDUCT.md). -For help requests, it is recommended to ask your question on [StackOverflow](https://stackoverflow.com/questions/tagged/azerothcore) and link it in [our chat](https://discordapp.com/channels/217589275766685707/284406375495368704). +Feel free to join our [Discord server](https://discord.gg/gkt4y2x). +Click on the "⭐ Star" button to help us gain more visibility on Github! ## Authors & Contributors -This project exists thanks to: - -- **The [AzerothCore developers and contributors](https://github.com/AzerothCore/azerothcore-wotlk/graphs/contributors)** -- The [SunwellCore developers xinef and pussywizard](http://www.azerothcore.org/pages/sunwell.pl/) -- All the [TrinityCore developers and contributors](https://github.com/TrinityCore/TrinityCore/blob/3.3.5/AUTHORS) -- All the [MaNGOS, ScriptDev2 and UDB developers and contributors](https://github.com/cmangos/mangos-wotlk/blob/master/AUTHORS.md) - +This project exists thanks to the [authors](https://github.com/azerothcore/azerothcore-wotlk/blob/master/AUTHORS). ## Important Links -- [Doxygen Documentation](https://www.azerothcore.org/pages/doxygen/index.html) - -- [Code of Conduct](https://github.com/azerothcore/azerothcore-wotlk/blob/master/.github/CODE_OF_CONDUCT.md) +- [Doxygen documentation](https://www.azerothcore.org/pages/doxygen/index.html) - [Website](http://www.azerothcore.org/) - [AzerothCore catalogue](http://www.azerothcore.org/catalogue.html "Modules, tools, and other stuff for AzerothCore") (modules, tools, etc...) -- [Module template / Module skeleton](https://github.com/azerothcore/skeleton-module/) -- [Our community hub (Discord)](https://discord.gg/gkt4y2x) +- [Our Discord server](https://discord.gg/gkt4y2x) - [Our wiki](http://www.azerothcore.org/wiki "Easy to use and developed by AzerothCore founder") -- [Our Forum](https://github.com/azerothcore/azerothcore-wotlk/discussions/) +- [Our forum](https://github.com/azerothcore/azerothcore-wotlk/discussions/) - [Our Facebook page](https://www.facebook.com/AzerothCore/) - [Our LinkedIn page](https://www.linkedin.com/company/azerothcore/) @@ -169,10 +79,10 @@ This project exists thanks to: - The new AzerothCore source components are released under the [GNU AGPL v3](https://github.com/azerothcore/azerothcore-wotlk/blob/master/LICENSE-AGPL3) - The old sources based on MaNGOS/TrinityCore are released under the [GNU GPL v2](https://github.com/azerothcore/azerothcore-wotlk/blob/master/LICENSE-GPL2) +It's important to note that AzerothCore is not an official Blizzard Entertainment product, and it is not affiliated with or endorsed by World of Warcraft or Blizzard Entertainment. AzerothCore does not in any case sponsor nor support illegal public servers. If you use this project to run an illegal public server and not for testing and learning it is your own personal choice. ## Special thanks [JetBrains](https://www.jetbrains.com/?from=AzerothCore) is providing free [open-source licenses](https://www.jetbrains.com/community/opensource/) to the AzerothCore developers. [](https://www.jetbrains.com/?from=AzerothCore) - |