diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ac-dashboard-core-installation.md | 4 | ||||
| -rw-r--r-- | docs/command.md | 2 | ||||
| -rw-r--r-- | docs/conditions.md | 8 | ||||
| -rw-r--r-- | docs/gm-commands.md | 1 | ||||
| -rw-r--r-- | docs/linux-server-setup.md | 14 | ||||
| -rw-r--r-- | docs/macos-core-installation.md | 20 | ||||
| -rw-r--r-- | docs/playercreateinfo_skills.md | 2 | ||||
| -rw-r--r-- | docs/playercreateinfo_spell_custom.md | 4 | ||||
| -rw-r--r-- | docs/quest_template_addon.md | 2 | ||||
| -rw-r--r-- | docs/reserved_name.md | 2 | ||||
| -rw-r--r-- | docs/spell_area.md | 2 | ||||
| -rw-r--r-- | docs/sql-standards.md | 51 |
12 files changed, 66 insertions, 46 deletions
diff --git a/docs/ac-dashboard-core-installation.md b/docs/ac-dashboard-core-installation.md index cb9089c..0b4c080 100644 --- a/docs/ac-dashboard-core-installation.md +++ b/docs/ac-dashboard-core-installation.md @@ -79,9 +79,9 @@ Get the latest client data: ./acore.sh client-data ``` -### Server config files (optional) +### Server config files -create these 2 files if you want to change the default configurations of the server +create these 2 files. They contain the default configuration for the worldserver and authserver, if you don't wish to modify simply copying them is enough. #### Linux and Mac diff --git a/docs/command.md b/docs/command.md index 0958c80..fe8e507 100644 --- a/docs/command.md +++ b/docs/command.md @@ -22,7 +22,7 @@ Holds help and security information for commands. This table does NOT create new ### name -The name of the command. +The name of the command. See: [included commands](gm-commands.md) ### security diff --git a/docs/conditions.md b/docs/conditions.md index 55a34b6..566cab2 100644 --- a/docs/conditions.md +++ b/docs/conditions.md @@ -697,7 +697,7 @@ data</strong> (see corresponding script source files for more info)</td> CONDITION_CLASS</td> <td><br /> 15</td> -<td>Class mask from <a href="http://www.azerothcore.org/wiki/ChrClasses">ChrClasses.dbc</a><br /> +<td>Class mask from <a href="http://www.azerothcore.org/wiki/chrclasses">ChrClasses.dbc</a><br /> Add flags together for all classes where condition is true.</td> <td>Always 0</td> <td>Always 0</td> @@ -705,7 +705,7 @@ Add flags together for all classes where condition is true.</td> <tr class="odd"> <td>CONDITION_RACE</td> <td>16</td> -<td>Race mask from <a href="http://www.azerothcore.org/wiki/ChrRaces">ChrRaces.dbc</a> .<br /> +<td>Race mask from <a href="http://www.azerothcore.org/wiki/chrraces">ChrRaces.dbc</a> .<br /> Add flags together for all races where condition is true.</td> <td>Always 0</td> <td>Always 0</td> @@ -1347,13 +1347,13 @@ Note: it will show or hide spells in vehicle spell bar. \***CONDITION\_CLASS = 15** -- - ConditionValue1: class mask. Add flags together for all classes condition should be true for. See [ChrClasses.dbc](ChrClasses) +- - ConditionValue1: class mask. Add flags together for all classes condition should be true for. See [ChrClasses.dbc](chrclasses) - ConditionValue2: always 0 - ConditionValue3: always 0 \***CONDITION\_RACE = 16** -- - ConditionValue1: race mask. Add flags together for all races condition should be true for. See [ChrRaces.dbc](ChrRaces) +- - ConditionValue1: race mask. Add flags together for all races condition should be true for. See [ChrRaces.dbc](chrraces) - ConditionValue2: always 0 - ConditionValue3: always 0 diff --git a/docs/gm-commands.md b/docs/gm-commands.md index 6dca5d7..305f78a 100644 --- a/docs/gm-commands.md +++ b/docs/gm-commands.md @@ -325,6 +325,7 @@ Note: Some commands are working only by selecting a player or a creature. These | npc delete | 3 | `.npc delete [#guid]` | Delete creature with guid #guid (or the selected if no guid is provided) | | npc follow stop | 2 | `.npc follow stop` | Selected creature (non pet) stop follow you. | | npc follow | 2 | `.npc follow start` | Selected creature start follow you until death/fight/etc. | +| npc guid | 1 | `.npc guid` | Intended to display database GUID of targeted creature. Currently displays GUID, faction, NPC flags, Entry ID, Model ID for selected creature. | | npc info | 1 | `.npc info` | Display a list of details for the selected creature. The list includes: - GUID, Faction, NPC flags, Entry ID, Model ID, - Level, - Health (current/maximum), - Field flags, dynamic flags, faction template, - Position information, - and the creature type, e.g. if the creature is a vendor. | | npc move | 3 | `.npc move [#creature_guid]` | Move the targeted creature spawn point to your coordinates. | | npc playemote | 3 | `.npc playemote #emoteid` | Make the selected creature emote with an emote of id #emoteid. | diff --git a/docs/linux-server-setup.md b/docs/linux-server-setup.md index 632bbe6..2b1e84c 100644 --- a/docs/linux-server-setup.md +++ b/docs/linux-server-setup.md @@ -9,27 +9,27 @@ Go to your AzerothCore build directory (e.g. $HOME/build/bin/) and copy the following files to your World of Warcraft binaries directory. -* **mapextractor** +* **map_extractor** * **mmaps_generator** -* **vmap4assembler** -* **vmap4extractor** +* **vmap4_assembler** +* **vmap4_extractor** **DBC and Maps files** ``` cd <your WoW client directory> -./mapextractor +./map_extractor ``` -**Visual Maps (aka vmaps) Note: If you stop vmap4extractor before finish you will need to delete the Buildings directory before start again.** +**Visual Maps (aka vmaps) Note: If you stop vmap4_extractor before finish you will need to delete the Buildings directory before start again.** You can also extract vmaps which will take quite a while depending on your machine (up to hours on ancient hardware). ``` cd <your WoW client directory> -./vmap4extractor +./vmap4_extractor mkdir vmaps; -./vmap4assembler Buildings vmaps +./vmap4_assembler Buildings vmaps ``` When this is complete you will receive the following message which can be safely ignored. diff --git a/docs/macos-core-installation.md b/docs/macos-core-installation.md index db1e49d..eb639a4 100644 --- a/docs/macos-core-installation.md +++ b/docs/macos-core-installation.md @@ -64,26 +64,18 @@ cmake ../ \ -DCMAKE_INSTALL_PREFIX=$HOME/azeroth-server/ \ -DTOOLS_BUILD=all \ -DSCRIPTS=static \ --DMYSQL_ADD_INCLUDE_PATH=/usr/local/include \ --DMYSQL_LIBRARY=/usr/local/lib/libmysqlclient.dylib \ --DREADLINE_INCLUDE_DIR=/usr/local/opt/readline/include \ --DREADLINE_LIBRARY=/usr/local/opt/readline/lib/libreadline.dylib \ +-DMYSQL_ADD_INCLUDE_PATH=/opt/homebrew/include/mysql \ +-DMYSQL_LIBRARY=/opt/homebrew/lib/libmysqlclient.dylib \ +-DREADLINE_INCLUDE_DIR=/opt/homebrew/opt/readline/include \ +-DREADLINE_LIBRARY=/opt/homebrew/opt/readline/lib/libreadline.dylib \ -DOPENSSL_INCLUDE_DIR="$OPENSSL_ROOT_DIR/include" \ -DOPENSSL_SSL_LIBRARIES="$OPENSSL_ROOT_DIR/lib/libssl.dylib" \ -DOPENSSL_CRYPTO_LIBRARIES="$OPENSSL_ROOT_DIR/lib/libcrypto.dylib" ``` - -To know the amount of cores available. -You can use the following command - -```sh -nproc --all -``` - -Then, replacing `4` with the number of threads that you want to execute, type: +Then, to build and install: ```sh -make -j 4 +make -j `nproc` make install ``` diff --git a/docs/playercreateinfo_skills.md b/docs/playercreateinfo_skills.md index fd0a3c6..f71aa04 100644 --- a/docs/playercreateinfo_skills.md +++ b/docs/playercreateinfo_skills.md @@ -26,7 +26,7 @@ This table holds information on what skills newly created characters should star ### racemask -One or more character's race. See [ChrRaces.dbc](ChrRaces). +One or more character's race. See [ChrRaces.dbc](chrraces). ### classmask diff --git a/docs/playercreateinfo_spell_custom.md b/docs/playercreateinfo_spell_custom.md index 093447d..f7f1f6b 100644 --- a/docs/playercreateinfo_spell_custom.md +++ b/docs/playercreateinfo_spell_custom.md @@ -24,11 +24,11 @@ Please note you'll have to set PlayerStart.AllSpells to 1 in config, else this t ### racemask -One or more character's race. See [ChrRaces.dbc](ChrRaces). +One or more character's race. See [ChrRaces.dbc](chrraces). ### classmask -One or more character's class. See [ChrClasses.dbc](ChrClasses) +One or more character's class. See [ChrClasses.dbc](chrclasses) ### Spell diff --git a/docs/quest_template_addon.md b/docs/quest_template_addon.md index 98f0897..8e7853b 100644 --- a/docs/quest_template_addon.md +++ b/docs/quest_template_addon.md @@ -59,7 +59,7 @@ Maximum player level at which a character can get the quest. ### **AllowableClasses** Classes required to get the quest. 0 means the quest is available for all classes. -This field is a bitmask, you can combine class values. See [ChrClasses.dbc](ChrClasses) +This field is a bitmask, you can combine class values. See [ChrClasses.dbc](chrclasses) ### **SourceSpellID** diff --git a/docs/reserved_name.md b/docs/reserved_name.md index 66303fe..08a957d 100644 --- a/docs/reserved_name.md +++ b/docs/reserved_name.md @@ -16,4 +16,4 @@ ### name -`field-no-description|1` +Name to be reserevd diff --git a/docs/spell_area.md b/docs/spell_area.md index 965dcc5..a503656 100644 --- a/docs/spell_area.md +++ b/docs/spell_area.md @@ -62,7 +62,7 @@ The value has the following effect: ### racemask -This ID is automatically called from [ChrRaces.dbc](ChrRaces). The bitmask is entered here. +This ID is automatically called from [ChrRaces.dbc](chrraces). The bitmask is entered here. - 0, 1791 = All Races - 690 (2 + 16 + 32 + 128 + 512) = Horde Only diff --git a/docs/sql-standards.md b/docs/sql-standards.md index 23823c5..7604cf7 100644 --- a/docs/sql-standards.md +++ b/docs/sql-standards.md @@ -13,6 +13,8 @@ We always use backticks \` around table- and column names. \`creature_loot_templ We always use single quotes around string values ' ' but NEVER around an integer. +We never include the database name in queries. + ### INSERT & DELETE We always DELETE before an INSERT to ensure we always put fields in the query and that no errors occur. @@ -203,12 +205,13 @@ We do not define the width of an integer when we create new columns. (Width is d TINYINT(M) -> TINYINT SMALLINT(M) -> SMALLINT INT(M) -> INT -MEDIUMINT(M) -> MEDIUMINT BIGINT(M) -> BIGINT BOOL -> Never used, synonym for TINYINT. 0 = false <>0 = true ``` +We never use MEDIUMINT. Use INT instead! + ### Float, Double, Decimal These data types cannot be UNSIGNED and therefore we use CHECK CONSTRAINTS instead. (UNSIGNED Float, Double, Decimal is deprecated in later versions of MySQL 8) @@ -217,17 +220,6 @@ These data types cannot be UNSIGNED and therefore we use CHECK CONSTRAINTS inste FLOAT UNSIGNED -> CHECK (`column`>=0) ``` -### Character Encoding - -We use UTF8MB4 where you would previously use UTF8 or UTF8MB3. (utf8 is an alias and utf8mb3 is deprecated in later versions of MySQL 8) - -``` -utf8 -> utf8mb4 -utf8mb3 -> utf8mb4 -``` - -To be able to support MariaDB alongside MySQL we are limited to using `utf8mb4_general_ci` as coallation. - ### Check Constraints You can see [here](https://github.com/Azerothcore/azerothcore-wotlk/blob/master/data/sql/base/db_auth/realmlist.sql) how check contraints are made. @@ -242,6 +234,41 @@ SELECT * FROM information_schema.CHECK_CONSTRAINTS; SELECT * FROM information_schema.TABLE_CONSTRAINTS; ``` +### Charset + +We always use `utf8mb4` as charset + +### Collation + +We always use `utf8mb4_unicode_ci` as collation + +### Engine + +We always use `InnoDB` as the engine + +### Row Format + +We always use `DEFAULT` as row format + +### Dummy script for table + +```sql + +DROP TABLE IF EXISTS `our_table_name`; +CREATE TABLE `our_table_name` ( + `aColumnName` INT UNSIGNED NOT NULL DEFAULT '69' COMMENT 'ColumnComment', + `aSecondName` VARCHAR(100) NOT NULL DEFAULT '', + PRIMARY KEY (`aColumnName`), + CONSTRAINT `our_table_name_chk_1` CHECK (`aColumnName` >= 0) +) +COMMENT = 'TableComment' +CHARSET = utf8mb4 +COLLATE = utf8mb4_unicode_ci +ENGINE = InnoDB +ROW_FORMAT = DEFAULT +; +``` + ## Note for SQL reviewer When we work with GUID's, make sure that we use as low entries as possible to fill out the gaps in the database. This can easily be done with tools like [Unused GUID Searcher](https://github.com/azerothcore/unused-guid-search). |