ce2a990495
I've noticed some sprawl in the README.md. The following edits have been made around the goal of clarity, brevity, and emphases when needed: - Removed dead link to the Spanish README.md at the top. The README_ES.md file itself is not removed from the repo, but is however out of date and does not seem useful at this time - Removed the addons section. This seems to be covered by the Wiki in the Documentation section unless I'm mistaken? We can add these back if needed - Reorganized installation instructions to emphasize the importance of using the Playerbots branch of AzerothCore for all installations - Moved the platform support from the Frequently Asked Questions section to the installation instructions - Modified punctuation of bulleted list. These can return if it irks someone, but it seems easier to read without them - Added a encouragement to star the project for updates and gain more visibility - Removed the Frequently Asked Questions section. I encourage this to be covered in a wiki page but it can return if deemed necessary. I think a lot of it can be moved to other sections if we really need them in there - Added a "Contributing" section that replaces the Coding Standards section - Coding Standards are included in the Contributing section - Added a second link to the Discord server in the Contributing section - Removed a link to the main Playerbots branch from the introduction section. This is covered and emphasized in the installation section instead - Migrated the encouragements to make bug reports from the introduction, along with the message that this is still in active development, to the contributing section - Reduced redundant language when not necessary (e.g. "As noted above,") - Updated language around custom branch and require branch for uniformity. This will make it more clear to the users about the subject - Removed "Classic" from the "Classic Installation" terminology for being inaccurate. The subject is now known simply as "Cloning the Repositories" while "Docker Installation" still remains distinct. This will make what was formerly known as "Classic Installation" as de facto default - Appended the "Documentation" section with add-on information - Unified all instances of AddOn to the Blizzard spelling without a hyphen following the WoW 3.3.5a client spelling - Appended "AzerothCore" to instances of "branch" to ensure readers they are, in fact, installing AzerothCore here from our required branch
Playerbots Module
mod-playerbots is an AzerothCore module that adds player-like bots to a server. The project is based off IKE3's Playerbots.
Features include:
- The ability to log in alt characters as bots, allowing players to interact with their other characters, form parties, level up, and more
- Random bots that wander through the world, complete quests, and otherwise behave like players, simulating the MMO experience
- Bots capable of running most raids and battlegrounds
- Highly configurable settings to define how bots behave
- Excellent performance, even when running thousands of bots
We also have a Discord server where you can discuss the project, ask questions, and get involved in the community!
Installation
Supported platforms are Ubuntu, Windows, and macOS. Other Linux distributions may work, but may not receive support.
All mod-playerbots installations require a custom branch of AzerothCore: mod-playerbots/azerothcore-wotlk/tree/Playerbot. This branch allows the playerbots module to build and function. Updates from the upstream are implemneted regularly to this branch. Instructions for installing this required branch and this module are provided below.
Cloning the Repositories
To install both the required branch of AzerothCore and the mod-playerbots module from source, run the following:
git clone https://github.com/mod-playerbots/azerothcore-wotlk.git --branch=Playerbot
cd azerothcore-wotlk/modules
git clone https://github.com/mod-playerbots/mod-playerbots.git --branch=master
For more information, refer to the AzerothCore Installation Guide and Installing a Module pages.
Docker Installation
Docker installations are considered experimental (unofficial with limited support), and previous Docker experience is recommended. To install the mod-playerbots on Docker, first clone the required branch of AzerothCore and this module:
git clone https://github.com/mod-playerbots/azerothcore-wotlk.git --branch=Playerbot
cd azerothcore-wotlk/modules
git clone https://github.com/mod-playerbots/mod-playerbots.git --branch=master
Afterwards, create a docker-compose.override.yml file in the azerothcore-wotlk directory. This override file allows for mounting the modules directory to the ac-worldserver service which is required for it to run. Put the following inside and save:
services:
ac-worldserver:
volumes:
- ./modules:/azerothcore/modules:ro
Additionally, this override file can be used to set custom configuration settings for ac-worldserver and any modules you install as environment variables:
services:
ac-worldserver:
environment:
AC_RATE_XP_KILL: "1"
AC_AI_PLAYERBOT_RANDOM_BOT_AUTOLOGIN: "1"
volumes:
- ./modules:/azerothcore/modules:ro
For example, to double the experience gain rate per kill, take the setting Rate.XP.Kill = 1 from woldserver.conf, convert it to an environment variable, and change it to the desired setting in the override file to get AC_RATE_XP_KILL: "2". If you wanted to disable random bots from logging in automatically, take the AiPlayerbot.RandomBotAutologin = 1 setting from playerbots.conf and do the same to get AC_AI_PLAYERBOT_RANDOM_BOT_AUTOLOGIN: "0". For more information on how to configure Azerothcore, Playerbots, and other module settings as environment variables in Docker Compose, see the "Configuring AzerothCore in Containers" section in the Install With Docker guide.
Before building, consider setting the database password. One way to do this is to create a .env file in the root azerothcore-wotlk directory using the template. This file also allows you to set the user and group Docker uses for the services in case you run into any permissions issues, which are the most common cause for Docker installation problems.
Use docker compose up -d --build to build and run the server. For more information, including how to create an account and taking backups, refer to the Install With Docker page.
Documentation
The Playerbots Wiki contains an extensive overview of AddOns, commands, raids with programmed bot strategies, and recommended performance configurations. Please note that documentation may be incomplete or out-of-date in some sections, and contributions are welcome.
Bots are controlled via chat commands. For larger bot groups, this can be cumbersome. Because of this, community members have developed client AddOns to allow controlling bots through the in-game UI. We recommend you check out their projects listed in the AddOns and Submodules page.
Contributing
This project is still under development. We encourage anyone to make contributions, anything from pull requests to reporting issues. If you encounter any errors or experience crashes, we encourage you report them as GitHub issues. Your valuable feedback will help us improve this project collaboratively.
If you make coding contributions, mod-playerbots complies with the C++ Code Standards established by AzerothCore. Each Pull Request must include all test scenarios the author performed, along with their results, to demonstrate that the changes were properly verified.
We recommend joining the Discord server to make your contributions to the project easier, as a lot of active support is carried out through this server.
Please click on the "⭐" button to stay up to date and help us gain more visibility on GitHub!
Acknowledgements
mod-playerbots is is based off ZhengPeiRu21/mod-playerbots and celguar/mangosbot-bots. We extend our gratitude to @ZhengPeiRu21 and @celguar for the continued efforts in maintaining the module.
Also, a thank you to the many contributors who've helped build this project: