features/patch 3 (#3)

* Refactor example, add more documentation to readme

* Update after opening in engine

* Dont need default_env

* Remove unused section

* Add list with quest names

* Good enough basic example

Author: brandonlamb

.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 .#*
 *~
+example/addons

.import/icon.png-06cf5771c30c99cd87c6045d4f87f250.stex

@@ -1,2 +1,36 @@
 # godot-quest-system
 Godot Engine (v3.0) Quest System
+
+## Running the example
+
+Copy addons folder to example folder, then open the example folder in Godot. The example folder acts as the base project folder.
+
+## Design considerations
+
+I am attempting to apply Domain-Driven Design principles, with repositories acting as adapters to various underlying infrastructure concerns (database, file, api).
+
+## Persistence implementations
+
+This is probably the biggest problem to solve, how to persist the data. I haven't read up yet on JSON and file read/write in Godot.
+
+If implementing a file-based quest_repository, I suspect you would read in the file, then loop over each line and use it to create a quest.
+
+This could also be implemented via a REST API probably using the HTTP functions.
+
+### Status of SQLite
+
+Broken. When I first started to dive into this, I had no clue what I was doing and was basing the work off of another project.
+
+I think what needs to happen is you would need to bind to a sqlite library via cpp, and then compile a dynamic library for Windows, Linux, and Mac.
+
+### File-based
+
+For a local game, you might implement a file repository. This could be a file-per-quest that you open and read, and maybe an index file to lookup.
+
+### REST-based
+
+Exposing an API, you could have a network/internet/API implementation to find and read quests.
+
+### RDBM-based
+
+It's possible that you could create bindings for Godot server to communicate with an actual RDBM server (mysql, pgsql).

README.md

@@ -4,6 +4,10 @@ importer="texture"
 type="StreamTexture"
 path="res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex"
 
+[deps]
+
+source_md5="c3558f79862e8e00c74fb188280dd8ef"
+
 [params]
 
 compress/mode=0
@@ -21,3 +25,4 @@ process/HDR_as_SRGB=false
 stream=false
 size_limit=0
 detect_3d=true
+svg/scale=1.0

icon.png renamed to addons/godot-quest-system/icon.png

@@ -1,18 +1,20 @@
-extends Node2D
+extends Node
 
-const Quest = preload("res://addons/com.brandonlamb.quest/domain/quest.gd")
-const QuestRepo = preload("res://addons/com.brandonlamb.quest/memory/quest_repository.gd")
-const QuestFactory = preload("res://addons/com.brandonlamb.quest/memory/quest_factory.gd")
+const Quest = preload("res://addons/godot-quest-system/domain/quest.gd")
+const QuestRepo = preload("res://addons/godot-quest-system/memory/quest_repository.gd")
+const QuestFactory = preload("res://addons/godot-quest-system/memory/quest_factory.gd")
+
+var quest_repo
 
 func _ready():
-	var questRepo = QuestRepo.new(QuestFactory.create_from_static())
-	var quests = questRepo.find_all()
+	quest_repo = QuestRepo.new(QuestFactory.create_from_static())
+	var quests = quest_repo.find_all()
 
 	for i in quests:
 		i.connect("started", self, "_on_quest_started")
 		i.start()
 
-	var quest = questRepo.find_by_id(1)
+	var quest = quest_repo.find_by_id(1)
 	quest.status = "finished"
 	print(quest.to_string())
 	print("quest.to_string()=", quest.to_string())
@@ -21,6 +23,11 @@ func _ready():
 
 	for i in quests:
 		print(i.to_string())
+		$ui/quests.add_item(i.name)
 
 func _on_quest_started(e):
 	print("_on_quest_started: ", e.name)
+
+func _on_quests_item_selected( index ):
+	var quests = quest_repo.find_all()
+	$ui/quest_info.text = str("Quest: ", quests[index].description)

default_env.tres

@@ -1,9 +1,56 @@
 [gd_scene load_steps=2 format=2]
 
-[ext_resource path="res://example/main.gd" type="Script" id=1]
+[ext_resource path="res://main.gd" type="Script" id=1]
 
-[node name="main" type="Node2D"]
+[node name="main" type="Node"]
 
 script = ExtResource( 1 )
 
+[node name="ui" type="CanvasLayer" parent="."]
+
+layer = 1
+offset = Vector2( 0, 0 )
+rotation = 0.0
+scale = Vector2( 1, 1 )
+
+[node name="quests" type="ItemList" parent="ui"]
+
+anchor_left = 0.5
+anchor_top = 0.0
+anchor_right = 0.5
+anchor_bottom = 0.0
+margin_left = -150.0
+margin_top = 50.0
+margin_right = 150.0
+margin_bottom = 150.0
+rect_pivot_offset = Vector2( 0, 0 )
+mouse_filter = 0
+size_flags_horizontal = 1
+size_flags_vertical = 1
+items = [  ]
+select_mode = 0
+max_text_lines = 5
+auto_height = true
+icon_mode = 1
+
+[node name="quest_info" type="Label" parent="ui"]
+
+anchor_left = 0.5
+anchor_top = 1.0
+anchor_right = 0.5
+anchor_bottom = 1.0
+margin_left = -150.0
+margin_top = -500.0
+margin_right = 150.0
+rect_pivot_offset = Vector2( 0, 0 )
+rect_clip_content = false
+mouse_filter = 2
+size_flags_horizontal = 1
+size_flags_vertical = 4
+percent_visible = 1.0
+lines_skipped = 0
+max_lines_visible = -1
+
+[connection signal="item_selected" from="ui/quests" to="." method="_on_quests_item_selected"]
+
 

example/.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex

@@ -0,0 +1,25 @@
+; Engine configuration file.
+; It's best edited using the editor UI and not directly,
+; since the parameters that go here are not all obvious.
+;
+; Format:
+;   [section] ; section goes between []
+;   param=value ; assign values to parameters
+
+config_version=3
+
+[application]
+
+config/name="godot-quest-system"
+run/main_scene="res://main.tscn"
+config/icon="res://icon.png"
+
+[display]
+
+window/size/width=360
+window/size/height=720
+window/size/resizable=false
+
+[gdnative]
+
+singletons=[  ]