MCprep 3.5 Rewritten Core

.gitignore

@@ -10,3 +10,4 @@ test_results.tsv
 debug_save_state.blend1
 MCprep_addon/MCprep_resources/resourcepacks/mcprep_default/materials.blend1
 mcprep_venv_*
+.cache

CONTRIBUTING.md

@@ -211,6 +211,23 @@ If you're using an IDE, it's recommened to install `bpy` as a Python module. In
 
 It's also recommened to use a virtual environment (especially if you're on Linux) as to avoid issues with system wide packages and different versions of `bpy`. [See this for more details](https://realpython.com/python-virtual-environments-a-primer/)
 
+There are 2 methods to do this:
+- Poetry
+- Manualy
+
+Both are listed here.
+
+### With Poetry
+[Poetry](https://python-poetry.org/) is a useful tool that allows easy dependency handling. To quote the website:
+
+>  Python packaging and dependency management made easy 
+
+If you decide to use Poetry, then simply run the following command:
+
+`poetry install`
+
+To enable the virtual environment, run `poetry shell`, then type `exit` when you're done.
+
 ### Creating a Virtual Environment and Setting up `bpy`
 First, we need to come up with a name. For MCprep development, it's recommended to use the following convention:
 `mcprep_venv_<version>`

MCprep_addon/__init__.py

@@ -60,7 +60,6 @@
 
 import bpy
 
-
 def register():
 	load_modules.register(bl_info)
 

MCprep_addon/addon_updater_ops.py

@@ -81,7 +81,11 @@ def check_for_update(self, now):
 # Blender version utils
 # -----------------------------------------------------------------------------
 def make_annotations(cls):
-	"""Add annotation attribute to fields to avoid Blender 2.8+ warnings"""
+	"""Add annotation attribute to fields to avoid Blender 2.8+ warnings.
+
+	Deprecated operator as MCprep 3.5 moves to support 2.8+ only and using
+	native python annotations.
+	"""
 	if not hasattr(bpy.app, "version") or bpy.app.version < (2, 80):
 		return cls
 	if bpy.app.version < (2, 93, 0):
@@ -1357,7 +1361,7 @@ def select_link_function(self, tag):
 def register(bl_info):
 	"""Registering the operators in this module"""
 	from . import conf
-	updater.verbose = conf.v
+	updater.verbose = conf.env.verbose
 
 	# safer failure in case of issue loading module
 	if updater.error != None:

MCprep_addon/conf.py

@@ -17,7 +17,7 @@
 # ##### END GPL LICENSE BLOCK #####
 
 import os
-
+from pathlib import Path
 import bpy
 
 # check if custom preview icons available
@@ -32,18 +32,152 @@
 # -----------------------------------------------------------------------------
 
 
+class MCprepEnv:
+	def __init__(self):
+		self.data = None
+		self.json_data = None
+		self.json_path: Path = Path(os.path.dirname(__file__), "MCprep_resources", "mcprep_data.json")
+		self.json_path_update: Path = Path(os.path.dirname(__file__), "MCprep_resources", "mcprep_data_update.json")
+
+		self.dev_file: Path = Path(os.path.dirname(__file__), "mcprep_dev.txt")
+
+		# if new update file found from install, replace old one with new
+		if self.json_path_update.exists():
+			self.json_path_update.replace(self.json_path)
+
+		self.last_check_for_updated = 0
+
+		# Check to see if there's a text file for a dev build. If so,
+		if self.dev_file.exists():
+			self.dev_build = True
+			self.verbose = True
+			self.very_verbose = True
+			self.log("Dev Build!")
+
+		else:
+			self.dev_build = False
+			self.verbose = False
+			self.very_verbose = False
+
+		# lazy load json, ie only load it when needed (util function defined)
+
+		# -----------------------------------------------
+		# For preview icons
+		# -----------------------------------------------
+
+		self.use_icons: bool = True
+		self.preview_collections: dict = {}
+
+		# -----------------------------------------------
+		# For initializing the custom icons
+		# -----------------------------------------------
+		self.icons_init()
+
+		# -----------------------------------------------
+		# For cross-addon lists
+		# -----------------------------------------------
+
+		# To ensure shift-A starts drawing sub menus after pressing load all spawns
+		# as without this, if any one of the spawners loads nothing (invalid folder,
+		# no blend files etc), then it would continue to ask to reload spanwers.
+		self.loaded_all_spawners: bool = False
+
+		self.skin_list: list = []  # each is: [ basename, path ]
+		self.rig_categories: list = []  # simple list of directory names
+		self.entity_list: list = []
+
+		# -----------------------------------------------
+		# Matieral sync cahce, to avoid repeat lib reads
+		# -----------------------------------------------
+
+		# list of material names, each is a string. None by default to indicate
+		# that no reading has occurred. If lib not found, will update to [].
+		# If ever changing the resource pack, should also reset to None.
+		self.material_sync_cache = []
+
+	# -----------------------------------------------------------------------------
+	# ICONS INIT
+	# -----------------------------------------------------------------------------
+
+
+	def icons_init(self):
+		collection_sets = [
+			"main", "skins", "mobs", "entities", "blocks", "items", "effects", "materials"]
+
+		try:
+			for iconset in collection_sets:
+				self.preview_collections[iconset] = bpy.utils.previews.new()
+
+			script_path = bpy.path.abspath(os.path.dirname(__file__))
+			icons_dir = os.path.join(script_path, 'icons')
+			self.preview_collections["main"].load(
+				"crafting_icon",
+				os.path.join(icons_dir, "crafting_icon.png"),
+				'IMAGE')
+			self.preview_collections["main"].load(
+				"meshswap_icon",
+				os.path.join(icons_dir, "meshswap_icon.png"),
+				'IMAGE')
+			self.preview_collections["main"].load(
+				"spawner_icon",
+				os.path.join(icons_dir, "spawner_icon.png"),
+				'IMAGE')
+			self.preview_collections["main"].load(
+				"sword_icon",
+				os.path.join(icons_dir, "sword_icon.png"),
+				'IMAGE')
+			self.preview_collections["main"].load(
+				"effects_icon",
+				os.path.join(icons_dir, "effects_icon.png"),
+				'IMAGE')
+			self.preview_collections["main"].load(
+				"entity_icon",
+				os.path.join(icons_dir, "entity_icon.png"),
+				'IMAGE')
+			self.preview_collections["main"].load(
+				"model_icon",
+				os.path.join(icons_dir, "model_icon.png"),
+				'IMAGE')
+		except Exception as e:
+			self.log("Old verison of blender, no custom icons available")
+			self.log("\t" + str(e))
+			global use_icons
+			self.use_icons = False
+			for iconset in collection_sets:
+				self.preview_collections[iconset] = ""
+
+	def log(self, statement: str, vv_only: bool=False):
+		if self.verbose and vv_only and self.very_verbose:
+			print(statement)
+		elif self.verbose:
+			print(statement)
+
+	def deprecation_warning(self):
+		if self.dev_build:
+			import traceback
+			self.log("Deprecation Warning: This will be removed in MCprep 3.5.1!")
+			traceback.print_stack()
+
+
+env = MCprepEnv()
+
+
+# ! Deprecated as of MCprep 3.4.2
 def init():
-
+	env.deprecation_warning()
 	# -----------------------------------------------
-	# Verbose, use as conf.v
+	# Verbose, use as env.verbose
 	# Used to print out extra information, set false with distribution
 	# -----------------------------------------------
+	# ! Deprecated as of MCprep 3.4.2
 	global dev
 	dev = True
 
+	# ! Deprecated as of MCprep 3.4.2
 	global v
 	v = True  # $VERBOSE, UI setting
 
+	# ! Deprecated as of MCprep 3.4.2
 	global vv
 	vv = dev  # $VERYVERBOSE
 
@@ -53,13 +187,16 @@ def init():
 
 	# shouldn't load here, just globalize any json data?
 
+	# ! Deprecated as of MCprep 3.4.2
 	global data
 	# import json
 
+	# ! Deprecated as of MCprep 3.4.2
 	global json_data  # mcprep_data.json
 	json_data = None  # later will load addon information etc
 
 	# if existing json_data_update exists, overwrite it
+	# ! Deprecated as of MCprep 3.4.2
 	global json_path
 	json_path = os.path.join(
 		os.path.dirname(__file__),
@@ -87,8 +224,10 @@ def init():
 	# For preview icons
 	# -----------------------------------------------
 
+	# ! Deprecated as of MCprep 3.4.2
 	global use_icons
 	use_icons = True
+	# ! Deprecated as of MCprep 3.4.2
 	global preview_collections
 	preview_collections = {}
 
@@ -104,15 +243,19 @@ def init():
 	# To ensure shift-A starts drawing sub menus after pressing load all spawns
 	# as without this, if any one of the spawners loads nothing (invalid folder,
 	# no blend files etc), then it would continue to ask to reload spanwers.
+	# ! Deprecated as of MCprep 3.4.2
 	global loaded_all_spawners
 	loaded_all_spawners = False
 
+	# ! Deprecated as of MCprep 3.4.2
 	global skin_list
 	skin_list = []  # each is: [ basename, path ]
 
+	# ! Deprecated as of MCprep 3.4.2
 	global rig_categories
 	rig_categories = []  # simple list of directory names
 
+	# ! Deprecated as of MCprep 3.4.2
 	global entity_list
 	entity_list = []
 
@@ -123,16 +266,18 @@ def init():
 	# list of material names, each is a string. None by default to indicate
 	# that no reading has occurred. If lib not found, will update to [].
 	# If ever changing the resource pack, should also reset to None.
+	# ! Deprecated as of MCprep 3.4.2
 	global material_sync_cache
 	material_sync_cache = None
 
 
+# ! Deprecated as of MCprep 3.4.2
 # -----------------------------------------------------------------------------
 # ICONS INIT
 # -----------------------------------------------------------------------------
 
-
 def icons_init():
+	env.deprecation_warning()
 	# start with custom icons
 	# put into a try statement in case older blender version!
 	global preview_collections
@@ -184,13 +329,12 @@ def icons_init():
 			preview_collections[iconset] = ""
 
 
+# ! Deprecated as of MCprep 3.4.2
 def log(statement, vv_only=False):
-	"""General purpose simple logging function."""
-	global v
-	global vv
-	if v and vv_only and vv:
+	env.deprecation_warning()
+	if env.verbose and vv_only and env.very_verbose:
 		print(statement)
-	elif v:
+	elif env.verbose:
 		print(statement)
 
 
@@ -211,29 +355,24 @@ def updater_select_link_function(self, tag):
 # GLOBAL REGISTRATOR INIT
 # -----------------------------------------------------------------------------
 
-
+# ! Deprecated as of MCprep 3.4.2
 def register():
+	env.deprecation_warning()
 	init()
 
 
 def unregister():
-	global preview_collections
-	if use_icons:
-		for pcoll in preview_collections.values():
+	if env.use_icons:
+		for pcoll in env.preview_collections.values():
 			try:
 				bpy.utils.previews.remove(pcoll)
 			except:
-				log('Issue clearing preview set ' + str(pcoll))
-	preview_collections.clear()
+				env.log('Issue clearing preview set ' + str(pcoll))
+	env.preview_collections.clear()
 
-	global json_data
-	json_data = None  # actively clearing out json data for next open
+	env.json_data = None  # actively clearing out json data for next open
 
-	global loaded_all_spawners
-	loaded_all_spawners = False
-	global skin_list
-	skin_list = []
-	global rig_categories
-	rig_categories = []
-	global material_sync_cache
-	material_sync_cache = []
+	env.loaded_all_spawners = False
+	env.skin_list = []
+	env.rig_categories = []
+	env.material_sync_cache = []