From 5f1e5efc10b554059a102237ed8d2e1b6e1bd3d3 Mon Sep 17 00:00:00 2001 From: David Luevano Alvarado Date: Fri, 10 Jun 2022 03:18:11 -0600 Subject: finish the go godot jam3 entry --- art/dst/rss.xml | 4 +- art/dst/sitemap.xml | 10 +- blog/dst/g/gogodot_jam3_devlog_1.html | 278 +++++++++++++- blog/dst/index.html | 2 +- blog/dst/rss.xml | 665 ++++++++++++++++++++++++++++++++-- blog/dst/sitemap.xml | 32 +- blog/dst/tag/@english.html | 2 +- blog/dst/tag/@gamedev.html | 2 +- blog/dst/tag/@gamejam.html | 2 +- blog/dst/tag/@godot.html | 2 +- blog/src/.files | 1 + blog/src/g/gogodot_jam3_devlog_1.md | 318 +++++++++++++++- 12 files changed, 1245 insertions(+), 73 deletions(-) diff --git a/art/dst/rss.xml b/art/dst/rss.xml index 54be3a6..dd3c19b 100644 --- a/art/dst/rss.xml +++ b/art/dst/rss.xml @@ -13,8 +13,8 @@ Copyright 2021 David Luévano Alvarado david@luevano.xyz (David Luévano Alvarado) david@luevano.xyz (David Luévano Alvarado) - Sun, 29 May 2022 03:44:42 GMT - Sun, 29 May 2022 03:44:42 GMT + Fri, 10 Jun 2022 09:17:48 GMT + Fri, 10 Jun 2022 09:17:48 GMT pyssg v0.7.2 https://validator.w3.org/feed/docs/rss2.html 30 diff --git a/art/dst/sitemap.xml b/art/dst/sitemap.xml index 93bc147..6675473 100644 --- a/art/dst/sitemap.xml +++ b/art/dst/sitemap.xml @@ -17,31 +17,31 @@ https://art.luevano.xyz/tag/@black-white.html - 2022-05-29 + 2022-06-10 daily 0.5 https://art.luevano.xyz/tag/@digital.html - 2022-05-29 + 2022-06-10 daily 0.5 https://art.luevano.xyz/tag/@drawing.html - 2022-05-29 + 2022-06-10 daily 0.5 https://art.luevano.xyz/tag/@sketch.html - 2022-05-29 + 2022-06-10 daily 0.5 https://art.luevano.xyz/tag/@spanish.html - 2022-05-29 + 2022-06-10 daily 0.5 diff --git a/blog/dst/g/gogodot_jam3_devlog_1.html b/blog/dst/g/gogodot_jam3_devlog_1.html index 05def8d..dc0a9e9 100644 --- a/blog/dst/g/gogodot_jam3_devlog_1.html +++ b/blog/dst/g/gogodot_jam3_devlog_1.html @@ -5,7 +5,7 @@ - Creating my Go Godot Jam 3 entry devlog 1 -- Luévano's Blog + Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1 -- Luévano's Blog @@ -31,7 +31,7 @@ - + @@ -78,10 +78,9 @@
-

Creating my Go Godot Jam 3 entry devlog 1

+

Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1

-

IF YOU’RE SEEING THIS, THIS IS A WIP

-

The jam’s theme is Evolution and all the details are listed here. This time I’m logging as I go, so there might be some changes to the script or scenes along the way I couldn’t actually do this, as I was running out of time.. Note that I’m not going to go into much details, the obvious will be ommitted.

+

The jam’s theme is Evolution and all the details are listed here. This time I’m logging as I go, so there might be some changes to the script or scenes along the way I couldn’t actually do this, as I was running out of time.. Note that I’m not going to go into much details, the obvious will be ommitted.

I wanted to do a Snake clone, and I’m using this jam as an excuse to do it and add something to it. The features include:

+

I created this game using Godot 3.5-rc3. You can find the source code in my GitHub here which at the time of writing this it doesn’t contain any exported files, for that you can go ahead and play it in your browser at itch.io, which you can find below:

+

+ +

You can also find the jam entry here.

+

Similarly with the my FlappyBird clone, I plan to update this to a better state.

Initial setup

Again, similar to the FlappyBird clone I developed, I’m using the directory structure I wrote about on Godot project structure with slight modifications to test things out. Also using similar Project settings as those from the FlappyBird clone like the pixel art texture imports, keybindings, layers, etc..

I’ve also setup GifMaker, with slight modifications as the AssetLib doesn’t install it correctly and contains unnecessry stuff: moved necessary files to the res://addons directory, deleted test scenes and files in general, and copied the license to the res://docs directory. Setting this up was a bit annoying because the tutorial it’s bad (with all due respect). I might do a separate entry just to explain how to set it up, because I couldn’t find it anywhere other than by inspecting some of the code/scenes.I ended up not leaving this enabled in the game as it lagged the game out, but it’s an option I’ll end up researching more.

@@ -401,13 +405,258 @@ func _ready(): return [world_generator.get_centered_world_position(location), location]

Other than that, there are some differences between placing normal and special food (specially the signal they send, and if an extra “special points” property is set). Some of the signals that I used that might be important: food_placing_new_food(type), food_placed_new_food(type, location) and food_eaten(type, location).

-

TODO

-

Add notes on:

- +

Stats clas and loading/saving data

+

I got the idea of saving the current stats (points, max body segments, etc.) in a separate Stats class for easier load/save data. This option I went with didn’t work as I would liked it to work, as it was a pain in the ass to setup and each time a new property is added you have to manually setup the load/save helper functions… so not the best option. This option I used was json but saving a Node directly could work better or using resources (saving tres files).

+

Stats class

+

The Stats “class” is just a script that extends from Node called stats.gd. It needs to define the class_name as Stats. The main content:

+
# main
+var points: int = 0
+var segments: int = 0
+
+# track of trait points
+var dash_points: int = 0
+var slow_points: int = 0
+var jump_points: int = 0
+
+# times trait achieved
+var dash_segments: int = 0
+var slow_segments: int = 0
+var jump_segments: int = 0
+
+# trait properties
+var dash_percentage: float = 0.0
+var slow_percentage: float = 0.0
+var jump_lenght: float = 0.0
+
+# trait active
+var trait_dash: bool = false
+var trait_slow: bool = false
+var trait_jump: bool = false
+
+

And with the ugliest functions:

+
func get_stats() -> Dictionary:
+    return {
+        "points": points,
+        "segments": segments,
+        "dash_points": dash_points,
+        "dash_segments": dash_segments,
+        "dash_percentage": dash_percentage,
+        "slow_points": slow_points,
+        "slow_segments": slow_segments,
+        "slow_percentage": slow_percentage,
+        "jump_points": jump_points,
+        "jump_segments": jump_segments,
+        "jump_lenght": jump_lenght,
+        "trait_dash": trait_dash,
+        "trait_slow": trait_slow,
+        "trait_jump": trait_jump
+    }
+
+
+func set_stats(stats: Dictionary) -> void:
+        points = stats["points"]
+        segments = stats["segments"]
+        dash_points = stats["dash_points"]
+        slow_points = stats["slow_points"]
+        jump_points = stats["jump_points"]
+        dash_segments = stats["dash_segments"]
+        slow_segments = stats["slow_segments"]
+        jump_segments = stats["jump_segments"]
+        dash_percentage = stats["dash_percentage"]
+        slow_percentage = stats["slow_percentage"]
+        jump_lenght = stats["jump_lenght"]
+        trait_dash = stats["trait_dash"]
+        trait_slow = stats["trait_slow"]
+        trait_jump = stats["trait_jump"]
+
+

And this is not scalable at all, but I had to do this at the end of the jam so no way of optimizing and/or doing it correctly, sadly.

+

Load/save data

+

The load/save function is pretty standard. It’s a singleton/autoload called SavedData with a script that extends from Node called save_data.gd:

+
const DATA_PATH: String = "user://data.save"
+
+var _stats: Stats
+
+
+func _ready() -> void:
+    _load_data()
+
+
+# called when setting "stats" and thus saving
+func save_data(stats: Stats) -> void:
+    _stats = stats
+    var file: File = File.new()
+    file.open(DATA_PATH, File.WRITE)
+    file.store_line(to_json(_stats.get_stats()))
+    file.close()
+
+
+func get_stats() -> Stats:
+    return _stats
+
+
+func _load_data() -> void:
+    # create an empty file if not present to avoid error while loading settings
+    _handle_new_file()
+
+    var file = File.new()
+    file.open(DATA_PATH, File.READ)
+    _stats = Stats.new()
+    _stats.set_stats(parse_json(file.get_line()))
+    file.close()
+
+
+func _handle_new_file() -> void:
+    var file: File = File.new()
+    if not file.file_exists(DATA_PATH):
+        file.open(DATA_PATH, File.WRITE)
+        _stats = Stats.new()
+        file.store_line(to_json(_stats.get_stats()))
+        file.close()
+
+

It uses json as the file format, but I might end up changing this in the future to something else more reliable and easier to use (Stats class related issues).

+

Scoring

+

For this I created a scoring mechanisms and just called it ScoreManager (score_manager.gd) which just basically listens to food_eaten signal and adds points accordingly to the current Stats object loaded. The main function is:

+
func _on_food_eaten(properties: Dictionary) -> void:
+    var is_special: bool = properties["special"]
+    var type: int = properties["type"]
+    var points: int = properties["points"]
+    var special_points: int = properties["special_points"]
+    var location: Vector2 = properties["global_position"]
+    var amount_to_grow: int
+    var special_amount_to_grow: int
+
+    amount_to_grow = _process_points(points)
+    _spawn_added_score_text(points, location)
+    _spawn_added_segment_text(amount_to_grow)
+
+    if is_special:
+        special_amount_to_grow = _process_special_points(special_points, type)
+        # _spawn_added_score_text(points, location)
+        _spawn_added_special_segment_text(special_amount_to_grow, type)
+        _check_if_unlocked(type)
+
+

Where the most important function is:

+
func _process_points(points: int) -> int:
+    var score_to_grow: int = (stats.segments + 1) * Global.POINTS_TO_GROW - stats.points
+    var amount_to_grow: int = 0
+    var growth_progress: int
+    stats.points += points
+    if points >= score_to_grow:
+        amount_to_grow += 1
+        points -= score_to_grow
+        # maybe be careful with this
+        amount_to_grow += points / Global.POINTS_TO_GROW
+        stats.segments += amount_to_grow
+        Event.emit_signal("snake_add_new_segment", amount_to_grow)
+
+    growth_progress = Global.POINTS_TO_GROW - ((stats.segments + 1) * Global.POINTS_TO_GROW - stats.points)
+    Event.emit_signal("snake_growth_progress", growth_progress)
+    return amount_to_grow
+
+

Which will add the necessary points to Stats.points and return the amount of new snake segments to grow. After this _spawn_added_score_segment and _spawn_added_segment_text just spawn a Label with the info on the points/segments gained; this is custom UI I created, nothing fancy.

+

Last thing is taht in _process_points there is a check at the end, where if the food eaten is “special” then a custom variation of the last 3 functions are executed. These are really similar, just specific to each kind of food.

+

This ScoreManager also handles the calculation for the game_over signal, to calculte progress, set necessary Stats values and save the data:

+
func _on_game_over() -> void:
+    var max_stats: Stats = _get_max_stats()
+    SaveData.save_data(max_stats)
+    Event.emit_signal("display_stats", initial_stats, stats, mutation_stats)
+
+
+func _get_max_stats() -> Stats:
+    var old_stats_dict: Dictionary = initial_stats.get_stats()
+    var new_stats_dict: Dictionary = stats.get_stats()
+    var max_stats: Stats = Stats.new()
+    var max_stats_dict: Dictionary = max_stats.get_stats()
+    var bool_stats: Array = [
+        "trait_dash",
+        "trait_slow",
+        "trait_jump"
+    ]
+
+    for i in old_stats_dict:
+        if bool_stats.has(i):
+            max_stats_dict[i] = old_stats_dict[i] or new_stats_dict[i]
+        else:
+            max_stats_dict[i] = max(old_stats_dict[i], new_stats_dict[i])
+    max_stats.set_stats(max_stats_dict)
+    return max_stats
+
+

Then this sends a signal display_stats to activate UI elements that shows the progression.

+

Naturally, the saved Stats are loaded whenever needed. For example, for the Snake, we load the stats and setup any value needed from there (like a flag to know if any ability is enabled), and since we’re saving the new Stats at the end, then on restart we load the updated one.

+

Snake redesigned with the state machine pattern

+

I redesigned the snake code (the head, actually) to use the state machine pattern by following this guide which is definitely a great guide, straight to the point and easy to implement.

+

Other than what is shown in the guide, I implemented some important functions in the state_machine.gd script itself, to be used by each of the states as needed:

+
func rotate_on_input() -> void:
+    if Input.is_action_pressed("move_left"):
+        player.rotate_to(player.LEFT)
+    if Input.is_action_pressed("move_right"):
+        player.rotate_to(player.RIGHT)
+
+
+func slow_down_on_collisions(speed_backup: float):
+    if player.get_last_slide_collision():
+        Global.SNAKE_SPEED = player.velocity.length()
+    else:
+        Global.SNAKE_SPEED = speed_backup
+
+
+func handle_slow_speeds() -> void:
+    if Global.SNAKE_SPEED <= Global.SNAKE_SPEED_BACKUP / 4.0:
+        Global.SNAKE_SPEED = Global.SNAKE_SPEED_BACKUP
+        Event.emit_signal("game_over")
+
+

And then in the StateMachine‘s _process:

+
func _physics_process(delta: float) -> void:
+    # state specific code, move_and_slide is called here
+    if state.has_method("physics_process"):
+        state.physics_process(delta)
+
+    handle_slow_speeds()
+    player.handle_time_elapsed(delta)
+
+

And now it’s just a matter of implementing the necessary states. I used 4: normal_stage.gd, slow_state.gd, dash_state.gd and jump_state.gd.

+

The normal_state.gd contains what the original head.gd code contained:

+
func physics_process(delta: float) -> void:
+    fsm.rotate_on_input()
+    fsm.player.velocity = fsm.player.direction * Global.SNAKE_SPEED
+    fsm.player.velocity = fsm.player.move_and_slide(fsm.player.velocity)
+
+    fsm.slow_down_on_collisions(Global.SNAKE_SPEED_BACKUP)
+
+
+func input(event: InputEvent) -> void:
+    if fsm.player.can_dash and event.is_action_pressed("dash"):
+        exit("DashState")
+    if fsm.player.can_slow and event.is_action_pressed("slow"):
+        exit("SlowState")
+    if fsm.player.can_jump and event.is_action_pressed("jump"):
+        exit("JumpState")
+
+

Here, the exit method is basically to change to the next state. And lastly, I’m only gonna show the dash_state.gd as the other ones are pretty similar:

+
func enter():
+    if fsm.DEBUG:
+        print("Got inside %s." % name)
+    Event.emit_signal("snake_started_dash")
+    Global.SNAKE_SPEED = Global.SNAKE_DASH_SPEED
+    yield(get_tree().create_timer(Global.SNAKE_DASH_TIME), "timeout")
+    exit()
+
+
+func exit():
+    Event.emit_signal("snake_finished_dash")
+    Global.SNAKE_SPEED = Global.SNAKE_SPEED_BACKUP
+    fsm.back()
+
+
+func physics_process(delta: float) -> void:
+    fsm.rotate_on_input()
+    fsm.player.velocity = fsm.player.direction * Global.SNAKE_SPEED
+    fsm.player.velocity = fsm.player.move_and_slide(fsm.player.velocity)
+
+    fsm.slow_down_on_collisions(Global.SNAKE_DASH_SPEED)
+
+

Where the important parts happen in the enter and exit functions. We need to change the Global.SNAKE_SPEED with the Global.SNAKE_DASH_SPEED on startand start the timer for how long should the dash last. And on the exit we reset the Global.SNAKE_SPEED back to normal. There is probably a better way of updating the Global.SNAKE_SPEED but this works just fine.

+

For the other ones is the same. Only difference with the jump_state.gd is that the collision from head to body is disabled, and no rotation is allowed (by not calling the rotate_on_input function).

Other minor stuff

Not as important but worth mentioning:

+

Final notes

+

I actually didn’t finish this game (as how I visualized it), but I got it in a playable state which is good. My big learning during this jam is the time management that it requires to plan and design a game. I lost a lot of time trying to implement some mechanics because I was facing many issues, because of my lack of practice (which was expected) as well as trying to blog and create the necessary sprites myself. Next time I should just get an asset pack and do something with it, as well as keeping the scope of my game shorter.

+

For exporting and everything else, I went with what I did for my FlappyBird Godot clone

@@ -444,7 +696,7 @@ func _ready():

By David Luévano

-

Created: Wed, Jun 08, 2022 @ 08:26 UTC

+

Created: Fri, Jun 10, 2022 @ 09:17 UTC

Tags: english, gamedev, gamejam, godot

diff --git a/blog/dst/index.html b/blog/dst/index.html index 6965972..163f679 100644 --- a/blog/dst/index.html +++ b/blog/dst/index.html @@ -95,7 +95,7 @@

Articles

    June 2022

    -
  • Jun 08 - Creating my Go Godot Jam 3 entry devlog 1
    • +
  • Jun 10 - Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1

    • May 2022

  • May 29 - Creating a FlappyBird clone in Godot 3.5 devlog 1
  • May 22 - General Godot project structure
    • diff --git a/blog/dst/rss.xml b/blog/dst/rss.xml index 64bb6d4..463bd03 100644 --- a/blog/dst/rss.xml +++ b/blog/dst/rss.xml @@ -13,8 +13,8 @@ Copyright 2021 David Luévano Alvarado david@luevano.xyz (David Luévano Alvarado) david@luevano.xyz (David Luévano Alvarado) - Sun, 29 May 2022 03:44:42 GMT - Sun, 29 May 2022 03:44:42 GMT + Fri, 10 Jun 2022 09:17:48 GMT + Fri, 10 Jun 2022 09:17:48 GMT pyssg v0.7.2 https://validator.w3.org/feed/docs/rss2.html 30 @@ -23,6 +23,611 @@ Luévano's Blog https://blog.luevano.xyz + + Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1 + https://blog.luevano.xyz/g/gogodot_jam3_devlog_1.html + https://blog.luevano.xyz/g/gogodot_jam3_devlog_1.html + Fri, 10 Jun 2022 09:17:05 GMT + English + Gamedev + Gamejam + Godot + Details on the implementation for the game I created for the Go Godot Jam 3, which theme is Evolution. + The jam’s theme is Evolution and all the details are listed here. This time I’m logging as I go, so there might be some changes to the script or scenes along the way I couldn’t actually do this, as I was running out of time.. Note that I’m not going to go into much details, the obvious will be ommitted.

    +

    I wanted to do a Snake clone, and I’m using this jam as an excuse to do it and add something to it. The features include:

    +
      +
    • Snakes will pass their stats in some form to the next snakes.
      • +
    • Non-grid snake movement. I just hate the grid constraint, so I wanted to make it move in any direction.
      • +
    • Depending on the food you eat, you’ll gain new mutations/abilities and the more you eat the more that mutation develops. didn’t have time to add this feature, sad.
      • +
    • Procedural map creation.
      • +
    +

    I created this game using Godot 3.5-rc3. You can find the source code in my GitHub here which at the time of writing this it doesn’t contain any exported files, for that you can go ahead and play it in your browser at itch.io, which you can find below:

    +

    + +

    You can also find the jam entry here.

    +

    Similarly with the my FlappyBird clone, I plan to update this to a better state.

    +

    Initial setup

    +

    Again, similar to the FlappyBird clone I developed, I’m using the directory structure I wrote about on Godot project structure with slight modifications to test things out. Also using similar Project settings as those from the FlappyBird clone like the pixel art texture imports, keybindings, layers, etc..

    +

    I’ve also setup GifMaker, with slight modifications as the AssetLib doesn’t install it correctly and contains unnecessry stuff: moved necessary files to the res://addons directory, deleted test scenes and files in general, and copied the license to the res://docs directory. Setting this up was a bit annoying because the tutorial it’s bad (with all due respect). I might do a separate entry just to explain how to set it up, because I couldn’t find it anywhere other than by inspecting some of the code/scenes.I ended up not leaving this enabled in the game as it lagged the game out, but it’s an option I’ll end up researching more.

    +

    This time I’m also going to be using an Event bus singleton (which I’m going to just call Event) as managing signals was pretty annoying on my last project; as well as a Global singleton for essential stuff so I don’t have to do as many cross references between nodes/scenes.

    +

    Assets

    +

    This time I’ll be creating my own assets in Aseprite, wont be that good, but enough to prototype and get things going.

    +

    Other than that I used few key sprites from vryell: Controller & Keyboard Icons and a font from datagoblin: Monogram.

    +

    The snake

    +

    This is the most challenging part in my opinion as making all the body parts follow the head in a user defined path it’s kinda hard. I tried with like 4-5 options and the one I’m detailing here is the only one that worked as I wanted for me. This time the directory structure I’m using is the following:

    +
    +FileSystem - Snake dir structure +
    FileSystem - Snake dir structure
    +
    +

    Basic movement

    +

    The most basic thing is to move the head, this is what we have control of. Create a scene called Head.tscn and setup the basic KinematicBody2D with it’s own Sprite and CollisionShape2D (I used a small circle for the tip of the head), and set the Collision Layer/Mask accordingly, for now just layer = bit 1. And all we need to do, is keep moving the snake forwards and be able to rotate left or right. Created a new script called head.gd attached to the root (KinematicBody2D) and added:

    +
    extends KinematicBody2D
+
+enum {
+    LEFT=-1,
+    RIGHT=1
+}
+
+var velocity: Vector2 = Vector2.ZERO
+var _direction: Vector2 = Vector2.UP
+
+
+func _physics_process(delta: float) -> void:
+    if Input.is_action_pressed("move_left"):
+        _rotate_to(LEFT)
+    if Input.is_action_pressed("move_right"):
+        _rotate_to(RIGHT)
+
+    velocity = _direction * Global.SNAKE_SPEED
+
+    velocity = move_and_slide(velocity)
+    _handle_time_elapsed(delta)
+
+
+func _rotate_to(direction: int) -> void:
+    rotate(deg2rad(direction * Global.SNAKE_ROT_SPEED * get_physics_process_delta_time()))
+    _direction = _direction.rotated(deg2rad(direction * Global.SNAKE_ROT_SPEED * get_physics_process_delta_time()))
+
    +

    After tunning all the necessary parameters you should get something like this:

    +
    +Snake - Basic movement (left and right controls) +
    Snake - Basic movement (left and right controls)
    +
    +

    Setting up path following

    +

    To move other snake parts by following the snake head the only solution I found was to use the Path2D and PathFollow2D nodes. Path2D basically just handles the curve/path that PathFollow2D will use to move its child node; and I say “child node” in singular… as PathFollow2D can only handle one damn child, all the other ones will have weird transformations and/or rotations. So, the next thing to do is to setup a way to compute (and draw so we can validate) the snake’s path/curve.

    +

    Added the signal snake_path_new_point(coordinates) to the Event singleton and then add the following to head.gd:

    +
    var _time_elapsed: float = 0.0
+
+# using a timer is not recommended for < 0.01
+func _handle_time_elapsed(delta: float) -> void:
+    if _time_elapsed >= Global.SNAKE_POSITION_UPDATE_INTERVAL:
+        Event.emit_signal("snake_path_new_point", global_position)
+        _time_elapsed = 0.0
+    _time_elapsed += delta
+
    +

    This will be pinging the current snake head position every 0.01 seconds (defined in Global). Now create a new scene called Snake.tscn which will contain a Node2D, a Path2D and an instance of Head as its childs. Create a new script called snake.gd attached to the root (Node2D) with the following content:

    +
    class_name Snake
+extends Node2D
+
+onready var path: Path2D = $Path
+
+func _ready():
+    Event.connect("snake_path_new_point", self, "_on_Head_snake_path_new_point")
+
+
+func _draw() -> void:
+    if path.curve.get_baked_points().size() >= 2:
+        draw_polyline(path.curve.get_baked_points(), Color.aquamarine, 1, true)
+
+
+func _on_Head_snake_path_new_point(coordinates: Vector2) -> void:
+    path.curve.add_point(coordinates)
+    # update call is to draw curve as there are new points to the path's curve
+    update()
+
    +

    With this, we’re now populating the Path2D curve points with the position of the snake head. You should be able to see it because of the _draw call. If you run it you should see something like this:

    +
    +Snake - Basic movement with path +
    Snake - Basic movement with path
    +
    +

    Define body parts for the snake

    +

    At this point the only thing to do is to add the corresponding next body parts and tail of the snake. To do so, we need a PathFollow2D to use the live-generating Path2D, the only caveat is that we need one of these per body part/tail (this took me hours to figure out, thanks documentation).

    +

    Create a new scene called Body.tscn with a PathFollow2D as its root and an Area2D as its child, then just add the necessary Sprite and CollisionShap2D for the Area2D, I’m using layer = bit 2 for its collision. Create a new script called generic_segment.gd with the following code:

    +
    extends PathFollow2D
+
+export(String, "body", "tail") var TYPE: String = "body"
+
+
+func _physics_process(delta: float) -> void:
+    offset += Global.SNAKE_SPEED * delta
+
    +

    And this can be attached to the Body‘s root node (PathFollow2D), no extra setup needed. Repeat the same steps for creating the Tail.tscn scene and when attaching the generic_segment.gd script just configure the Type parameter to tail in the GUI (by selecting the node with the script attached and editing in the Inspector).

    +

    Adding body parts

    +

    Now it’s just a matter of handling when to add new body parts in the snake.gd script. For now I’ve only setup for adding body parts to fulfill the initial length of the snake (this doesn’t include the head or tail). The extra code needed is the following:

    +
    export(PackedScene) var BODY_SEGMENT_NP: PackedScene
+export(PackedScene) var TAIL_SEGMENT_NP: PackedScene
+
+var current_body_segments: int = 0
+var max_body_segments: int = 1
+
+
+func _add_initial_segment(type: PackedScene) -> void:
+    if path.curve.get_baked_length() >= (current_body_segments + 1.0) * Global.SNAKE_SEGMENT_SIZE:
+        var _temp_body_segment: PathFollow2D = type.instance()
+        path.add_child(_temp_body_segment)
+        current_body_segments += 1
+
+
+func _on_Head_snake_path_new_point(coordinates: Vector2) -> void:
+    path.curve.add_point(coordinates)
+    # update call is to draw curve as there are new points to the path's curve
+    update()
+
+    # add the following lines
+    if current_body_segments < max_body_segments:
+        _add_initial_segment(BODY_SEGMENT_NP)
+    elif current_body_segments == max_body_segments:
+        _add_initial_segment(TAIL_SEGMENT_NP)
+
    +

    Select the Snake node and add the Body and Tail scene to the parameters, respectively. Then when running you should see something like this:

    +
    +Snake - Basic movement with all body parts +
    Snake - Basic movement with all body parts
    +
    +

    Now, we need to handle adding body parts after the snake is complete and already moved for a bit, this will require a queue so we can add part by part in the case that we eat multiple pieces of food in a short period of time. For this we need to add some signals: snake_adding_new_segment(type), snake_added_new_segment(type), snake_added_initial_segments and use them when makes sense. Now we need to add the following:

    +
    var body_segment_stack: Array
+var tail_segment: PathFollow2D
+# didn't konw how to name this, basically holds the current path lenght
+#   whenever the add body segment, and we use this stack to add body parts
+var body_segment_queue: Array
+
    +

    As well as updating _add_initial_segment with the following so it adds the new segment on the specific variable:

    +
    if _temp_body_segment.TYPE == "body":
+    body_segment_stack.append(_temp_body_segment)
+else:
+    tail_segment = _temp_body_segment
+
    +

    Now that it’s just a matter of creating the segment queue whenever a new segment is needed, as well as adding each segment in a loop whenever we have items in the queue and it’s a good distance to place the segment on. These two things can be achieved with the following code:

    +
    # this will be called in _physics_process
+func _add_new_segment() -> void:
+    var _path_length_threshold: float = body_segment_queue[0] + Global.SNAKE_SEGMENT_SIZE
+    if path.curve.get_baked_length() >= _path_length_threshold:
+        var _removed_from_queue: float = body_segment_queue.pop_front()
+        var _temp_body_segment: PathFollow2D = BODY_SEGMENT_NP.instance()
+        var _new_body_offset: float = body_segment_stack.back().offset - Global.SNAKE_SEGMENT_SIZE
+
+        _temp_body_segment.offset = _new_body_offset
+        body_segment_stack.append(_temp_body_segment)
+        path.add_child(_temp_body_segment)
+        tail_segment.offset = body_segment_stack.back().offset - Global.SNAKE_SEGMENT_SIZE
+
+        current_body_segments += 1
+
+
+func _add_segment_to_queue() -> void:
+    # need to have the queues in a fixed separation, else if the eating functionality
+    #   gets spammed, all next bodyparts will be spawned almost at the same spot
+    if body_segment_queue.size() == 0:
+        body_segment_queue.append(path.curve.get_baked_length())
+    else:
+        body_segment_queue.append(body_segment_queue.back() + Global.SNAKE_SEGMENT_SIZE)
+
    +

    With everything implemented and connected accordingly then we can add segments on demand (for testing I’m adding with a keystroke), it should look like this:

    +
    +Snake - Basic movement with dynamic addition of new segments +
    Snake - Basic movement with dynamic addition of new segments
    +
    +

    For now, this should be enough, I’ll add more stuff as needed as I go. Last thing is that after finished testing that the movement felt ok, I just added a way to stop the snake whenever it collides with itself by using the following code (and the signal snake_segment_body_entered(body)) in a main.gd script that is the entry point for the game:

    +
    func _snake_disabled(on_off: bool) -> void:
+    _snake.propagate_call("set_process", [on_off])
+    _snake.propagate_call("set_process_internal", [on_off])
+    _snake.propagate_call("set_physics_process", [on_off])
+    _snake.propagate_call("set_physics_process_internal", [on_off])
+    _snake.propagate_call("set_process_input", [on_off])
+
    +

    Which will stop the snake node and all children.

    +

    Fix on body segments following head

    +

    After a while of testing and developing, I noticed that sometimes the head “detaches” from the body when a lot of rotations happen (moving the snake left or right), because of how imprecise the Curve2D is. To do this I just send a signal (snake_rotated) whenever the snake rotates and make a small correction (in generic_segment.gd):

    +
    func _on_snake_rotated() -> void:
+    offset -= 0.75 * Global.SNAKE_SPEED * pow(get_physics_process_delta_time(), 2)
+
    +

    This is completely random, I tweaked it manually after a lot of iterations.

    +

    The food

    +

    For now I just decided to setup a simple system to see everything works fine. The idea is to make some kind of generic food node/scene and a “food manager” to spawn them, for now in totally random locations. For this I added the following signals: food_placing_new_food(type), food_placed_new_food(type) and food_eaten(type).

    +

    First thing is creating the Food.tscn which is just an Area2D with its necessary children with an attached script called food.gd. The script is really simple:

    +
    class_name Food # needed to access Type enum outside of the script, this registers this script as a node
+extends Area2D
+
+enum Type {
+    APPLE
+}
+
+var _type_texture: Dictionary = {
+    Type.APPLE: preload("res://entities/food/sprites/apple.png")
+}
+
+export(Type) var TYPE
+onready var _sprite: Sprite = $Sprite
+
+
+func _ready():
+    connect("body_entered", self, "_on_body_entered")
+    _sprite.texture = _type_texture[TYPE]
+
+
+func _on_body_entered(body: Node) -> void:
+    Event.emit_signal("food_eaten", TYPE)
+    queue_free()
+
    +

    Then this food_eaten signal is received in snake.gd to add a new segment to the queue.

    +

    Finally, for the food manager I just created a FoodManager.tscn with a Node2D with an attached script called food_manager.gd. To get a random position:

    +
    func _get_random_pos() -> Vector2:
+    var screen_size: Vector2 = get_viewport().get_visible_rect().size
+    var temp_x: float = randf() * screen_size.x - screen_size.x / 2.0
+    var temp_y: float = randf() * screen_size.y - screen_size.y / 2.0
+
+    return Vector2(temp_x, temp_y)
+
    +

    Which gets the job done, but later I’ll have to add a way to check that the position is valid. And to actually place the food:

    +
    func _place_new_food() -> void:
+    var food: Area2D = FOOD.instance()
+    var position: Vector2 = _get_random_pos()
+    food.global_position = position
+    add_child(food)
+
    +

    And this is used in _process to place new food whenever needed. For now I added a condition to add food until 10 pieces are in place, and keep adding whenever the food is is lower than 10. After setting everything up, this is the result:

    +
    +Snake - Food basic interaction +
    Snake - Food basic interaction
    +
    +

    Za warudo! (The world)

    +

    It just happend that I saw a video to create random maps by using a method called random walks, this video was made by NAD LABS: Nuclear Throne Like Map Generation In Godot. It’s a pretty simple but powerful script, he provided the source code from which I based my random walker, just tweaked a few things and added others. Some of the maps than can be generated with this method (already aded some random sprites):

    +
    +World map generator - Random map 1 +
    World map generator - Random map 1
    +
    +
    +World map generator - Random map 2 +
    World map generator - Random map 2
    +
    +
    +World map generator - Random map 3 +
    World map generator - Random map 3
    +
    +

    It started with just black and white tiles, but I ended up adding some sprites as it was really harsh to the eyes. My implementation is basically the same as NAD LABS‘ with few changes, most importantly: I separated the generation in 2 diferent tilemaps (floor and wall) to have better control as well as wrapped everything in a single scene with a “main” script with the following important functions:

    +
    func get_valid_map_coords() -> Array:
+    var safe_area: Array = walker_head.get_cells_around()
+    var cells_used: Array = ground_tilemap.get_used_cells()
+    for location in safe_area:
+        cells_used.erase(location)
+    return cells_used
+
+
+func get_centered_world_position(location: Vector2) -> Vector2:
+    return ground_tilemap.map_to_world(location) + Vector2.ONE * Global.TILE_SIZE / 2.0
+
    +

    Where get_cells_around is just a function that gets the safe cells around the origin. And this get_valid_map_coords just returns used cells minus the safe cells, to place food. get_centered_world_position is so we can center the food in the tiles.

    +

    Some signals I used for the world gen: world_gen_walker_started(id), world_gen_walker_finished(id), world_gen_walker_died(id) and world_gen_spawn_walker_unit(location).

    +

    Food placement

    +

    The last food algorithm doesn’t check anything related to the world, and thus the food could spawn in the walls and outside the map.

    +

    First thing is I generalized the food into a single script and added basic food and special food which inherit from base food. The most important stuff for the base food is to be able to set all necessary properties at first:

    +
    func update_texture() -> void:
+    _sprite.texture = texture[properties["type"]]
+
+
+func set_properties(pos: Vector2, loc: Vector2, special: bool, type: int, points: int=1, special_points: int=1, ttl: float = -1.0) -> void:
+    properties["global_position"] = pos
+    global_position = pos
+    properties["location"] = loc
+    properties["special"] = special
+    properties["type"] = type
+
+    properties["points"] = points
+    properties["special_points"] = special_points
+    properties["ttl"] = ttl
+    if properties["ttl"] != -1.0:
+        timer.wait_time = properties["ttl"]
+        timer.start()
+
    +

    Where the update_texture needs to be a separate function, because we need to create the food first, set properties, add as a child and then update the sprite; we also need to keep track of the global position, location (in tilemap coordinates) and identifiers for the type of food.

    +

    Then basic/special food just extend base food, define a Type enum and preloads the necessary textures, for example:

    +
    enum Type {
+    APPLE,
+    BANANA,
+    RAT
+}
+
+
+func _ready():
+    texture[Type.APPLE] = preload("res://entities/food/sprites/apple.png")
+    texture[Type.BANANA] = preload("res://entities/food/sprites/banana.png")
+    texture[Type.RAT] = preload("res://entities/food/sprites/rat.png")
+
    +

    Now, some of the most important change to food_manager.gd is to get an actual random valid position:

    +
    func _get_random_pos() -> Array:
+    var found_valid_loc: bool = false
+    var index: int
+    var location: Vector2
+
+    while not found_valid_loc:
+        index = randi() % possible_food_locations.size()
+        location = possible_food_locations[index]
+        if current_basic_food.find(location) == -1 and current_special_food.find(location) == -1:
+            found_valid_loc = true
+
+    return [world_generator.get_centered_world_position(location), location]
+
    +

    Other than that, there are some differences between placing normal and special food (specially the signal they send, and if an extra “special points” property is set). Some of the signals that I used that might be important: food_placing_new_food(type), food_placed_new_food(type, location) and food_eaten(type, location).

    +

    Stats clas and loading/saving data

    +

    I got the idea of saving the current stats (points, max body segments, etc.) in a separate Stats class for easier load/save data. This option I went with didn’t work as I would liked it to work, as it was a pain in the ass to setup and each time a new property is added you have to manually setup the load/save helper functions… so not the best option. This option I used was json but saving a Node directly could work better or using resources (saving tres files).

    +

    Stats class

    +

    The Stats “class” is just a script that extends from Node called stats.gd. It needs to define the class_name as Stats. The main content:

    +
    # main
+var points: int = 0
+var segments: int = 0
+
+# track of trait points
+var dash_points: int = 0
+var slow_points: int = 0
+var jump_points: int = 0
+
+# times trait achieved
+var dash_segments: int = 0
+var slow_segments: int = 0
+var jump_segments: int = 0
+
+# trait properties
+var dash_percentage: float = 0.0
+var slow_percentage: float = 0.0
+var jump_lenght: float = 0.0
+
+# trait active
+var trait_dash: bool = false
+var trait_slow: bool = false
+var trait_jump: bool = false
+
    +

    And with the ugliest functions:

    +
    func get_stats() -> Dictionary:
+    return {
+        "points": points,
+        "segments": segments,
+        "dash_points": dash_points,
+        "dash_segments": dash_segments,
+        "dash_percentage": dash_percentage,
+        "slow_points": slow_points,
+        "slow_segments": slow_segments,
+        "slow_percentage": slow_percentage,
+        "jump_points": jump_points,
+        "jump_segments": jump_segments,
+        "jump_lenght": jump_lenght,
+        "trait_dash": trait_dash,
+        "trait_slow": trait_slow,
+        "trait_jump": trait_jump
+    }
+
+
+func set_stats(stats: Dictionary) -> void:
+        points = stats["points"]
+        segments = stats["segments"]
+        dash_points = stats["dash_points"]
+        slow_points = stats["slow_points"]
+        jump_points = stats["jump_points"]
+        dash_segments = stats["dash_segments"]
+        slow_segments = stats["slow_segments"]
+        jump_segments = stats["jump_segments"]
+        dash_percentage = stats["dash_percentage"]
+        slow_percentage = stats["slow_percentage"]
+        jump_lenght = stats["jump_lenght"]
+        trait_dash = stats["trait_dash"]
+        trait_slow = stats["trait_slow"]
+        trait_jump = stats["trait_jump"]
+
    +

    And this is not scalable at all, but I had to do this at the end of the jam so no way of optimizing and/or doing it correctly, sadly.

    +

    Load/save data

    +

    The load/save function is pretty standard. It’s a singleton/autoload called SavedData with a script that extends from Node called save_data.gd:

    +
    const DATA_PATH: String = "user://data.save"
+
+var _stats: Stats
+
+
+func _ready() -> void:
+    _load_data()
+
+
+# called when setting "stats" and thus saving
+func save_data(stats: Stats) -> void:
+    _stats = stats
+    var file: File = File.new()
+    file.open(DATA_PATH, File.WRITE)
+    file.store_line(to_json(_stats.get_stats()))
+    file.close()
+
+
+func get_stats() -> Stats:
+    return _stats
+
+
+func _load_data() -> void:
+    # create an empty file if not present to avoid error while loading settings
+    _handle_new_file()
+
+    var file = File.new()
+    file.open(DATA_PATH, File.READ)
+    _stats = Stats.new()
+    _stats.set_stats(parse_json(file.get_line()))
+    file.close()
+
+
+func _handle_new_file() -> void:
+    var file: File = File.new()
+    if not file.file_exists(DATA_PATH):
+        file.open(DATA_PATH, File.WRITE)
+        _stats = Stats.new()
+        file.store_line(to_json(_stats.get_stats()))
+        file.close()
+
    +

    It uses json as the file format, but I might end up changing this in the future to something else more reliable and easier to use (Stats class related issues).

    +

    Scoring

    +

    For this I created a scoring mechanisms and just called it ScoreManager (score_manager.gd) which just basically listens to food_eaten signal and adds points accordingly to the current Stats object loaded. The main function is:

    +
    func _on_food_eaten(properties: Dictionary) -> void:
+    var is_special: bool = properties["special"]
+    var type: int = properties["type"]
+    var points: int = properties["points"]
+    var special_points: int = properties["special_points"]
+    var location: Vector2 = properties["global_position"]
+    var amount_to_grow: int
+    var special_amount_to_grow: int
+
+    amount_to_grow = _process_points(points)
+    _spawn_added_score_text(points, location)
+    _spawn_added_segment_text(amount_to_grow)
+
+    if is_special:
+        special_amount_to_grow = _process_special_points(special_points, type)
+        # _spawn_added_score_text(points, location)
+        _spawn_added_special_segment_text(special_amount_to_grow, type)
+        _check_if_unlocked(type)
+
    +

    Where the most important function is:

    +
    func _process_points(points: int) -> int:
+    var score_to_grow: int = (stats.segments + 1) * Global.POINTS_TO_GROW - stats.points
+    var amount_to_grow: int = 0
+    var growth_progress: int
+    stats.points += points
+    if points >= score_to_grow:
+        amount_to_grow += 1
+        points -= score_to_grow
+        # maybe be careful with this
+        amount_to_grow += points / Global.POINTS_TO_GROW
+        stats.segments += amount_to_grow
+        Event.emit_signal("snake_add_new_segment", amount_to_grow)
+
+    growth_progress = Global.POINTS_TO_GROW - ((stats.segments + 1) * Global.POINTS_TO_GROW - stats.points)
+    Event.emit_signal("snake_growth_progress", growth_progress)
+    return amount_to_grow
+
    +

    Which will add the necessary points to Stats.points and return the amount of new snake segments to grow. After this _spawn_added_score_segment and _spawn_added_segment_text just spawn a Label with the info on the points/segments gained; this is custom UI I created, nothing fancy.

    +

    Last thing is taht in _process_points there is a check at the end, where if the food eaten is “special” then a custom variation of the last 3 functions are executed. These are really similar, just specific to each kind of food.

    +

    This ScoreManager also handles the calculation for the game_over signal, to calculte progress, set necessary Stats values and save the data:

    +
    func _on_game_over() -> void:
+    var max_stats: Stats = _get_max_stats()
+    SaveData.save_data(max_stats)
+    Event.emit_signal("display_stats", initial_stats, stats, mutation_stats)
+
+
+func _get_max_stats() -> Stats:
+    var old_stats_dict: Dictionary = initial_stats.get_stats()
+    var new_stats_dict: Dictionary = stats.get_stats()
+    var max_stats: Stats = Stats.new()
+    var max_stats_dict: Dictionary = max_stats.get_stats()
+    var bool_stats: Array = [
+        "trait_dash",
+        "trait_slow",
+        "trait_jump"
+    ]
+
+    for i in old_stats_dict:
+        if bool_stats.has(i):
+            max_stats_dict[i] = old_stats_dict[i] or new_stats_dict[i]
+        else:
+            max_stats_dict[i] = max(old_stats_dict[i], new_stats_dict[i])
+    max_stats.set_stats(max_stats_dict)
+    return max_stats
+
    +

    Then this sends a signal display_stats to activate UI elements that shows the progression.

    +

    Naturally, the saved Stats are loaded whenever needed. For example, for the Snake, we load the stats and setup any value needed from there (like a flag to know if any ability is enabled), and since we’re saving the new Stats at the end, then on restart we load the updated one.

    +

    Snake redesigned with the state machine pattern

    +

    I redesigned the snake code (the head, actually) to use the state machine pattern by following this guide which is definitely a great guide, straight to the point and easy to implement.

    +

    Other than what is shown in the guide, I implemented some important functions in the state_machine.gd script itself, to be used by each of the states as needed:

    +
    func rotate_on_input() -> void:
+    if Input.is_action_pressed("move_left"):
+        player.rotate_to(player.LEFT)
+    if Input.is_action_pressed("move_right"):
+        player.rotate_to(player.RIGHT)
+
+
+func slow_down_on_collisions(speed_backup: float):
+    if player.get_last_slide_collision():
+        Global.SNAKE_SPEED = player.velocity.length()
+    else:
+        Global.SNAKE_SPEED = speed_backup
+
+
+func handle_slow_speeds() -> void:
+    if Global.SNAKE_SPEED <= Global.SNAKE_SPEED_BACKUP / 4.0:
+        Global.SNAKE_SPEED = Global.SNAKE_SPEED_BACKUP
+        Event.emit_signal("game_over")
+
    +

    And then in the StateMachine‘s _process:

    +
    func _physics_process(delta: float) -> void:
+    # state specific code, move_and_slide is called here
+    if state.has_method("physics_process"):
+        state.physics_process(delta)
+
+    handle_slow_speeds()
+    player.handle_time_elapsed(delta)
+
    +

    And now it’s just a matter of implementing the necessary states. I used 4: normal_stage.gd, slow_state.gd, dash_state.gd and jump_state.gd.

    +

    The normal_state.gd contains what the original head.gd code contained:

    +
    func physics_process(delta: float) -> void:
+    fsm.rotate_on_input()
+    fsm.player.velocity = fsm.player.direction * Global.SNAKE_SPEED
+    fsm.player.velocity = fsm.player.move_and_slide(fsm.player.velocity)
+
+    fsm.slow_down_on_collisions(Global.SNAKE_SPEED_BACKUP)
+
+
+func input(event: InputEvent) -> void:
+    if fsm.player.can_dash and event.is_action_pressed("dash"):
+        exit("DashState")
+    if fsm.player.can_slow and event.is_action_pressed("slow"):
+        exit("SlowState")
+    if fsm.player.can_jump and event.is_action_pressed("jump"):
+        exit("JumpState")
+
    +

    Here, the exit method is basically to change to the next state. And lastly, I’m only gonna show the dash_state.gd as the other ones are pretty similar:

    +
    func enter():
+    if fsm.DEBUG:
+        print("Got inside %s." % name)
+    Event.emit_signal("snake_started_dash")
+    Global.SNAKE_SPEED = Global.SNAKE_DASH_SPEED
+    yield(get_tree().create_timer(Global.SNAKE_DASH_TIME), "timeout")
+    exit()
+
+
+func exit():
+    Event.emit_signal("snake_finished_dash")
+    Global.SNAKE_SPEED = Global.SNAKE_SPEED_BACKUP
+    fsm.back()
+
+
+func physics_process(delta: float) -> void:
+    fsm.rotate_on_input()
+    fsm.player.velocity = fsm.player.direction * Global.SNAKE_SPEED
+    fsm.player.velocity = fsm.player.move_and_slide(fsm.player.velocity)
+
+    fsm.slow_down_on_collisions(Global.SNAKE_DASH_SPEED)
+
    +

    Where the important parts happen in the enter and exit functions. We need to change the Global.SNAKE_SPEED with the Global.SNAKE_DASH_SPEED on startand start the timer for how long should the dash last. And on the exit we reset the Global.SNAKE_SPEED back to normal. There is probably a better way of updating the Global.SNAKE_SPEED but this works just fine.

    +

    For the other ones is the same. Only difference with the jump_state.gd is that the collision from head to body is disabled, and no rotation is allowed (by not calling the rotate_on_input function).

    +

    Other minor stuff

    +

    Not as important but worth mentioning:

    +
      +
    • Added restartability function.
      • +
    • Added signals for game control: game_over and game_start, but ended not using them.
      • +
    • Fixed issue where the Curve2D stayed the same even when restarting by just setting an empty curve on starting the node.
      • +
    • Added a debug mode for drawing of the Curve2D instead of always drawing.
      • +
    • Tweaked the tracking of the snake size.
      • +
    • Tweaked the food system to contain more attributes and use a base food node.
      • +
    • Added a HUD with mini snake sprites.
      • +
    • Added a HUD for growth progress on snake body segments and abilities.
      • +
    • Refactored the nodes to make it work with change_scene_to, and added a main menu.
      • +
    • Added GUI for dead screen, showing the progress.
      • +
    +

    Final notes

    +

    I actually didn’t finish this game (as how I visualized it), but I got it in a playable state which is good. My big learning during this jam is the time management that it requires to plan and design a game. I lost a lot of time trying to implement some mechanics because I was facing many issues, because of my lack of practice (which was expected) as well as trying to blog and create the necessary sprites myself. Next time I should just get an asset pack and do something with it, as well as keeping the scope of my game shorter.

    +

    For exporting and everything else, I went with what I did for my FlappyBird Godot clone

    ]]>     +     Creating a FlappyBird clone in Godot 3.5 devlog 1 https://blog.luevano.xyz/g/flappybird_godot_devlog_1.html @@ -51,35 +656,35 @@

    Config

    Default import settings

    Since this is just pixel art, the importing settings for textures needs to be adjusted so the sprites don’t look blurry. Go to Project -> Project settings… -> Import defaults and on the drop down select Texture, untick everything and make sure Compress/Mode is set to Lossless.

    -
    +
    Project settings - Import defaults - Texture settings
    Project settings - Import defaults - Texture settings

    General settings

    It’s also a good idea to setup some config variables project-wide. To do so, go to Project -> Project settings… -> General, select Application/config and add a new property (there is a text box at the top of the project settings window) for game scale: application/config/game_scale for the type use float and then click on add; configure the new property to 3.0; On the same window, also add application/config/version as a string, and make it 1.0.0 (or whatever number you want).

    -
    +
    Project settings - General - Game scale and version properties
    Project settings - General - Game scale and version properties

    For my personal preferences, also disable some of the GDScript debug warnings that are annoying, this is done at Project -> Project settings… -> General, select Debug/GDScript and toggle off “Unused arguments”, “Unused signal” and “Return value discarded”, and any other that might come up too often and don’t want to see.

    -
    +
    Project settings - General - GDScript debug warnings
    Project settings - General - GDScript debug warnings

    Finally, set the initial window size in Project -> Project settings… -> General, select Display/Window and set Size/Width and Size/Height to 600 and 800, respectively. As well as the Stretch/Mode to “viewport”, and Stretch/Aspect to “keep”:

    -
    +
    Project settings - General - Initial window size
    Project settings - General - Initial window size

    Keybindings

    I only used 3 actions (keybindings): jump, restart and toggle_debug (optional). To add custom keybindings (so that the Input.something() API can be used), go to Project -> Project settings… -> Input Map and on the text box write “jump” and click add, then it will be added to the list and it’s just a matter of clicking the + sign to add a “Physical key”, press any key you want to be used to jump and click ok. Do the same for the rest of the actions.

    -
    +
    Project settings - Input Map - Adding necessary keybindings
    Project settings - Input Map - Adding necessary keybindings

    Layers

    Finally, rename the physics layers so we don’t lose track of which layer is which. Go to Project -> Layer Names -> 2d Physics and change the first 5 layer names to (in order): “player”, “ground”, “pipe”, “ceiling” and “score”.

    -
    +
    Project settings - Layer Names - 2D Physics
    Project settings - Layer Names - 2D Physics
    @@ -87,12 +692,12 @@

    For the assets I found out about a pack that contains just what I need: flappy-bird-assets by MegaCrash; I just did some minor modifications on the naming of the files. For the font I used Silver, and for the sound the resources from FlappyBird-N64 (which seems to be taken from 101soundboards.com which the orignal copyright holder is .Gears anyways).

    Importing

    Create the necessary directories to hold the respective assets and it’s just a matter of dragging and dropping, I used directories: res://entities/actors/player/sprites/, res://fonts/, res://levels/world/background/sprites/, res://levels/world/ground/sprites/, res://levels/world/pipe/sprites/, res://sfx/. For the player sprites, the “FileSystem” window looks like this (entities/actor directories are really not necessary):

    -
    +
    FileSystem - Player sprite imports
    FileSystem - Player sprite imports

    It should look similar for other directories, except maybe for the file extensions. For example, for the sfx:

    -
    +
    FileSystem - SFX imports
    FileSystem - SFX imports
    @@ -100,72 +705,72 @@

    Now it’s time to actually create the game, by creating the basic scenes that will make up the game. The hardest part and the most confusing is going to be the TileMaps, so that goes first.

    TileMaps

    I’m using a scene called “WorldTiles” with a Node2D node as root called the same. With 2 different TileMap nodes as children named “GroundTileMap” and “PipeTileMap” (these are their own scene); yes 2 different TileMaps because we need 2 different physics colliders (In Godot 4.0 you can have a single TileMap with different physics colliders in it). Each node has its own script. It should look something like this:

    -
    +
    Scene - WorldTiles (TileMaps)
    Scene - WorldTiles (TileMaps)

    I used the following directory structure:

    -
    +
    Scene - WorldTiles - Directory structure
    Scene - WorldTiles - Directory structure

    To configure the GroundTileMap, select the node and click on “(empty)” on the TileMap/Tile set property and then click on “New TileSet”, then click where the “(empty)” used to be, a new window should open on the bottom:

    -
    +
    TileSet - Configuration window
    TileSet - Configuration window

    Click on the plus on the bottom left and you can now select the specific tile set to use. Now click on the yellow “+ New Single Tile”, activate the grid and select any of the tiles. Should look like this:

    -
    +
    TileSet - New single tile
    TileSet - New single tile

    We need to do this because for some reason we can’t change the snap options before selecting a tile. After selecting a random tile, set up the Snap Options/Step (in the Inspector) and set it to 16x16 (or if using a different tile set, to it’s tile size):

    -
    +
    TileSet - Tile - Step snap options
    TileSet - Tile - Step snap options

    Now you can select the actual single tile. Once selected click on “Collision”, use the rectangle tool and draw the rectangle corresponding to that tile’s collision:

    -
    +
    TileSet - Tile - Selection and collision
    TileSet - Tile - Selection and collision

    Do the same for the other 3 tiles. If you select the TileMap itself again, it should look like this on the right (on default layout it’s on the left of the Inspector):

    -
    +
    TileSet - Available tiles
    TileSet - Available tiles

    The ordering is important only for the “underground tile”, which is the filler ground, it should be at the end (index 3); if this is not the case, repeat the process (it’s possible to rearrange them but it’s hard to explain as it’s pretty weird).

    At this point the tilemap doesn’t have any physics and the cell size is wrong. Select the “GroundTileMap”, set the TileMap/Cell/Size to 16x16, the TileMap/Collision/Layer set to bit 2 only (ground layer) and disable any TileMap/Collision/Mask bits. Should look something like this:

    -
    +
    TileMap - Cell size and collision configuration
    TileMap - Cell size and collision configuration

    Now it’s just a matter of repeating the same for the pipes (“PipeTileMap”), only difference is that when selecting the tiles you need to select 2 tiles, as the pipe is 2 tiles wide, or just set the Snap Options/Step to 32x16, for example, just keep the cell size to 16x16.

    Default ground tiles

    I added few default ground tiles to the scene, just for testing purposes but I left them there. These could be place programatically, but I was too lazy to change things. On the “WorldTiles” scene, while selecting the “GroundTileMap”, you can select the tiles you want to paint with, and left click in the grid to paint with the selected tile. Need to place tiles from (-8, 7) to (10, 7) as well as the tile below with the filler ground (the tile position/coordinates show at the bottom left, refer to the image below):

    -
    +
    Scene - WorldTiles - Default ground tiles
    Scene - WorldTiles - Default ground tiles

    Player

    On a new scene called “Player” with a KinematicBody2D node named “Player” as the root of the scene, then for the children: AnimatedSprite as “Sprite”, CollisionShape2D as “Collision” (with a circle shape) and 3 AudioStreamPlayers for “JumpSound”, “DeadSound” and “HitSound”. Not sure if it’s a good practice to have the audio here, since I did that at the end, pretty lazy. Then, attach a script to the “Player” node and then it should look like this:

    -
    +
    Scene - Player - Node setup
    Scene - Player - Node setup

    Select the “Player” node and set the CollisionShape2D/Collision/Layer to 1 and the CollisionObject2D/Collision/Mask to 2 and 3 (ground and pipe).

    For the “Sprite” node, when selecting it click on the “(empty)” for the AnimatedSprite/Frames property and click “New SpriteFrames”, click again where the “(empty)” used to be and ane window should open on the bottom:

    -
    +
    Scene - Player - SpriteFrames window
    Scene - Player - SpriteFrames window

    Right off the bat, set the “Speed” to 10 FPS (bottom left) and rename “default” to “bird_1”. With the “bird_1” selected, click on the “Add frames from a Sprite Sheet”, which is the second button under “Animation Frames:” which looks has an icon of a small grid (next to the folder icon), a new window will popup where you need to select the respective sprite sheet to use and configure it for importing. On the “Select Frames” window, change the “Vertical” to 1, and then select all 4 frames (Ctrl + Scroll wheel to zoom in):

    -
    +
    Scene - Player - Sprite sheet importer
    Scene - Player - Sprite sheet importer

    After that, the SpriteFrames window should look like this:

    -
    +
    Scene - Player - SpriteFrames window with sprite sheet configured
    Scene - Player - SpriteFrames window with sprite sheet configured
    @@ -184,12 +789,12 @@

Game

This is the actual “Game” scene that holds all the playable stuff, here we will drop in all the previous scenes; the root node is a Node2D and also has an attached script. Also need to add 2 additional AudioStreamPlayers for the “start” and “score” sounds, as well as a Sprite for the background (Sprite/Offset/Offset set to (0, 10)) and a Camera2D (Camera2D/Current set to true (checked)). It should look something like this:

-
+
Scene - Game - Node setup
Scene - Game - Node setup

The scene viewport should look something like the following:

-
+
Scene - Game - Viewport
Scene - Game - Viewport
@@ -197,12 +802,12 @@

Fonts

We need some font “Resources” to style the Label fonts. Under the FileSystem window, right click on the fonts directory (create one if needed) and click on “New Resource…” and select DynamicFontData, save it in the “fonts” directory as “SilverDynamicFontData.tres” (“Silver” as it is the font I’m using) then double click the just created resource and set the DynamicFontData/Font Path to the actual “Silver.ttf” font (or whatever you want).

Then create a new resource and this time select DynamicFont, name it “SilverDynamicFont.tres”, then double click to edit and add the “SilverDynamicFontData.tres” to the DynamicFont/Font/Font Data property (and I personally toggled off the DynamicFont/Font/Antialiased property), now just set the DynamicFont/Settings/(Size, Outline Size, Outline Color) to 32, 1 and black, respectively (or any other values you want). It should look something like this:

-
+
Resource - DynamicFont - Default font
Resource - DynamicFont - Default font

Do the same for another DynamicFont which will be used for the score label, named “SilverScoreDynamicFont.tres”. Only changes are Dynamic/Settings/(Size, Outline Size) which are set to 128 and 2, respectively. The final files for the fonts should look something like this:

-
+
Resource - Dynamicfont - Directory structure
Resource - Dynamicfont - Directory structure
@@ -231,7 +836,7 @@

The scene ends up looking like this:

-
+
Scene - UI - Node setup
Scene - UI - Node setup
@@ -365,7 +970,7 @@ func _remove_first_ground() -> void:

Where you might notice that the _initial_new_tile_x is 11, instead of 10, refer to Default ground tiles where we placed tiles from -8 to 10, so the next empty one is 11. These _place_new_ground and _remove_first_ground functions are called upon receiving the signal.

PipeTileMap

This is really similar to the “GroundTileMap” code, instead of defining an enum for the ground tiles, we define it for the pipe patterns (because each pipe is composed of multiple pipe tiles). If your pipe tile set looks like this (notice the index):

-
+
PipeTileMap - Tile set indexes
PipeTileMap - Tile set indexes
@@ -467,7 +1072,7 @@ func get_high_score() -> int: save_data()

Now, this script in particular will need to be a Singleton (AutoLoad), which means that there will be only one instance and will be available across all scripts. To do so, go to Project -> Project settings… -> AutoLoad and select this script in the “Path:” and add a “Node Name:” (I used “SavedData”, if you use something else, be careful while following this devlog) which will be the name we’ll use to access the singleton. Toggle on “Enable” if needed, it should look like this:

-
+
Project settings - AutoLoad - SavedData singleton
Project settings - AutoLoad - SavedData singleton
diff --git a/blog/dst/sitemap.xml b/blog/dst/sitemap.xml index fa0347b..8426222 100644 --- a/blog/dst/sitemap.xml +++ b/blog/dst/sitemap.xml @@ -2,6 +2,12 @@ + + https://blog.luevano.xyz/g/gogodot_jam3_devlog_1.html + 2022-06-10 + weekly + 1.0 + https://blog.luevano.xyz/g/flappybird_godot_devlog_1.html 2022-05-29 @@ -113,61 +119,67 @@ https://blog.luevano.xyz/tag/@english.html - 2022-05-29 + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@gamedev.html - 2022-05-29 + 2022-06-10 + daily + 0.5 + + + https://blog.luevano.xyz/tag/@gamejam.html + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@godot.html - 2022-05-29 + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@rant.html - 2022-05-29 + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@server.html - 2022-05-29 + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@short.html - 2022-05-29 + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@spanish.html - 2022-05-29 + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@tools.html - 2022-05-29 + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@tutorial.html - 2022-05-29 + 2022-06-10 daily 0.5 https://blog.luevano.xyz/tag/@update.html - 2022-05-29 + 2022-06-10 daily 0.5 diff --git a/blog/dst/tag/@english.html b/blog/dst/tag/@english.html index e7c0c92..e7fa19d 100644 --- a/blog/dst/tag/@english.html +++ b/blog/dst/tag/@english.html @@ -81,7 +81,7 @@

Articles

    June 2022

    -
  • Jun 08 - Creating my Go Godot Jam 3 entry devlog 1
    • +
  • Jun 10 - Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1

    • May 2022

  • May 29 - Creating a FlappyBird clone in Godot 3.5 devlog 1
  • May 22 - General Godot project structure
    • diff --git a/blog/dst/tag/@gamedev.html b/blog/dst/tag/@gamedev.html index e7e7b4d..009ad3b 100644 --- a/blog/dst/tag/@gamedev.html +++ b/blog/dst/tag/@gamedev.html @@ -81,7 +81,7 @@

    Articles

      June 2022

      -
    • Jun 08 - Creating my Go Godot Jam 3 entry devlog 1
      • +
    • Jun 10 - Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1

      • May 2022

    • May 29 - Creating a FlappyBird clone in Godot 3.5 devlog 1
    • May 22 - General Godot project structure
      • diff --git a/blog/dst/tag/@gamejam.html b/blog/dst/tag/@gamejam.html index 424284e..4e7d4b1 100644 --- a/blog/dst/tag/@gamejam.html +++ b/blog/dst/tag/@gamejam.html @@ -81,7 +81,7 @@

      Articles

      diff --git a/blog/dst/tag/@godot.html b/blog/dst/tag/@godot.html index a200266..31d93bf 100644 --- a/blog/dst/tag/@godot.html +++ b/blog/dst/tag/@godot.html @@ -81,7 +81,7 @@

      Articles

      diff --git a/blog/src/.files b/blog/src/.files index 73aadf8..590ef53 100644 --- a/blog/src/.files +++ b/blog/src/.files @@ -16,3 +16,4 @@ a/password_manager_authenticator_setup.md 1652654434.4686146 1653179084.149559 c g/starting_gamedev_blogging.md 1652764794.9016073 1653179221.26956 2d6665cebea06ff376dbde9643a893c4 english,gamedev,short,update g/godot_project_structure.md 1653182170.4395845 1653366918.4756405 a7b153df43631f17864cd8ab67aca60f english,gamedev,short g/flappybird_godot_devlog_1.md 1653795523.5988536 1653795876.8388574 8a4f723fbb20718ad5238fd28aaf28e2 english,gamedev,godot +g/gogodot_jam3_devlog_1.md 1654852625.58801 0.0 f8767cd4023a7a7c0ccf5388cdef049b english,gamedev,gamejam,godot diff --git a/blog/src/g/gogodot_jam3_devlog_1.md b/blog/src/g/gogodot_jam3_devlog_1.md index 6d6d13a..9e836b1 100644 --- a/blog/src/g/gogodot_jam3_devlog_1.md +++ b/blog/src/g/gogodot_jam3_devlog_1.md @@ -1,4 +1,4 @@ -title: Creating my Go Godot Jam 3 entry devlog 1 +title: Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1 author: David Luévano lang: en summary: Details on the implementation for the game I created for the Go Godot Jam 3, which theme is Evolution. @@ -7,8 +7,6 @@ tags: gamedev gamejam english -**IF YOU'RE SEEING THIS, THIS IS A WIP** - The jam's theme is Evolution and all the details are listed [here](https://itch.io/jam/go-godot-jam-3). ~~This time I'm logging as I go, so there might be some changes to the script or scenes along the way~~ ^^I couldn't actually do this, as I was running out of time.^^. Note that I'm not going to go into much details, the obvious will be ommitted. I wanted to do a *Snake* clone, and I'm using this jam as an excuse to do it and add something to it. The features include: @@ -18,6 +16,14 @@ I wanted to do a *Snake* clone, and I'm using this jam as an excuse to do it and - Depending on the food you eat, you'll gain new mutations/abilities ~~and the more you eat the more that mutation develops.~~ ^^didn't have time to add this feature, sad.^^ - Procedural map creation. +I created this game using *Godot 3.5-rc3*. You can find the source code in my GitHub [here](https://github.com/luevano/gogodot_jam3) which at the time of writing this it doesn't contain any exported files, for that you can go ahead and play it in your browser at itch.io, which you can find below: + +

      + +You can also find the jam entry [here](https://itch.io/jam/go-godot-jam-3/rate/1562701). + +Similarly with the my FlappyBird clone, I plan to update this to a better state. + ## Initial setup Again, similar to the [FlappyBird](https://blog.luevano.xyz/g/flappybird_godot_devlog_1.html) clone I developed, I'm using the directory structure I wrote about on [Godot project structure](https://blog.luevano.xyz/g/godot_project_structure.html) with slight modifications to test things out. Also using similar *Project settings* as those from the *FlappyBird* clone like the pixel art texture imports, keybindings, layers, etc.. @@ -398,13 +404,303 @@ func _get_random_pos() -> Array: Other than that, there are some differences between placing normal and special food (specially the signal they send, and if an extra "special points" property is set). Some of the signals that I used that might be important: `food_placing_new_food(type)`, `food_placed_new_food(type, location)` and `food_eaten(type, location)`. -## TODO +## Stats clas and loading/saving data + +I got the idea of saving the current stats (points, max body segments, etc.) in a separate *Stats* class for easier load/save data. This option I went with didn't work as I would liked it to work, as it was a pain in the ass to setup and each time a new property is added you have to manually setup the load/save helper functions... so not the best option. This option I used was json but saving a Node directly could work better or using resources (saving `tres` files). + +### Stats class + +The *Stats* "class" is just a script that extends from *Node* called `stats.gd`. It needs to define the `class_name` as `Stats`. The main content: + +```gdscript +# main +var points: int = 0 +var segments: int = 0 + +# track of trait points +var dash_points: int = 0 +var slow_points: int = 0 +var jump_points: int = 0 + +# times trait achieved +var dash_segments: int = 0 +var slow_segments: int = 0 +var jump_segments: int = 0 + +# trait properties +var dash_percentage: float = 0.0 +var slow_percentage: float = 0.0 +var jump_lenght: float = 0.0 + +# trait active +var trait_dash: bool = false +var trait_slow: bool = false +var trait_jump: bool = false +``` + +And with the ugliest functions: + +```gdscript +func get_stats() -> Dictionary: + return { + "points": points, + "segments": segments, + "dash_points": dash_points, + "dash_segments": dash_segments, + "dash_percentage": dash_percentage, + "slow_points": slow_points, + "slow_segments": slow_segments, + "slow_percentage": slow_percentage, + "jump_points": jump_points, + "jump_segments": jump_segments, + "jump_lenght": jump_lenght, + "trait_dash": trait_dash, + "trait_slow": trait_slow, + "trait_jump": trait_jump + } + + +func set_stats(stats: Dictionary) -> void: + points = stats["points"] + segments = stats["segments"] + dash_points = stats["dash_points"] + slow_points = stats["slow_points"] + jump_points = stats["jump_points"] + dash_segments = stats["dash_segments"] + slow_segments = stats["slow_segments"] + jump_segments = stats["jump_segments"] + dash_percentage = stats["dash_percentage"] + slow_percentage = stats["slow_percentage"] + jump_lenght = stats["jump_lenght"] + trait_dash = stats["trait_dash"] + trait_slow = stats["trait_slow"] + trait_jump = stats["trait_jump"] +``` + +And this is not scalable at all, but I had to do this at the end of the jam so no way of optimizing and/or doing it correctly, sadly. + +### Load/save data + +The load/save function is pretty standard. It's a singleton/autoload called *SavedData* with a script that extends from *Node* called `save_data.gd`: + +```gdscript +const DATA_PATH: String = "user://data.save" + +var _stats: Stats + + +func _ready() -> void: + _load_data() + + +# called when setting "stats" and thus saving +func save_data(stats: Stats) -> void: + _stats = stats + var file: File = File.new() + file.open(DATA_PATH, File.WRITE) + file.store_line(to_json(_stats.get_stats())) + file.close() + + +func get_stats() -> Stats: + return _stats + + +func _load_data() -> void: + # create an empty file if not present to avoid error while loading settings + _handle_new_file() + + var file = File.new() + file.open(DATA_PATH, File.READ) + _stats = Stats.new() + _stats.set_stats(parse_json(file.get_line())) + file.close() + + +func _handle_new_file() -> void: + var file: File = File.new() + if not file.file_exists(DATA_PATH): + file.open(DATA_PATH, File.WRITE) + _stats = Stats.new() + file.store_line(to_json(_stats.get_stats())) + file.close() +``` + +It uses json as the file format, but I might end up changing this in the future to something else more reliable and easier to use (*Stats* class related issues). + +## Scoring + +For this I created a scoring mechanisms and just called it *ScoreManager* (`score_manager.gd`) which just basically listens to `food_eaten` signal and adds points accordingly to the current *Stats* object loaded. The main function is: + +```gdscript +func _on_food_eaten(properties: Dictionary) -> void: + var is_special: bool = properties["special"] + var type: int = properties["type"] + var points: int = properties["points"] + var special_points: int = properties["special_points"] + var location: Vector2 = properties["global_position"] + var amount_to_grow: int + var special_amount_to_grow: int + + amount_to_grow = _process_points(points) + _spawn_added_score_text(points, location) + _spawn_added_segment_text(amount_to_grow) + + if is_special: + special_amount_to_grow = _process_special_points(special_points, type) + # _spawn_added_score_text(points, location) + _spawn_added_special_segment_text(special_amount_to_grow, type) + _check_if_unlocked(type) +``` + +Where the most important function is: + +```gdscript +func _process_points(points: int) -> int: + var score_to_grow: int = (stats.segments + 1) * Global.POINTS_TO_GROW - stats.points + var amount_to_grow: int = 0 + var growth_progress: int + stats.points += points + if points >= score_to_grow: + amount_to_grow += 1 + points -= score_to_grow + # maybe be careful with this + amount_to_grow += points / Global.POINTS_TO_GROW + stats.segments += amount_to_grow + Event.emit_signal("snake_add_new_segment", amount_to_grow) + + growth_progress = Global.POINTS_TO_GROW - ((stats.segments + 1) * Global.POINTS_TO_GROW - stats.points) + Event.emit_signal("snake_growth_progress", growth_progress) + return amount_to_grow +``` + +Which will add the necessary points to `Stats.points` and return the amount of new snake segments to grow. After this `_spawn_added_score_segment` and `_spawn_added_segment_text` just spawn a *Label* with the info on the points/segments gained; this is custom UI I created, nothing fancy. + +Last thing is taht in `_process_points` there is a check at the end, where if the food eaten is "special" then a custom variation of the last 3 functions are executed. These are really similar, just specific to each kind of food. -Add notes on: +This *ScoreManager* also handles the calculation for the `game_over` signal, to calculte progress, set necessary *Stats* values and save the data: -- Score manager stuff. -- Saved data and `Stats` class. -- State machine for player regarding abilities. +```gdscript +func _on_game_over() -> void: + var max_stats: Stats = _get_max_stats() + SaveData.save_data(max_stats) + Event.emit_signal("display_stats", initial_stats, stats, mutation_stats) + + +func _get_max_stats() -> Stats: + var old_stats_dict: Dictionary = initial_stats.get_stats() + var new_stats_dict: Dictionary = stats.get_stats() + var max_stats: Stats = Stats.new() + var max_stats_dict: Dictionary = max_stats.get_stats() + var bool_stats: Array = [ + "trait_dash", + "trait_slow", + "trait_jump" + ] + + for i in old_stats_dict: + if bool_stats.has(i): + max_stats_dict[i] = old_stats_dict[i] or new_stats_dict[i] + else: + max_stats_dict[i] = max(old_stats_dict[i], new_stats_dict[i]) + max_stats.set_stats(max_stats_dict) + return max_stats +``` + +Then this sends a signal `display_stats` to activate UI elements that shows the progression. + +Naturally, the saved *Stats* are loaded whenever needed. For example, for the *Snake*, we load the stats and setup any value needed from there (like a flag to know if any ability is enabled), and since we're saving the new *Stats* at the end, then on restart we load the updated one. + +## Snake redesigned with the state machine pattern + +I redesigned the snake code (the head, actually) to use the state machine pattern by following [this guide](https://gdscript.com/solutions/godot-state-machine/) which is definitely a great guide, straight to the point and easy to implement. + +Other than what is shown in the guide, I implemented some important functions in the `state_machine.gd` script itself, to be used by each of the states as needed: + +```gdscript +func rotate_on_input() -> void: + if Input.is_action_pressed("move_left"): + player.rotate_to(player.LEFT) + if Input.is_action_pressed("move_right"): + player.rotate_to(player.RIGHT) + + +func slow_down_on_collisions(speed_backup: float): + if player.get_last_slide_collision(): + Global.SNAKE_SPEED = player.velocity.length() + else: + Global.SNAKE_SPEED = speed_backup + + +func handle_slow_speeds() -> void: + if Global.SNAKE_SPEED <= Global.SNAKE_SPEED_BACKUP / 4.0: + Global.SNAKE_SPEED = Global.SNAKE_SPEED_BACKUP + Event.emit_signal("game_over") +``` + +And then in the *StateMachine*'s `_process`: + +```gdscript +func _physics_process(delta: float) -> void: + # state specific code, move_and_slide is called here + if state.has_method("physics_process"): + state.physics_process(delta) + + handle_slow_speeds() + player.handle_time_elapsed(delta) +``` + +And now it's just a matter of implementing the necessary states. I used 4: `normal_stage.gd`, `slow_state.gd`, `dash_state.gd` and `jump_state.gd`. + +The `normal_state.gd` contains what the original `head.gd` code contained: + +```gdscript +func physics_process(delta: float) -> void: + fsm.rotate_on_input() + fsm.player.velocity = fsm.player.direction * Global.SNAKE_SPEED + fsm.player.velocity = fsm.player.move_and_slide(fsm.player.velocity) + + fsm.slow_down_on_collisions(Global.SNAKE_SPEED_BACKUP) + + +func input(event: InputEvent) -> void: + if fsm.player.can_dash and event.is_action_pressed("dash"): + exit("DashState") + if fsm.player.can_slow and event.is_action_pressed("slow"): + exit("SlowState") + if fsm.player.can_jump and event.is_action_pressed("jump"): + exit("JumpState") +``` + +Here, the `exit` method is basically to change to the next state. And lastly, I'm only gonna show the `dash_state.gd` as the other ones are pretty similar: + +```gdscript +func enter(): + if fsm.DEBUG: + print("Got inside %s." % name) + Event.emit_signal("snake_started_dash") + Global.SNAKE_SPEED = Global.SNAKE_DASH_SPEED + yield(get_tree().create_timer(Global.SNAKE_DASH_TIME), "timeout") + exit() + + +func exit(): + Event.emit_signal("snake_finished_dash") + Global.SNAKE_SPEED = Global.SNAKE_SPEED_BACKUP + fsm.back() + + +func physics_process(delta: float) -> void: + fsm.rotate_on_input() + fsm.player.velocity = fsm.player.direction * Global.SNAKE_SPEED + fsm.player.velocity = fsm.player.move_and_slide(fsm.player.velocity) + + fsm.slow_down_on_collisions(Global.SNAKE_DASH_SPEED) +``` + +Where the important parts happen in the `enter` and `exit` functions. We need to change the `Global.SNAKE_SPEED` with the `Global.SNAKE_DASH_SPEED` on `start`and start the timer for how long should the dash last. And on the `exit` we reset the `Global.SNAKE_SPEED` back to normal. There is probably a better way of updating the `Global.SNAKE_SPEED` but this works just fine. + +For the other ones is the same. Only difference with the `jump_state.gd` is that the collision from head to body is disabled, and no rotation is allowed (by not calling the `rotate_on_input` function). ## Other minor stuff @@ -420,3 +716,9 @@ Not as important but worth mentioning: - Added a HUD for growth progress on snake body segments and abilities. - Refactored the nodes to make it work with `change_scene_to`, and added a main menu. - Added GUI for dead screen, showing the progress. + +## Final notes + +I actually didn't finish this game (as how I visualized it), but I got it in a playable state which is good. My big learning during this jam is the time management that it requires to plan and design a game. I lost a lot of time trying to implement some mechanics because I was facing many issues, because of my lack of practice (which was expected) as well as trying to blog and create the necessary sprites myself. Next time I should just get an asset pack and do something with it, as well as keeping the scope of my game shorter. + +For exporting and everything else, I went with what I did for my [FlappyBird Godot clone](https://blog.luevano.xyz/g/flappybird_godot_devlog_1#final-notes-and-exporting) \ No newline at end of file -- cgit v1.2.3