From 14ec731adb9d98a358340f357340cf9f1f7f175d Mon Sep 17 00:00:00 2001 From: Maximator Date: Thu, 5 Jan 2023 13:48:25 +0100 Subject: [PATCH] Add shared data advice in readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c776fa0..4cd55b9 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ Any help will be greatly appreciated. #### Contents * [Overview][] +* [Guide lines][] * [Links][] @@ -26,6 +27,13 @@ __Okay, nice project. Is it actually working?__ _I just want those files..._ Yeah! We have it hosted on AppSpot. Take a look: [BattleScribe Data on Appspot][] +## Guide lines +### Sharing data +It is better practice to define common entries/rules in a single file to get them from any army catalogue and to easily maintain it without duplicate oddities. +* Common model between armies defined in a single original catalogue (eg. Mercenary) and included in another with a catalogueLink. +* Model's special rules in the game system's shared rules section. +* Weapon rules in their corresponding army catalogue's shared rules section. If you notice this weapon's rule is shared between armies, then define it in game system's shared rules. +* Theme force rules in their corresponding army catalogue's shared rules section. ## Links