Initial commit - v0.1.0

This initial version adds a custom compendium with a
macro for the tinkerer, and a dynamic token border
to track player turn status.

It has a couple of known major bugs but is needed for
an upcoming game, with fixes hopefully later.

It is only compatible with Foundry v12 at this time.

README.md

@@ -0,0 +1,73 @@
+# The Mill's Fabula - v0.1.0
+
+This little [FoundryVTT](https://foundryvtt.com/) module is a collection of compendiums and functionalities
+to power our Fabula Ultima campaigns.
+
+# Compatibility
+
+This is *only* compatible with Foundry v12 currently.
+
+# Installation
+
+Currently, this can only be installed via manifest file, using the following URL :
+```
+https://git.tfk-astrodome.net/trotFunky/TheMillsFabula/raw/branch/release/module.json
+```
+
+# Features
+
+This module is an aggregate of different things that are useful for us or that the GM wanted
+to play with, so they don't necessarily connect with each other.
+
+They are described below in their own secions.
+
+## Combat border
+
+This part of the module adds a dynamic border around player tokens, which changes during combat.
+
+The border is always visible, but after a player has taken their turn it will switch to a different border,
+highlighting the tokens that have played for this combat turn.
+
+The module supports going back and forth in the combat rounds, as well as going back in the turn order.
+(Though because of limitations of the Fabula Ultima system, does not allow going *forward* in the turn order.)
+
+## Settings
+
+- An image to use for the default/idle border
+- An image to use for the took turn/played/inactive border
+
+## Limitations
+
+There are currently two main issues that need to be fixed :
+1. The tokens will not be updated when the GM is not on the scene.
+   - Indeed, the Fabula Ultima system seems to prevent players from receiving combat events,
+     so the GM is the only one that can receive them and update the tokens. That means they need to be in the active
+     combat scene for the changes to take effect.
+   - However, given that the module only uses the current state, if the GM comes back to the scene and a combat event is
+     triggered, the token borders will become correct.
+2. The token borders will be incorrect when switching to a new scene
+   - It is unclear why, but apparently switching to another scene is very different from loading a new scene,
+     and the combat encounter of the scene is not available when tokens are created. This means that the combat status,
+     and thus the border type, cannot be properly determined on scene switch.
+   - This can be fixed by receiving a combat update, either from the players or the GM, on the scene.
+
+# Compendia
+
+- The only thing in the compendium pack is a macro automating the tinkerer's alchemy potions,
+  allowing to choose how many PIs to spend, how to allocate the results, previews and a final chat message
+  with the results.
+
+# Dependencies
+
+Modules:
+ - socketlib
+
+System:
+ - Fabula Ultima
+
+# License
+
+The code present in this repository is licensed under the Mozilla Public License 2.0.
+
+Assets that we created in this repository are licensed under
+[CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), unless otherwise specified.