diff options
Diffstat (limited to 'docs/getting-started.md')
| -rw-r--r-- | docs/getting-started.md | 28 |
1 files changed, 10 insertions, 18 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index b465bf5..9a5f24e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -37,14 +37,13 @@ Would you like to stick with **Windows** or **macOS**? That's absolutely fine.  - ### Different ways to install AzerothCore Basically, there are 3 main ways to install AC: -- the "**classic setup**": this is the traditional setup you would normally use to install a common WoW emulator. **All operating systems are supported.** Doing this setup also probably gives you a better overview of the components of the server. -- the "**docker setup**": this is a simplified setup that uses Docker to automate a lot of things for you. This setup is typically easier. **You can use this setup in all operating systems where you can install [Docker](https://www.docker.com/products/docker-desktop).** -- the "**dashboard setup**": this is an **EXTREMELY EASY** way of installing AzerothCore in your machine, based on a collection of bash scripts created by [Yehonal](https://github.com/Yehonal). However, **you can only use this setup in Ubuntu** or similar platforms. Windows is not supported, and probably we are not there yet with macOS as well. +- The "**classic setup**": this is the traditional setup you would normally use to install a common WoW emulator. **All operating systems are supported.** Doing this setup also probably gives you a better overview of the components of the server. +- The "**docker setup**": this is a simplified setup that uses Docker to automate a lot of things for you. This setup is typically easier. **You can use this setup in all operating systems where you can install [Docker](https://www.docker.com/products/docker-desktop).** +- The "**dashboard setup**": this is an **EXTREMELY EASY** way of installing AzerothCore in your machine, based on a collection of bash scripts created by [Yehonal](https://github.com/Yehonal). However, **you can only use this setup in Ubuntu** or similar platforms. Windows is not supported, and probably we are not there yet with macOS as well. You can choose one setup, or even try more than one. You can find all the instructions here: @@ -56,7 +55,6 @@ Got your WoW server installed? Congratulations! Now let's see what you can do ne  - ## Access the game, learn the GM commands First of all, `set realmlist localhost` and join your own server using the `test1` account with password `a` (yes, one-letter password). This account is already `GM` so you can use the commands from this list: @@ -67,7 +65,6 @@ Get confident with the commands, you will need them for any administration, test  - ## Consider learning git You can just blindly copy-paste the `git` commands that you'll see in the tutorials linked here, most likely you will not have issues with them. @@ -78,7 +75,6 @@ You can find plenty of resources online about learning `git`, for example [try.g  - ## Learn how to update your WoW server We release improvements to AzerothCore on a daily basis. You should learn how to update your server and keep updating it often. We recommend avoiding working on older versions of AzerothCore because they can have bugs that we already resolved and you don't want to stay behind. @@ -89,12 +85,11 @@ So it is **very important** that you update your AzerothCore server regularly. W After you follow the update procedure, it is important to **verify** that: -- your server application (core) has been properly updated, use the `server info` command to make sure of it -- your DB has been properly updated and aligned to your core version, [read this answer on stackoverflow](https://stackoverflow.com/a/55282168/3497671) +- Your server application (core) has been properly updated, use the `server info` command to make sure of it. +- Your DB has been properly updated and aligned to your core version, [read this answer on stackoverflow](https://stackoverflow.com/a/55282168/3497671).  - ## Learn to check out PRs A great way to start contributing is by testing PRs made by other contributors. This is not only quite easy to do, but it is extremely helpful for the project and can help you to get into our development process. @@ -105,7 +100,6 @@ This topic is so important that there is a dedicated tutorial for it:  - ## Learning how to work with the Database The Database is the best place to start developing a WoW server. Because it's easier than the other components, and there are tools that are able to automatically generate the code for you. For example, Keira3. @@ -129,7 +123,6 @@ You'll need a generic database management tool too in order to manage tables and  - ### The DB documentation is your friend Always read the documentation about every table that you deal with: @@ -158,7 +151,6 @@ The AI of most of the creatures you'll find in the world is done with SmartAI. W  - ### Learn the SQL language Usually, you'll need only the basics of the SQL language, and in most cases, you'll probably figure it out by yourself, however, it's not a bad idea to read about the SQL language. You can find a lot of resources online, for example: @@ -178,11 +170,11 @@ You can submit your improvement via PR. Read this guide: If you mastered some of the above parts, there is already **A LOT** you can do to help our project and becoming a contributor. For example: -- help the developers by testing PRs and giving your feedback -- do some bug triaging by confirming issues and helping us to identify and close the invalid reports -- you can also help by [triaging the bugs coming from the players of ChromieCraft](https://github.com/chromiecraft/chromiecraft) (our child-project) -- report any bug that you may find yourself -- try to fix bugs, a lot of them can just be fixed with some SQL and you can use Keira3 for that (e.g. using SmartAI or other embedded editors). Being this an open-source project, you can find plenty of examples on our main GitHub repository +- Help the developers by testing PRs and giving your feedback +- Do some bug triaging by confirming issues and helping us to identify and close the invalid reports +- You can also help by [triaging the bugs coming from the players of ChromieCraft](https://github.com/chromiecraft/chromiecraft) (our child-project) +- Report any bug that you may find yourself +- Try to fix bugs, a lot of them can just be fixed with some SQL and you can use Keira3 for that (e.g. using SmartAI or other embedded editors). Being this an open-source project, you can find plenty of examples on our main GitHub repository Would you like to talk to us? Join [the AzerothCore Discord server](https://discordapp.com/invite/gkt4y2x). |