zaklaus
/
mod-needs-system
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
mod-needs-system/.github
History
Dominik Madarász 76d04c8dae Initial commit - mod-needs-system 2024-06-20 16:13:38 +02:00
..
ISSUE_TEMPLATE Initial commit - mod-needs-system 2024-06-20 16:13:38 +02:00
workflows Initial commit - mod-needs-system 2024-06-20 16:13:38 +02:00
README.md Initial commit - mod-needs-system 2024-06-20 16:13:38 +02:00
README_ES.md Initial commit - mod-needs-system 2024-06-20 16:13:38 +02:00

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.