public/mirror-azerothcore-skeleton-module
Watch
2
0
Fork
You've already forked mirror-azerothcore-skeleton-module
 0
mirror of https://github.com/azerothcore/skeleton-module.git synced 2026-09-17 05:07:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
This is a template, a skeleton of a module to use as a base for your new modules. https://github.com/azerothcore/azerothcore-wotlk/wiki/Create-a-Module
67 commits 1 branch 0 tags 174 KiB
  • C++ 62.9%
  • Shell 37.1%
Find a file
Exact
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Andrew 877c24d9e7
 Merge pull request #33 from Tereneckla/master 
refactor: Cache the Config Value
2026-04-12 17:57:41 -03:00
.github Update core-build.yml (#35) 2025-09-20 20:40:20 +02:00
apps feat. upgrade module (#30) 2023-07-28 00:53:24 -03:00
conf feat. upgrade module (#30) 2023-07-28 00:53:24 -03:00
data add .gitkeep to empty db dirs 2025-02-23 01:10:05 +01:00
src Update src/MyPlayer.cpp 2025-10-15 16:40:46 +00:00
.editorconfig .editorconfig - Unify coding style 2018-05-17 15:29:33 +02:00
.gitattributes Update .gitattributes 2018-10-03 15:12:11 +02:00
.gitignore Update .gitignore 2018-09-19 14:33:21 +02:00
include.sh chore(Module/Structure): Change structure for new modules (#29) 2023-06-15 18:59:31 -03:00
LICENSE chore(Module/Structure): Change structure for new modules (#29) 2023-06-15 18:59:31 -03:00
pull_request_template.md chore(Module/Structure): Change structure for new modules (#29) 2023-06-15 18:59:31 -03:00

.github/README.md

SKELETON - Module template

English | Español

How to create your own module

  1. Use the script create_module.sh located in modules/ to start quickly with all the files you need and your git repo configured correctly (heavily recommended).
  2. You can then use these scripts to start your project: https://github.com/azerothcore/azerothcore-boilerplates
  3. Do not hesitate to compare with some of our newer/bigger/famous modules.
  4. Edit the README.md and other files (include.sh etc...) to fit your module. Note: the README is automatically created from README_example.md when you use the script create_module.sh.
  5. Publish your module to our catalogue.

How to test your module?

Disable PCH (precompiled headers) and try to compile. To disable PCH, set -DNOPCH=1 with Cmake (more info here).

If you forgot some headers, it is time to add them!

Licensing

The default license of the skeleton-module template is the MIT but you can use a different license for your own modules.

So modules can also be kept private. However, if you need to add new hooks to the core, as well as improving existing ones, you have to share your improvements because the main core is released under the AGPL license. Please provide a PR if that is the case.