Skip to content

Commit ee64c64

Browse files
authored
make server-setup only link to OS-server-setup (#1066)
* Update linux-core-installation.md * add spanish * mirror core-installation layout * build dir to default given in core-installation * review
1 parent 45ff336 commit ee64c64

File tree

7 files changed

+201
-149
lines changed

7 files changed

+201
-149
lines changed

docs/es/linux-core-installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| Guía de Instalación | |
44
| :- | :- |
55
| Este artículo es parte de la Guía de Instalación. Puede leerlo solo o hacer click en los links previos para navegar con facilidad entre los pasos. |
6-
| [<< Paso 1: Requisitos](linux-requirements) | [Paso 3: Instalación del Servidor >>](linux-server-setup) |
6+
| [<< Paso 1: Requisitos](linux-requirements) | [Paso 3: Instalación del Servidor >>](server-setup) |
77

88
## Software requerido
99

@@ -207,4 +207,4 @@ If you are still having problems, check:
207207
| Installation Guide | |
208208
| :- | :- |
209209
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. |
210-
| [<< Step 1: Requirements](linux-requirements) | [Step 3: Server Setup >>](linux-server-setup) |
210+
| [<< Step 1: Requirements](linux-requirements) | [Step 3: Server Setup >>](server-setup) |

docs/linux-server-setup.md

Lines changed: 66 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,45 @@
33
| Installation Guide | |
44
| :----------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------- |
55
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. |
6-
| [<< Step 2: Core Installation](core-installation) | [Step 4: Database Installation >>](database-installation) |
6+
| [<< Step 2: Core Installation](linux-core-installation) | [Step 4: Database Installation >>](database-installation) |
77

8-
## Extracting DBC, Maps, VMaps & MMaps
8+
**Table of contents**
9+
- [Client Data Files (Download Pre-Extracted)](#option-1-download-pre-extracted-files)
10+
- [Client Data Extractors (Extract Files Yourself)](#option-2-extract-files-yourself)
11+
- [Config Files: Worldserver and Authserver](#config-files-worldserver-and-authserver)
912

10-
Go to your AzerothCore build directory (e.g. $HOME/build/bin/) and copy the following files to your World of Warcraft binaries directory.
13+
Now that you have the source compiled, you need to add the necessary client data. You can either download pre-extracted files or use the compiled extractors to extract the files yourself. Once the data is ready, you must update the **DataDir** option in your **worldserver.conf** file to point to the directory containing the data.
14+
15+
Some files are optional but highly recommended:
16+
17+
| Directory | |
18+
| :-------- | :----------------- |
19+
| dbc | Mandatory |
20+
| maps | Mandatory |
21+
| vmaps | HIGHLY RECOMMENDED |
22+
| mmaps | HIGHLY RECOMMENDED |
23+
| cameras | Recommended |
24+
25+
## Option 1: Download Pre-Extracted Files
26+
27+
28+
If you intend to use an enUS client you can download the data files below. If you intend to use any other language client you will need to [extract](#option-2-extract-files-yourself) the data yourself.
29+
30+
<a class="no-icon" href="https://github.com/wowgaming/client-data/releases/" target="_blank"><i class="fa-solid fa-download"></i> Data files enUS (AC Data v16)</a>
31+
32+
1. Download the files above.
33+
34+
2. Create a new folder within the build folder called **data**. i.e **$AC_CODE_DIR/build/data/**
35+
36+
3. Extract the files from the zip file and place them within the **data** folder.
37+
38+
4. Edit your the [DataDir](#updating-datadir) config option to the location of your folder.
39+
40+
## Option 2: Extract Files Yourself
41+
42+
**(Not needed if you downloaded the files above)**
43+
44+
Go to your AzerothCore build directory (e.g. $AC_CODE_DIR/env/dist/) and copy the following files to your World of Warcraft binaries directory.
1145

1246
* **map_extractor**
1347
* **mmaps_generator**
@@ -55,11 +89,11 @@ mkdir mmaps;
5589
./mmaps_generator
5690
```
5791

58-
Now that everything is completed, you need to copy **dbc**, **maps**, **vmaps** and **mmaps** folders to your AzerothCore build directory (e.g. *$HOME/build/data/*).
92+
Now that everything is completed, you need to copy **dbc**, **maps**, **vmaps** and **mmaps** folders to your AzerothCore build directory (e.g. **$AC_CODE_DIR/build/data/**.
5993

60-
## Setting up the configuration files
94+
## Config Files: Worldserver and Authserver
6195

62-
First of all you need to find the two default config files (named worldserver.conf.dist and authserver.conf.dist) and copy them. Then rename the copies their namesakes without the .dist extension. You can find them within /build/configs/ (may vary).
96+
First of all you need to find the two default config files (named **worldserver.conf.dist** and **authserver.conf.dist**) and copy them. Then rename the copies their namesakes without the .dist extension. You can find them within /build/configs/ (may vary).
6397

6498
Open the .conf files and scroll down to LoginDatabaseInfo, WorldDatabaseInfo, and CharacterDatabaseInfo and enter MySQL login information for the server to be able to access your database.
6599

@@ -76,7 +110,31 @@ They follow this structure:
76110
Variablename = "MySQLIP;Port;Username;Password;database"
77111
```
78112

79-
<br>
113+
The following steps must be verified:
114+
115+
- The hostname (127.0.0.1) can stay the same if AzerothCore is being installed on the same computer that you run WoW on.
116+
If not, follow the instruction in [Realmlist Table](realmlist).
117+
118+
- The port (3306) is the standard configured value. If you changed the default port in your MySQL settings, you must change it accordingly.
119+
The username and password can be variable. You can choose to either:
120+
121+
- use default acore / acore username and password pair.
122+
123+
- create a unique login within a User Manager within your preferred database management tool (commonly identified by an icon that looks like a person or people) and give it the necessary permissions (SELECT, INSERT, UPDATE, DELETE permissions are sufficient, and is much safer).
124+
125+
### Updating DataDir
126+
127+
1. In your **worldserver.conf** file locate the **DataDir** option.
128+
129+
1. Edit it to the path of your folder. i.e **$HOME/azerothcore/data/**
130+
131+
{% include tip.html content="For most **worldserver.conf** setting changes, you can simply type .reload config in-game to see changes instantly without restarting the server." %}
132+
133+
{% include warning.html content="The AzerothCore Team and Owners DO NOT in any case sponsor nor support illegal public servers. If you use these projects to run an illegal public server and not for testing and learning it is your own personal choice." %}
134+
135+
### (Optional) Config options by environment variable
136+
137+
It is possible to load config options via environment variables, which you can read about [here](config-overrides-with-env-var).
80138

81139
## Help
82140

@@ -85,4 +143,4 @@ Variablename = "MySQLIP;Port;Username;Password;database"
85143
| Installation Guide | |
86144
| :----------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------- |
87145
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. |
88-
| [<< Step 2: Core Installation](core-installation) | [Step 4: Database Installation >>](database-installation) |
146+
| [<< Step 2: Core Installation](linux-core-installation) | [Step 4: Database Installation >>](database-installation) |

docs/macos-core-installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| Installation Guide | |
44
| :----------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------- |
55
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. |
6-
| [<< Step 1: Requirements](macos-requirements) | [Step 3: Server Setup >>](server-setup) |
6+
| [<< Step 1: Requirements](macos-requirements) | [Step 3: Server Setup >>](macos-server-setup) |
77

88
## Required software
99

@@ -107,4 +107,4 @@ make install
107107
| Installation Guide | |
108108
| :----------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------- |
109109
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. |
110-
| [<< Step 1: Requirements](macos-requirements) | [Step 3: Server Setup >>](server-setup) |
110+
| [<< Step 1: Requirements](macos-requirements) | [Step 3: Server Setup >>](macos-server-setup) |

docs/macos-server-setup.md

Lines changed: 65 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,44 @@
33
| Installation Guide | |
44
| :----------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------- |
55
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. |
6-
| [<< Step 2: Core Installation](core-installation) | [Step 4: Database Installation >>](database-installation) |
6+
| [<< Step 2: Core Installation](macos-core-installation) | [Step 4: Database Installation >>](database-installation) |
77

8-
## Extracting DBC, Maps, VMaps & MMaps
8+
**Table of contents**
9+
- [Client Data Files (Download Pre-Extracted)](#option-1-download-pre-extracted-files)
10+
- [Client Data Extractors (Extract Files Yourself)](#option-2-extract-files-yourself)
11+
- [Config Files: Worldserver and Authserver](#config-files-worldserver-and-authserver)
912

10-
Go to your AzerothCore build directory (e.g. $HOME/build/bin/) and copy the following files to your World of Warcraft binaries directory.
13+
Now that you have the source compiled, you need to add the necessary client data. You can either download pre-extracted files or use the compiled extractors to extract the files yourself. Once the data is ready, you must update the **DataDir** option in your **worldserver.conf** file to point to the directory containing the data.
14+
15+
Some files are optional but highly recommended:
16+
17+
| Directory | |
18+
| :-------- | :----------------- |
19+
| dbc | Mandatory |
20+
| maps | Mandatory |
21+
| vmaps | HIGHLY RECOMMENDED |
22+
| mmaps | HIGHLY RECOMMENDED |
23+
| cameras | Recommended |
24+
25+
## Option 1: Download Pre-Extracted Files
26+
27+
If you intend to use an enUS client you can download the data files below. If you intend to use any other language client you will need to [extract](#option-2-extract-files-yourself) the data yourself.
28+
29+
<a class="no-icon" href="https://github.com/wowgaming/client-data/releases/" target="_blank"><i class="fa-solid fa-download"></i> Data files enUS (AC Data v16)</a>
30+
31+
1. Download the files above.
32+
33+
2. Create a new folder within the build folder called **data**. i.e. **$HOME/azeroth-server/data/**
34+
35+
3. Extract the files from the zip file and place them within the **data** folder.
36+
37+
4. Edit your the [DataDir](#updating-datadir) config option to the location of your folder.
38+
39+
## Option 2: Extract Files Yourself
40+
41+
**(Not needed if you downloaded the files above)**
42+
43+
Go to your AzerothCore build directory (e.g. $HOME/azeroth-server/bin/) and copy the following files to your World of Warcraft binaries directory.
1144

1245
* **mapextractor**
1346
* **mmaps_generator**
@@ -55,11 +88,11 @@ mkdir mmaps;
5588
./mmaps_generator
5689
```
5790

58-
Now that everything is completed, you need to copy **dbc**, **maps**, **vmaps** and **mmaps** folders to your AzerothCore build directory (e.g. *$HOME/build/data/*).
91+
Now that everything is completed, you need to copy **dbc**, **maps**, **vmaps** and **mmaps** folders to your AzerothCore build directory (e.g. **$HOME/azeroth-server/data/**).
5992

60-
## Setting up the configuration files
93+
## Config Files: Worldserver and Authserver
6194

62-
First of all you need to find the two default config files (named worldserver.conf.dist and authserver.conf.dist) and copy them. Then rename the copies their namesakes without the .dist extension. You can find them within /build/configs/ (may vary).
95+
First of all you need to find the two default config files (named **worldserver.conf.dist** and **authserver.conf.dist**) and copy them. Then rename the copies their namesakes without the .dist extension. You can find them within /build/configs/ (may vary).
6396

6497
Open the .conf files and scroll down to LoginDatabaseInfo, WorldDatabaseInfo, and CharacterDatabaseInfo and enter MySQL login information for the server to be able to access your database.
6598

@@ -76,7 +109,31 @@ They follow this structure:
76109
Variablename = "MySQLIP;Port;Username;Password;database"
77110
```
78111

79-
<br>
112+
The following steps must be verified:
113+
114+
- The hostname (127.0.0.1) can stay the same if AzerothCore is being installed on the same computer that you run WoW on.
115+
If not, follow the instruction in [Realmlist Table](realmlist).
116+
117+
- The port (3306) is the standard configured value. If you changed the default port in your MySQL settings, you must change it accordingly.
118+
The username and password can be variable. You can choose to either:
119+
120+
- use default acore / acore username and password pair.
121+
122+
- create a unique login within a User Manager within your preferred database management tool (commonly identified by an icon that looks like a person or people) and give it the necessary permissions (SELECT, INSERT, UPDATE, DELETE permissions are sufficient, and is much safer).
123+
124+
### Updating DataDir
125+
126+
1. In your **worldserver.conf** file locate the **DataDir** option.
127+
128+
1. Edit it to the path of your folder. i.e **$HOME/azeroth-server/data/**
129+
130+
{% include tip.html content="For most **worldserver.conf** setting changes, you can simply type .reload config in-game to see changes instantly without restarting the server." %}
131+
132+
{% include warning.html content="The AzerothCore Team and Owners DO NOT in any case sponsor nor support illegal public servers. If you use these projects to run an illegal public server and not for testing and learning it is your own personal choice." %}
133+
134+
### (Optional) Config options by environment variable
135+
136+
It is possible to load config options via environment variables, which you can read about [here](config-overrides-with-env-var).
80137

81138
## Help
82139

@@ -85,4 +142,4 @@ Variablename = "MySQLIP;Port;Username;Password;database"
85142
| Installation Guide | |
86143
| :----------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------- |
87144
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. |
88-
| [<< Step 2: Core Installation](core-installation) | [Step 4: Database Installation >>](database-installation) |
145+
| [<< Step 2: Core Installation](macos-core-installation) | [Step 4: Database Installation >>](database-installation) |

0 commit comments

Comments
 (0)