Split node scripts into subfolders and use subfolder names as category names (#48)

fixes #41

Reviewed-on: https://codeberg.org/StreamGraph/StreamGraph/pulls/48
Co-authored-by: Lera Elvoé <yagich@poto.cafe>
Co-committed-by: Lera Elvoé <yagich@poto.cafe>

classes/deck/deck_node.gd

@@ -31,9 +31,6 @@ var node_type: String
 var description: String
 ## A list of aliases for this node, used by search.
 var aliases: Array[String]
-## The category of this node. Must be snake_case. This is additional data which
-## a renderer can optionally show to the user.
-var category: String
 ## Controls whether this node should appear in [SearchProvider].
 var appears_in_search: bool = true
 

classes/deck/node_db.gd

@@ -28,31 +28,38 @@ func _init() -> void:
 	#if load_node_index():
 		#return
 
-	var dir := DirAccess.open(BASE_NODE_PATH)
+	create_descriptors(BASE_NODE_PATH)
+
+	save_node_index()
+
+
+func create_descriptors(path: String) -> void:
+	var dir := DirAccess.open(path)
 	dir.list_dir_begin()
 	var current_file := dir.get_next()
 	while current_file != "":
-		#print(current_file)
+		if dir.current_is_dir():
-		if current_file.ends_with(".gd"):
+			create_descriptors(path.path_join(current_file))
-			var script_path := BASE_NODE_PATH.path_join(current_file)
+		else:
-			var node: DeckNode = load(script_path).new() as DeckNode
+			if current_file.ends_with(".gd"):
-			var aliases: String = node.aliases.reduce(
+				var script_path := path.path_join(current_file)
-				func(accum, el) -> void:
+				var node: DeckNode = load(script_path).new() as DeckNode
-					accum += el
+				var aliases: String = node.aliases.reduce(
-			, "")
+					func(accum, el) -> void:
-			var descriptor := NodeDescriptor.new(
+						accum += el
-				script_path,
+				, "")
-				node.name,
+				var descriptor := NodeDescriptor.new(
-				node.node_type,
+					script_path,
-				node.description,
+					node.name,
-				aliases,
+					node.node_type,
-				node.category,
+					node.description,
-				node.appears_in_search,
+					aliases,
-				)
+					path.get_slice("/", path.get_slice_count("/") - 1),
-			nodes[node.node_type] = descriptor
+					node.appears_in_search,
+					)
+				nodes[node.node_type] = descriptor
 		current_file = dir.get_next()
 
-	save_node_index()
 
 ## Helper Function that instances a [DeckNode] based off of it's [member DeckNode.node_type]
 func instance_node(type: String) -> DeckNode:

classes/deck/nodes/general/array_get_index.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Get Array Index"
 	node_type = "array_get_index"
 	description = "Returns an element from an array. 0-indexed."
-	category = "general"
 
 	add_input_port(
 		DeckType.Types.ARRAY,

classes/deck/nodes/general/bool_constant.gd

@@ -7,7 +7,6 @@ extends DeckNode
 func _init() -> void:
 	name = "Bool Constant"
 	node_type = name.to_snake_case()
-	category = "general"
 	description = "A checkbox."
 
 	add_output_port(

classes/deck/nodes/general/button.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Button"
 	node_type = "button"
 	description = "A button to trigger certain nodes that have a trigger input."
-	category = "general"
 
 	add_output_port(
 		DeckType.Types.BOOL,

classes/deck/nodes/general/delay.gd

@@ -9,7 +9,6 @@ func _init():
 	name = "Delay"
 	node_type = name.to_snake_case()
 	description = "A node that passes through its' input after the set time."
-	category = "general"
 
 	add_output_port(DeckType.Types.ANY, "Value")
 

classes/deck/nodes/general/dictionary_get_key.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Get Dictionary Key"
 	node_type = "dictionary_get_key"
 	description = "Returns the value of a key from a dictionary input, if it exists, or null otherwise."
-	category = "general"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/general/expression_node.gd

@@ -9,7 +9,6 @@ func _init():
 	name = "Expression"
 	node_type = name.to_snake_case()
 	description = "A node returning the result of a mathematical expression."
-	category = "general"
 
 	props_to_serialize = []
 

classes/deck/nodes/general/get_deck_var.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Get Deck Var"
 	node_type = name.to_snake_case()
 	description = "Retrieve a deck variable."
-	category = "general"
 
 	add_output_port(
 		DeckType.Types.ANY,

classes/deck/nodes/general/if_true.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Pass If True"
 	node_type = "if_true"
 	description = "Pass input if and only if the condition input is true."
-	category = "general"
 
 	add_input_port(
 		DeckType.Types.BOOL,

classes/deck/nodes/general/is_equal.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Compare Values"
 	node_type = "is_equal"
 	description = "Returns true if the values are equal, false otherwise."
-	category = "general"
 
 	add_input_port(
 		DeckType.Types.ANY,

classes/deck/nodes/general/print.gd

@@ -12,7 +12,6 @@ func _init() -> void:
 	description = "Print a value to the console."
 
 	props_to_serialize = [&"times_activated"]
-	category = "general"
 
 	add_input_port(
 		DeckType.Types.ANY,

classes/deck/nodes/general/process_node.gd

@@ -10,7 +10,6 @@ func _init() -> void:
 	name = "Process Loop"
 	node_type = name.to_snake_case()
 	description = "Sends a trigger output every frame, and returns the delta value (time since last frame in seconds)."
-	category = "general"
 
 	add_input_port(
 		DeckType.Types.BOOL,

classes/deck/nodes/general/set_deck_var.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Set Deck Var"
 	node_type = name.to_snake_case()
 	description = "Set a deck variable on trigger."
-	category = "general"
 
 	add_input_port(
 		DeckType.Types.STRING,

classes/deck/nodes/general/string_constant.gd

@@ -7,7 +7,6 @@ extends DeckNode
 func _init() -> void:
 	node_type = "string_constant"
 	name = "String Constant"
-	category = "general"
 	description = "A String field."
 
 	add_output_port(

classes/deck/nodes/general/string_split.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Split String"
 	node_type = "string_split"
 	description = "Splits a string by a delimiter."
-	category = "general"
 
 	add_input_port(
 		DeckType.Types.STRING,

classes/deck/nodes/math/vector_add.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Add Vectors"
 	node_type = "vector_add"
 	description = "Adds two 2D vectors."
-	category = "math"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/math/vector_compose.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Compose Vector"
 	node_type = "vector_compose"
 	description = "Returns a vector from two numeric inputs."
-	category = "math"
 
 	add_input_port(
 		DeckType.Types.NUMERIC,

classes/deck/nodes/math/vector_decompose.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Decompose Vector"
 	node_type = "vector_decompose"
 	description = "Returns the X and Y components of a vector."
-	category = "math"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/math/vector_dot.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Vector Dot Product"
 	node_type = "vector_dot"
 	description = "Returns the dot product of two vectors."
-	category = "math"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/math/vector_multiply.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Multiply Vector by Scalar"
 	node_type = "vector_multiply"
 	description = "Multiplies a vector by a numeric value."
-	category = "math"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/math/vector_normalize.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Normalize Vector"
 	node_type = "vector_normalize"
 	description = "Normalizes a vector so its' length (magnitude) is exactly 1."
-	category = "math"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/math/vector_subtract.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Subtract Vectors"
 	node_type = "vector_subtract"
 	description = "Subtracts each component of the given vectors."
-	category = "math"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/obs/obs_decompose_transform.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Decompose OBS Transform"
 	node_type = "obs_decompose_transform"
 	description = "Splits an OBS transform from one object into multiple outputs."
-	category = "obs"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/obs/obs_scene_list.gd

@@ -10,7 +10,6 @@ func _init() -> void:
 	name = "Scene Selector"
 	node_type = "obs_scene_list"
 	description = ""
-	category = "obs"
 
 	props_to_serialize = []
 

classes/deck/nodes/obs/obs_search_source.gd

@@ -14,7 +14,6 @@ func _init() -> void:
 	name = "Get Source ID"
 	node_type = "obs_search_source"
 	description = "Searches for an OBS source in a scene and returns its output."
-	category = "obs"
 
 	add_input_port(
 		DeckType.Types.STRING,

classes/deck/nodes/obs/obs_set_source_transform.gd

@@ -19,7 +19,6 @@ func _init() -> void:
 	name = "Set Source Transform"
 	node_type = "obs_set_source_transform"
 	description = "Sets an OBS source's transform, which includes position and rotation, among other things."
-	category = "obs"
 
 	props_to_serialize = []
 

classes/deck/nodes/obs/obs_switch_scene.gd

@@ -9,7 +9,6 @@ func _init() -> void:
 	name = "Set Scene"
 	node_type = "obs_set_scene"
 	description = "Sets the current scene in OBS."
-	category = "obs"
 
 	props_to_serialize = []
 

classes/deck/nodes/obs/obs_vector_to_position.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Vector to OBS Position"
 	node_type = "obs_vector_to_position"
 	description = "Transforms a Vector into a position vector accepted by OBS transform inputs."
-	category = "obs"
 
 	add_input_port(
 		DeckType.Types.DICTIONARY,

classes/deck/nodes/obs/obs_websocket_generic_request.gd

@@ -10,7 +10,6 @@ func _init() -> void:
 	name = "OBS WS Generic Request"
 	node_type = "obs_generic_request"
 	description = "Makes an OBS request and sends its result through. Use if if you really know what you're doing."
-	category = "obs"
 
 	props_to_serialize = []
 

classes/deck/nodes/test/test_interleaved_node.gd

@@ -7,7 +7,6 @@ extends DeckNode
 func _init() -> void:
 	node_type = "test_interleaved"
 	name = "Test Interleaved"
-	category = "test"
 
 	for i in 4:
 		add_output_port(

classes/deck/nodes/test/test_types.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = "Types Test"
 	node_type = name.to_snake_case()
 	description = ""
-	category = "test"
 
 	props_to_serialize = []
 

classes/deck/nodes/twitch/twitch_chat_received.gd

@@ -13,7 +13,6 @@ func _init():
 	name = "Twitch Chat Received"
 	node_type = "twitch_chat_received"
 	description = "Receives Twitch chat events from a Twitch connection."
-	category = "twitch"
 
 	add_output_port(DeckType.Types.STRING, "Username")
 	add_output_port(DeckType.Types.STRING, "Message")

classes/deck/nodes/twitch/twitch_send_chat.gd

@@ -8,7 +8,6 @@ func _init():
 	name = "Twitch Send Chat"
 	node_type = "twitch_send_chat"
 	description = "Sends a message to a Twitch chat."
-	category = "twitch"
 	
 	add_input_port(
 		DeckType.Types.STRING, 

script_templates/DeckNode/node_template.gd

@@ -8,7 +8,6 @@ func _init() -> void:
 	name = ""
 	node_type = name.to_snake_case()
 	description = ""
-	category = ""
 
 	props_to_serialize = []