Guidelines

Hello! Here you will find tips or not very strict rules that we follow to make our work easier.

General Guidelines:

1. If you want to commit changes that aren't yours, are completely generated, moved from one place to another or contain a lot of deleted lines, commented out lines, please TRY TO write in "(GDC)" at the end of your commit message.
2. TRY TO talk to reviewers! When you fix a bug or implement a feature mentioned in the review, say to everyone on GitHub it's fixed or implemented!
3. TRY TO add wc at the beginning of non-vanilla files (created for this mod), so we can distinguish which files are related to the mod. Examples: wc_third_war_events.txt, wc_event_modifiers.txt.
4. PLEASE read [https://github.com/Warcraft-GoA-Development-Team/Warcraft-Guardians-of-Azeroth/wiki/Console-Tricks](these Console Tricks). They will help in testing.
5. PLEASE read these GitHub Text Tricks. They will help in communicating on GitHub.

Scripting Guidelines:

1. We RECOMMEND TO use Notepad++ for scripting. In these Notepad Tricks you will find the download link and some tricks.
2. TRY TO follow this Code Style. This unified code style allows you to save time spent interpreting the code of other developers.
3. When you create some new script like an event, decision etc., TRY TO leave a comment so other developers can know context.
4. If you change vanilla lines, TRY TO write comment # Warcraft before these lines and highlight it by making gaps (empty lines) before and after the mod lines.

Example

prisoner = no

# Warcraft
culture = gurubashi
trait = creature_troll

trait = greedy

Performance Guidelines

1. TRY TO to use weight_multiplier instead of mean_time_to_happen. This makes the game less laggy. More info about what weight_multiplier is, you can find in this Event Modding Article.
2. TRY TO add as much Event Pre-triggers and Decision Pre-triggers as possible. This makes the game less laggy. Design your features so they're limited to only_playable = yes or ai = no or both.
3. If you're working on Targeted Decisions, TRY NOT TO use all filter. Especially, if it's ai_target_filter.

Event Guidelines:

1. TRY TO name Event Namespaces like this: WC + 3-2 Letters of Abbreviation. For examples, the namespace of wc_third_war_events.txt is WCTHW.

Character Guidelines:

1. TRY NOT TO make character attributes higher than 25 (35 maximum). Having a higher value than this breaks certain vanilla events and balance.

Province Guidelines:

1. TRY NOT TO change province attributes without changing Warcraft-Guardians-of-Azeroth\map\provinceDef.xls. This is because the next map generation will clear all of your changes. For more information, Visit This Link. DO NOT open this provinceDef.xls in any program except Microsoft Excel 2010 or 2013 or 2016.

Localization Guidelines:

1. TRY TO add new localization at the end of the file.
2. TRY TO to write the localization of decision names, modifier names, event titles, trait names etc. while following these rules:
   • Capitalize nouns, verbs and adjectives. Example: Use Poisonous Gas, Conjured Food for Poor.
   • Skip articles except the article when it is the only object in the world. Normal examples: Subdue Void Creature, Increases §GDeath Knight Level Up Chance§!. Examples with the: Restore the Empire of Zul, Join the Black Empire.
   • Write them as short and as concise as possible.