diff options
| author | Kitzunu <24550914+Kitzunu@users.noreply.github.com> | 2023-01-24 22:42:18 +0100 |
|---|---|---|
| committer | Kitzunu <24550914+Kitzunu@users.noreply.github.com> | 2023-01-24 22:42:18 +0100 |
| commit | 2e909fe01925ac4bb586d46f0e0452bde2e6edf0 (patch) | |
| tree | c28604cda20376c404561745d538ccac239c9012 /docs/add-a-module.md | |
| parent | c54a4ef025dfa1265bc47e14abc96a01f23ab09c (diff) | |
| download | wiki-2e909fe01925ac4bb586d46f0e0452bde2e6edf0.tar.gz wiki-2e909fe01925ac4bb586d46f0e0452bde2e6edf0.tar.bz2 wiki-2e909fe01925ac4bb586d46f0e0452bde2e6edf0.zip | |
Module guide
Diffstat (limited to 'docs/add-a-module.md')
| -rw-r--r-- | docs/add-a-module.md | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/docs/add-a-module.md b/docs/add-a-module.md deleted file mode 100644 index 9d08765..0000000 --- a/docs/add-a-module.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -redirect_from: "/Add-a-module" ---- - -# Add a module - -1. Get the module from the catalogue: [https://www.azerothcore.org/catalogue](https://www.azerothcore.org/catalogue) (For this example, we'll be using this module: [mod-npc-services](https://www.azerothcore.org/catalogue.html#/details/177019524)) - -2. - Clone it using Git as you did during the [core installation](core-installation.md). Set the `Destination` to "C:\Azerothcore\modules\mod-npc-services" (Recommended method) [Jump to step 9 to make sure it cloned correctly] - - Use the download button on the catalogue page - - Use `Download ZIP` button on the module's Github page - -3. If in the previous step you chose not to clone the repo, you'll need to extract the downloaded ZIP archive. Once this is done, your resulting folder should look like this: - - -4. Due to a discrepancy between the way AzerothCore loads modules and how Github names ZIP code archives, you will need to rename the directory name. The folder will have the branch name placed onto the end of it, as in mod-npc-services-_master_. You will need to remove this branch name, leaving only mod-npc-services: - - -5. Copy the renamed folder, as you'll be pasting it into the modules folder - -6. Navigate to your AzerothCore modules folder (C:\Azerothcore) - -7. You will see in that directory the modules folder: - - -8. Open the modules folder, it should look quite sparse: - - -9. Paste the module folder into the modules folder, it should now look like this: - - -10. Now to recompile! Open CMake and configure. If the module has loaded correctly, you should now see it in the CMake log as well: - - -11. Then generate: - - -12. Now open the generated project file, clean, and build the solution - -## SQL Queries - -- If your module contains a `sql` folder, you will need to run the queries inside for the module to function correctly: - - - - Opening this folder, we should then see any of these three folders: auth, characters, or world. In the example module, it contains a world folder: - - - - Depending on the module, there could be more than one query file you would need to execute. Refer to the readme of the module for information regarding this. In our case, there is only one `.sql` file to run, so our job is easy: - - -13. Open your SQL editor of choice. In this case, we will be using HeidiSQL. You will need to select the database the query applies to on the left before you run the query. Since our query was in the world folder, we will select `acore_world`. Once the database is selected, we will then load the SQL file: - - -14. Once you navigate to the SQL file and open it up, it will open the query in a new tab. Double check that the database tab is pointing to the right database, then run the query using the marked button above the tabs: - - -With that, the module is installed! In the case of mod-npc-services, we'd then launch our server and run the command `.npc add 55002` (The NPC Entry) to spawn the NPC. - -## DBC Patches - -If your module contains DBC files (Such as [mod-arac](https://github.com/azerothcore/mod-arac) or [mod-worgoblin](https://github.com/heyitsbench/mod-worgoblin)) there are a couple extra steps you need to take to install them correctly. The DBC files included with the module will need to be copied to your server's DBC folder in its Data directory. If you're unsure where this directory is, it is set in your worldserver.conf under the `DataDir` option. - -You will also need to add these patches to your client. In the case of mod-arac, it's small enough that you can grab the `Patch-A.MPQ` file directly from the repository. You can then copy it into the `Data` folder of your Wow client. However, in the case of a bigger patch like mod-worgoblin, you'll need to take the whole `patch-contents` folder and copy it to the `Data` folder of your Wow client, but you'll also need to rename the folder to `Patch-A.MPQ`. **You will need to do this step for every user connecting to your server with these changes.** - -You don't necessarily have to use the letter A specifically. If you use the common HD patch for example, you may find that you have many patches in your Wow Data folder already, and if Patch-A is already taken, the client will also accept numbers 1-9 and letters A-Z. Be aware, however, that the client has an order in which it will read patches, specifically it will read patches 1-9,A-Z, with the contents of 1 being the first and the contents of Z being the last loaded by the client. - -If you're using a client other than enUS, you may have to place the patch file in your locale folder and name it accordingly. For example, using a deDE client, the path would look like `Data/deDE/patch-deDE-A.MPQ`. This is due to other localizations of the client having differences in patch load order. |