crystal-bit / godot-game-template Goto Github PK

# Normalize EOL for all files that Git considers text files.
* text=auto eol=lf

See:

• https://github.com/godotengine/godot-demo-projects/blob/master/.gitattributes
• https://rehansaeed.com/gitattributes-best-practices/

Invalid set index 'initial_fade_active' (on base: 'Node (main.gd)') with value of type 'bool'.

See 26b097d

This behaviour could be annoying for many people that rely on default Node events.

Class "Main" and "Game" couldn't be fully loaded.

After I've created a repo from this template, the Build Action for Web is failing with error:

remote: Permission to jayypluss/BreezyWave.git denied to github-actions[bot].
fatal: unable to access 'https://github.com/jayypluss/BreezyWave.git/': The requested URL returned error: 403

Is there any action needed for this build action to work?

Link for the failing build line:
https://github.com/jayypluss/BreezyWave/runs/6251779089?check_suite_focus=true#step:9:99

Thanks!

The Bug:

Even when the scene transitions completes, the Transitions scene remains in the tree, but it is invisible (since ColorRect is animated to be alpha=0).

However, it still blocks _input events.
ie. if there is a button where the progress bar is located, it is impossible to click the button (or hover it), even when the progress bar is invisible.

The fix is simple, and I think as a bonus side affect it will probably (very slightly) improve performance (perhaps avoiding some needless process() and rendering of transparent textures).

The Fix:

Simply hide the ColorRect when its not needed:

transitions.gd (modified lines highlighted with <<<<<<<, unchanged functions omitted for brevity)

onready var background = $ColorRect

func _ready():
	background.hide()      # <<<<<<<

# Tells if transition is currently displayed
func is_displayed() -> bool:
        return background.visible          # <<<<<<<<
        #
        # I don't think these two lines are necessary, but maybe I'm missing something?
	# var is_screen_black = background.modulate.a == 1
	# return anim.is_playing() or is_screen_black


# appear
func fade_in(params = {}):
	background.show()  # <<<<<<<<
	progress.hide()
	if params and params.get('show_progress_bar') != null:
		if params.get('show_progress_bar') == true:
			progress.show()
	anim.play("transition-in")


func _on_fade_out_finished(cur_anim):
	if cur_anim == "transition-out":
		progress.bar.value = 0
	background.hide()         # <<<<<<<<<

# rest of file is unchanged

I plan to support Godot 4.0 when it will be released.

There will be many changes, these things need to be kept in mind:

• Removed ResourceInteractiveLoader, add built-in threaded loading

• create separate repositories for each ggt-* addon
• move the code to the new repositories
• publish the addon to the Asset Library
• remove the addons from this template and add them via the asset library

Add signals:

• fade in started
• fade_out_started
• fade_in_ended
• fade_out_endend

https://docs.godotengine.org/en/stable/tutorials/io/background_loading.html

https://itch.io/docs/butler/

Issue: a new scene can start before old nodes to be completely removed.

I noticed this reloading a scene which had get_tree().get_nodes_in_group("example_group") on ready: I was expecting 3 nodes, but I got 6. This happened because old nodes were not completely removed on reload.

Would it be possible to port the template in godot 4? I use godot 4 and i'd like to be able to use the template too!

https://github.com/bitwes/Gut

Hi, I recently started using your game template. Frickin' awesome, btw. But I ran into this error, and it appears to be unrelated to my own code.

Any insight would be appreciated! Thanks again for the brilliant framework!

Right now the multithread Scene manager waits for the graphic transition end before starting loading the new resources, wasting time. This can be improved to have faster loading times.

https://github.com/crystal-bit/godot-game-template/blob/main/autoload/scenes.gd#L156

Idea:
After pre_start, but before start the scene can add more "in-scene" stages to the progress-bar.

I think the pre_start function can be used for this, and maybe using yield to advance the progress bar (coroutines style) or by emitting signals.

I guess that in order to have proper progress-bar the number of "in-scene" stages need to be known before the scene is loaded, which is tricky, a simple solution is to pass it in the params, but I hope there is a more elegant solution.

Example use case:
The gameplay.tscn scene generates procedural level in the pre_start func

func start_button_pressed():
     Game.change_scene("res://gameplay.tscn",  
                                          { "show_progress_bar": true, 
                                             "in_scene_stages": 5    # tell the progess bar to reserve 5 extra stages
                                           })

# in gameplay.gd
func pre_start(params):
    generate_maze()
    yield()   # advance stage...  or use signal and wait for idle frame?
    generate_tiles()
    yield()
    generate_treasure()
    yield()
    generate_monsters()
    yield()
    generate_doors()


func start():
    play_start_game_sound()

I think it would be useful to have the current version of the project shown on the bottom-left of the main scene. If people experience a bug with the template or a game made with it, they could immediately check which version is running, and it would be easy for non-developers as well.

• Update GitHub workflows
  • godot-ci was updated to 3.4 => Win, Linux, OSX exports are available
  • myood/godot-ci-android-export still wasn't updated to 3.4
  • Update dispatch-export.yml
• Set GLES3 renderer as default
• Update README

Use cases:

• saving config file
• saving game data (last player location, high score, save slot,...)

See 9aa7076

Add an option to Project Settings

• Update Readme
• How to change scene (multithread, single thread, ...)
• How to change scene and pass parameters
• How to play a specific scene
• How to restart the current scene (with no params and with latest params)
• FAQ/common errors: get_tree().get_node().add_child(new_scene)
• Godot API Incompatibilities (reload_current_scene(), goto_scene(), ...)
• How to disable CI and why
• How to contribute (main branch, feature branch, PR, changelog)

Currently there is no way to pause the game when playing from a mobile device (native app, or HTML5 from a mobile device).

• Test project with Godot 3.3
• Update Godot-CI (aBarichello)
• Check godot-multi-builder (probably won't work with Godot 3.3 for Android export)

UPDATE: Android build actually works, but it's using an outdated Godot version

From Godot Third Person Shooter demo:

	if ResourceLoader.has_cached(path):
		emit_signal("replace_main_scene", ResourceLoader.load(path))
	else:
		res_loader = ResourceLoader.load_interactive(path)
		loading_thread = Thread.new()
		#warning-ignore:return_value_discarded
		loading_thread.start(self, "interactive_load", res_loader)

As reported in #54 (comment), users can't pause the game in _ready().

This behaviour is probably a bug due to:

# main.gd
func _on_Scenes_change_finished():
	get_tree().paused = false

https://github.com/crystal-bit/godot-game-template/blob/main/scenes/main/main.gd#L100-L101

func reparent_node(node: Node2D, new_parent, update_transform = true):
	var previous_xform = node.global_transform
	node.get_parent().remove_child(node)
	new_parent.add_child(node)
	node.global_transform = previous_xform

This is not implemented in Godot because it's easy to do with GDScript.
However it seems like a handy feature to have in a game template (and also to avoid duplicating code).

Relevant Godot issues:

• godotengine/godot#8788
• godotengine/godot#4008

Godot 3.2.3 HTML5 export does not support threads; https://docs.godotengine.org/en/stable/getting_started/workflow/export/exporting_for_web.html#unimplemented-functionality

Godot 3.2.4 will have HTML5 export templates with support for threads: https://godotengine.org/article/dev-snapshot-godot-3-2-4-beta-4

TODO:

• Avoid using multithread loading for current HTML5 builds

After merging #37 I started wondering if a debug HUD may be useful for end users.

In https://github.com/crystal-bit/godot-game-template/tree/feature/version-scene there is a proof of concept: a Godot scene which is enabled globally and can be shown/hidden by pressing F1 at any moment (even during transitions).

Do you think having the godot-game-template should ship a debug HUD by default? Or should it be an add-on to install optionally?
Keep in mind that this debug HUD should work on PC, HTML5, Android and iOS. If this is hard to achieve, then I think it's better to create a separate add-on (which could be installed by other Godot-projects as well).

PS: for inspiration I suggest reading the Addons & Plugins wiki page and especially Shovel Knights debug features. If you know about similar resources, feel free to post them!

It needs to be optimized: the while loop can be removed

Fancy Fades has a bunch of scene change animations - see https://godotengine.org/asset-library/asset/741
It would be great to have it integrated with Godot Game Template