refactoring and init.py

mfg_package/modules/_template/constants.py

@@ -0,0 +1,11 @@
+TEMPLATE        = '#'                   # TEMPLATE _identifier. Define your own!
+
+# Movements
+NORTH           = 'north'
+EAST            = 'east'
+SOUTH           = 'south'
+WEST            = 'west'
+NORTHEAST       = 'north_east'
+SOUTHEAST       = 'south_east'
+SOUTHWEST       = 'south_west'
+NORTHWEST       = 'north_west'

mfg_package/modules/_template/rules.py

@@ -0,0 +1,24 @@
+from typing import List
+from mfg_package.environment.rules import Rule
+from mfg_package.utils.results import TickResult, DoneResult
+
+
+class TemplateRule(Rule):
+
+    def __init__(self, *args, **kwargs):
+        super(TemplateRule, self).__init__(*args, **kwargs)
+
+    def on_init(self, state):
+        pass
+
+    def tick_pre_step(self, state) -> List[TickResult]:
+        pass
+
+    def tick_step(self, state) -> List[TickResult]:
+        pass
+
+    def tick_post_step(self, state) -> List[TickResult]:
+        pass
+
+    def on_check_done(self, state) -> List[DoneResult]:
+        pass