diff options
Diffstat (limited to 'live/blog/g')
| -rw-r--r-- | live/blog/g/flappybird_godot_devlog_1.html | 722 | ||||
| -rw-r--r-- | live/blog/g/godot_project_structure.html | 268 | ||||
| -rw-r--r-- | live/blog/g/gogodot_jam3_devlog_1.html | 733 | ||||
| -rw-r--r-- | live/blog/g/starting_gamedev_blogging.html | 149 |
4 files changed, 1872 insertions, 0 deletions
diff --git a/live/blog/g/flappybird_godot_devlog_1.html b/live/blog/g/flappybird_godot_devlog_1.html new file mode 100644 index 0000000..558e16b --- /dev/null +++ b/live/blog/g/flappybird_godot_devlog_1.html @@ -0,0 +1,722 @@ +<!DOCTYPE html> +<html class="theme-dark" lang="en +" + prefix="og: https://ogp.me/ns#"> + <head> + <base href="https://static.luevano.xyz"> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="icon" href="images/icons/favicon.ico"> +<title>Creating a FlappyBird clone in Godot 3.5 devlog 1 -- Luevano's Blog</title> + <meta name="description" content="Since I'm starting to get more into gamedev stuff, I'll start blogging about it just to keep consistent. This shows as "devlog 1" just in case I want to include more parts for extra stuff."/> +<link rel="alternate" type="application/rss+xml" href="https://blog.luevano.xyz/rss.xml" title="Luevano's Blog RSS"> + <!-- general style --> + <link rel="stylesheet" type="text/css" href="css/style.css"> + <link rel="stylesheet" type="text/css" href="fork-awesome/css/fork-awesome.min.css"> + <link rel="stylesheet" type="text/css" href="font-awesome/css/all.min.css"> + <!-- theme related --> + <script type="text/javascript" src="scripts/theme.js"></script> + <link id="theme-css" rel="stylesheet" type="text/css" href="css/theme.css"> + <!-- extra --> +<!-- highlight support for code blocks --> +<script type="text/javascript" src="hl/highlight.min.js"></script> +<script type="text/javascript"> + hljs.initHighlightingOnLoad(); +</script> +<link id="code-theme-css" rel="stylesheet" type="text/css" href="hl/styles/nord.min.css"> + + <!-- og meta --> + <meta property="og:title" content="Creating a FlappyBird clone in Godot 3.5 devlog 1 -- Luevano's Blog"/> + <meta property="og:type" content="article"/> + <meta property="og:url" content="https://blog.luevano.xyz/g/flappybird_godot_devlog_1.md"/> + <meta property="og:image" content="https://static.luevano.xyz/images/b/default.png"/> + <meta property="og:description" content="Since I'm starting to get more into gamedev stuff, I'll start blogging about it just to keep consistent. This shows as "devlog 1" just in case I want to include more parts for extra stuff."/> + <meta property="og:locale" content="en"/> + <meta property="og:site_name" content="Luevano's Blog"/> + </head> + + <body> + <header> +<nav> + <ul> + <li> + <a href="https://luevano.xyz/"><i class="fas fa-home" alt="Home"></i><span>Home</span></a> + </li> + + <li> + <a href="https://blog.luevano.xyz/"><i class="fas fa-book-open" alt="Blog"></i><span>Blog</span></a> + </li> + + <li> + <a href="https://art.luevano.xyz/"><i class="fas fa-paint-brush" alt="Art"></i><span>Art</span></a> + </li> + + <li><i class="fab fa-git" alt="Git"></i><span>Git</span> + <ul> + <li><a href="https://git.luevano.xyz/" target="_blank"><i class="fab fa-git-alt" alt="Git-alt"></i></a></li> + + <li><a href="https://github.com/luevano" target="_blank"><i class="fab fa-github" alt="Github"></i></a></li> + + <li><a href="https://gitlab.com/dluevano" target="_blank"><i class="fab fa-gitlab" alt="Gitlab"></i></a></li> + </ul> + </li> + + <li><i class="fas fa-box-open" alt="Stuff"></i><span>Stuff</span> + <ul> + <li><a href="https://gb.luevano.xyz/"><i class="fas fa-gamepad" alt="Gameboy"></i><span>Gameboy</span></a></li> + </ul> + </li> + </ul> +</nav> + +<button class="theme-switcher" onclick="toggleTheme()"><i class="fas fa-moon"></i><i class="fas fa-sun"></i></button> + + </header> + + <main> + <h1>Creating a FlappyBird clone in Godot 3.5 devlog 1</h1> + + <p>I just have a bit of experience with Godot and with gamedev in general, so I started with this game as it is pretty straight forward. On a high level the main characteristics of the game are:</p> +<ul> +<li>Literally just one sprite going up and down.</li> +<li>Constant horizontal move of the world/player.</li> +<li>If you go through the gap in the pipes you score a point.</li> +<li>If you touch the pipes, the ground or go past the “ceiling” you lose.</li> +</ul> +<p>The game was originally developed with <em>Godot 4.0 alpha 8</em>, but it didn’t support HTML5 (webassembly) export… so I backported to <em>Godot 3.5 rc1</em>.</p> +<p>Not going to specify all the details, only the needed parts and what could be confusing, as the source code is available and can be inspected; also this assumes minimal knowledge of <em>Godot</em> in general. Usually when I mention that a set/change of something it usually it’s a property and it can be found under the <em>Inspector</em> on the relevant node, unless stated otherwise; also, all scripts attached have the same name as the scenes, but in <em>snake_case</em> (scenes/nodes in <em>PascalCase</em>).</p> +<p>One thing to note, is that I started writing this when I finished the game, so it’s hard to go part by part, and it will be hard to test individual parts when going through this as everything is depending on each other. For the next devlog, I’ll do it as I go and it will include all the changes to the nodes/scripts as I was finding them, probably better idea and easier to follow.</p> +<p>The source code can be found in my GitHub <a href="https://github.com/luevano/flappybird_godot">here</a>, it also contains the exported versions for HTML5, Windows and Linux (be aware that the sound might be too high and I’m too lazy to make it configurable, it was the last thing I added), or you could also go to the itch.io page I setup where it’s playable in the browser:</p> +<p style="text-align:center"><iframe src="https://itch.io/embed/1551015?dark=true" width="552" height="167" frameborder="0"><a href="https://lorentzeus.itch.io/flappybirdgodot">FlappyBirdGodot by Lorentzeus</a></iframe></p> + +<h2 id="initial-project-setup">Initial project setup</h2> +<h3 id="directory-structure">Directory structure</h3> +<p>I’m basically going with what I wrote on <a href="https://blog.luevano.xyz/g/godot_project_structure.html">Godot project structure</a> recently, and probably with minor changes depending on the situation.</p> +<h3 id="config">Config</h3> +<h4 id="default-import-settings">Default import settings</h4> +<p>Since this is just pixel art, the importing settings for textures needs to be adjusted so the sprites don’t look blurry. Go to <em>Project -> Project settings… -> Import defaults</em> and on the drop down select <code>Texture</code>, untick everything and make sure <em>Compress/Mode</em> is set to <code>Lossless</code>.</p> +<figure id="__yafg-figure-4"> +<img alt="Project settings - Import defaults - Texture settings" src="images/g/flappybird_godot/project_settings_import_texture.png" title="Project settings - Import defaults - Texture settings"> +<figcaption>Project settings - Import defaults - Texture settings</figcaption> +</figure> +<h4 id="general-settings">General settings</h4> +<p>It’s also a good idea to setup some config variables project-wide. To do so, go to <em>Project -> Project settings… -> General</em>, select <em>Application/config</em> and add a new property (there is a text box at the top of the project settings window) for game scale: <code>application/config/game_scale</code> for the type use <code>float</code> and then click on add; configure the new property to <code>3.0</code>; On the same window, also add <code>application/config/version</code> as a <code>string</code>, and make it <code>1.0.0</code> (or whatever number you want).</p> +<figure id="__yafg-figure-5"> +<img alt="Project settings - General - Game scale and version properties" src="images/g/flappybird_godot/project_settings_config_properties.png" title="Project settings - General - Game scale and version properties"> +<figcaption>Project settings - General - Game scale and version properties</figcaption> +</figure> +<p>For my personal preferences, also disable some of the <em>GDScript</em> debug warnings that are annoying, this is done at <em>Project -> Project settings… -> General</em>, select <em>Debug/GDScript</em> 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.</p> +<figure id="__yafg-figure-6"> +<img alt="Project settings - General - GDScript debug warnings" src="images/g/flappybird_godot/project_settings_debug_gdscript.png" title="Project settings - General - GDScript debug warnings"> +<figcaption>Project settings - General - GDScript debug warnings</figcaption> +</figure> +<p>Finally, set the initial window size in <em>Project -> Project settings… -> General</em>, select <em>Display/Window</em> and set <em>Size/Width</em> and <em>Size/Height</em> to <code>600</code> and <code>800</code>, respectively. As well as the <em>Stretch/Mode</em> to “viewport”, and <em>Stretch/Aspect</em> to “keep”:</p> +<figure id="__yafg-figure-7"> +<img alt="Project settings - General - Initial window size" src="images/g/flappybird_godot/project_settings_window_settings.png" title="Project settings - General - Initial window size"> +<figcaption>Project settings - General - Initial window size</figcaption> +</figure> +<h4 id="keybindings">Keybindings</h4> +<p>I only used 3 actions (keybindings): jump, restart and toggle_debug (optional). To add custom keybindings (so that the <code>Input.something()</code> API can be used), go to <em>Project -> Project settings… -> Input Map</em> 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 <code>+</code> 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.</p> +<figure id="__yafg-figure-8"> +<img alt="Project settings - Input Map - Adding necessary keybindings" src="images/g/flappybird_godot/project_settings_input_map.png" title="Project settings - Input Map - Adding necessary keybindings"> +<figcaption>Project settings - Input Map - Adding necessary keybindings</figcaption> +</figure> +<h4 id="layers">Layers</h4> +<p>Finally, rename the physics layers so we don’t lose track of which layer is which. Go to <em>Project -> Layer Names -> 2d Physics</em> and change the first 5 layer names to (in order): “player”, “ground”, “pipe”, “ceiling” and “score”.</p> +<figure id="__yafg-figure-9"> +<img alt="Project settings - Layer Names - 2D Physics" src="images/g/flappybird_godot/project_settings_layer_names_2d_physics.png" title="Project settings - Layer Names - 2D Physics"> +<figcaption>Project settings - Layer Names - 2D Physics</figcaption> +</figure> +<h2 id="assets">Assets</h2> +<p>For the assets I found out about a pack that contains just what I need: <a href="https://megacrash.itch.io/flappy-bird-assets">flappy-bird-assets</a> by <a href="https://megacrash.itch.io/">MegaCrash</a>; I just did some minor modifications on the naming of the files. For the font I used <a href="https://poppyworks.itch.io/silver">Silver</a>, and for the sound the resources from <a href="https://github.com/meeq/FlappyBird-N64">FlappyBird-N64</a> (which seems to be taken from <a href="https://www.101soundboards.com/boards/10178-flappy-bird-sounds">101soundboards.com</a> which the orignal copyright holder is <a href="https://dotgears.com/">.Gears</a> anyways).</p> +<h3 id="importing">Importing</h3> +<p>Create the necessary directories to hold the respective assets and it’s just a matter of dragging and dropping, I used directories: <code>res://entities/actors/player/sprites/</code>, <code>res://fonts/</code>, <code>res://levels/world/background/sprites/</code>, <code>res://levels/world/ground/sprites/</code>, <code>res://levels/world/pipe/sprites/</code>, <code>res://sfx/</code>. For the player sprites, the “FileSystem” window looks like this (<code>entities/actor</code> directories are really not necessary):</p> +<figure id="__yafg-figure-10"> +<img alt="FileSystem - Player sprite imports" src="images/g/flappybird_godot/player_sprite_imports.png" title="FileSystem - Player sprite imports"> +<figcaption>FileSystem - Player sprite imports</figcaption> +</figure> +<p>It should look similar for other directories, except maybe for the file extensions. For example, for the sfx:</p> +<figure id="__yafg-figure-11"> +<img alt="FileSystem - SFX imports" src="images/g/flappybird_godot/sfx_imports.png" title="FileSystem - SFX imports"> +<figcaption>FileSystem - SFX imports</figcaption> +</figure> +<h2 id="scenes">Scenes</h2> +<p>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 <em>TileMaps</em>, so that goes first.</p> +<h3 id="tilemaps">TileMaps</h3> +<p>I’m using a scene called “WorldTiles” with a <em>Node2D</em> node as root called the same. With 2 different <em>TileMap</em> nodes as children named “GroundTileMap” and “PipeTileMap” (these are their own scene); yes 2 different <em>TileMaps</em> because we need 2 different physics colliders (In Godot 4.0 you can have a single <em>TileMap</em> with different physics colliders in it). Each node has its own script. It should look something like this:</p> +<figure id="__yafg-figure-12"> +<img alt="Scene - WorldTiles (TileMaps)" src="images/g/flappybird_godot/scene_world_tiles.png" title="Scene - WorldTiles (TileMaps)"> +<figcaption>Scene - WorldTiles (TileMaps)</figcaption> +</figure> +<p>I used the following directory structure:</p> +<figure id="__yafg-figure-13"> +<img alt="Scene - WorldTiles - Directory structure" src="images/g/flappybird_godot/scene_world_tiles_directory_structure.png" title="Scene - WorldTiles - Directory structure"> +<figcaption>Scene - WorldTiles - Directory structure</figcaption> +</figure> +<p>To configure the GroundTileMap, select the node and click on “(empty)” on the <em>TileMap/Tile set</em> property and then click on “New TileSet”, then click where the “(empty)” used to be, a new window should open on the bottom:</p> +<figure id="__yafg-figure-14"> +<img alt="TileSet - Configuration window" src="images/g/flappybird_godot/tile_set_config_window.png" title="TileSet - Configuration window"> +<figcaption>TileSet - Configuration window</figcaption> +</figure> +<p>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:</p> +<figure id="__yafg-figure-15"> +<img alt="TileSet - New single tile" src="images/g/flappybird_godot/tile_set_new_single_tile.png" title="TileSet - New single tile"> +<figcaption>TileSet - New single tile</figcaption> +</figure> +<p>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 <em>Snap Options/Step</em> (in the <em>Inspector</em>) and set it to 16x16 (or if using a different tile set, to it’s tile size):</p> +<figure id="__yafg-figure-16"> +<img alt="TileSet - Tile - Step snap options" src="images/g/flappybird_godot/tile_set_tile_step_snap_options.png" title="TileSet - Tile - Step snap options"> +<figcaption>TileSet - Tile - Step snap options</figcaption> +</figure> +<p>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:</p> +<figure id="__yafg-figure-17"> +<img alt="TileSet - Tile - Selection and collision" src="images/g/flappybird_godot/tile_set_tile_selection_collision.png" title="TileSet - Tile - Selection and collision"> +<figcaption>TileSet - Tile - Selection and collision</figcaption> +</figure> +<p>Do the same for the other 3 tiles. If you select the <em>TileMap</em> itself again, it should look like this on the right (on default layout it’s on the left of the <em>Inspector</em>):</p> +<figure id="__yafg-figure-18"> +<img alt="TileSet - Available tiles" src="images/g/flappybird_godot/tile_set_available_tiles.png" title="TileSet - Available tiles"> +<figcaption>TileSet - Available tiles</figcaption> +</figure> +<p>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).</p> +<p>At this point the tilemap doesn’t have any physics and the cell size is wrong. Select the “GroundTileMap”, set the <em>TileMap/Cell/Size</em> to 16x16, the <em>TileMap/Collision/Layer</em> set to <code>bit 2</code> only (ground layer) and disable any <em>TileMap/Collision/Mask</em> bits. Should look something like this:</p> +<figure id="__yafg-figure-19"> +<img alt="TileMap - Cell size and collision configuration" src="images/g/flappybird_godot/tile_map_cell_collision_configuration.png" title="TileMap - Cell size and collision configuration"> +<figcaption>TileMap - Cell size and collision configuration</figcaption> +</figure> +<p>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 <em>Snap Options/Step</em> to 32x16, for example, just keep the cell size to 16x16.</p> +<h4 id="default-ground-tiles">Default ground tiles</h4> +<p>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 <code>(-8, 7)</code> to <code>(10, 7)</code> as well as the tile below with the filler ground (the tile position/coordinates show at the bottom left, refer to the image below):</p> +<figure id="__yafg-figure-20"> +<img alt="Scene - WorldTiles - Default ground tiles" src="images/g/flappybird_godot/world_tiles_default_tiles.png" title="Scene - WorldTiles - Default ground tiles"> +<figcaption>Scene - WorldTiles - Default ground tiles</figcaption> +</figure> +<h3 id="player">Player</h3> +<p>On a new scene called “Player” with a <em>KinematicBody2D</em> node named “Player” as the root of the scene, then for the children: <em>AnimatedSprite</em> as “Sprite”, <em>CollisionShape2D</em> as “Collision” (with a circle shape) and 3 <em>AudioStreamPlayers</em> 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:</p> +<figure id="__yafg-figure-21"> +<img alt="Scene - Player - Node setup" src="images/g/flappybird_godot/scene_player_node_setup.png" title="Scene - Player - Node setup"> +<figcaption>Scene - Player - Node setup</figcaption> +</figure> +<p>Select the “Player” node and set the <em>CollisionShape2D/Collision/Layer</em> to 1 and the <em>CollisionObject2D/Collision/Mask</em> to 2 and 3 (ground and pipe).</p> +<p>For the “Sprite” node, when selecting it click on the “(empty)” for the <em>AnimatedSprite/Frames</em> property and click “New SpriteFrames”, click again where the “(empty)” used to be and ane window should open on the bottom:</p> +<figure id="__yafg-figure-22"> +<img alt="Scene - Player - SpriteFrames window" src="images/g/flappybird_godot/scene_player_spriteframes_window.png" title="Scene - Player - SpriteFrames window"> +<figcaption>Scene - Player - SpriteFrames window</figcaption> +</figure> +<p>Right off the bat, set the “Speed” to <code>10 FPS</code> (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 (<em>Ctrl + Scroll</em> wheel to zoom in):</p> +<figure id="__yafg-figure-23"> +<img alt="Scene - Player - Sprite sheet importer" src="images/g/flappybird_godot/scene_player_sprite_sheet_importer.png" title="Scene - Player - Sprite sheet importer"> +<figcaption>Scene - Player - Sprite sheet importer</figcaption> +</figure> +<p>After that, the <em>SpriteFrames</em> window should look like this:</p> +<figure id="__yafg-figure-24"> +<img alt="Scene - Player - SpriteFrames window with sprite sheet configured" src="images/g/flappybird_godot/scene_player_spriteframes_window_with_sprite_sheet.png" title="Scene - Player - SpriteFrames window with sprite sheet configured"> +<figcaption>Scene - Player - SpriteFrames window with sprite sheet configured</figcaption> +</figure> +<p>Finally, make sure the “Sprite” node has the <em>AnimatedSprite/Animation</em> is set to “bird_1” and that the “Collision” node is configured correctly for its size and position (I just have it as a radius of 7). As well as dropping the SFX files into the corresponding <em>AudioStreamPlayer</em> (into the <em>AudioStreamPlayer/Stream</em> property).</p> +<h3 id="other">Other</h3> +<p>These are really simple scenes that don’t require much setup:</p> +<ul> +<li>“CeilingDetector”: just an <em>Area2D</em> node with a <em>CollisionShape2D</em> in the form of a rectangle (<em>CollisionShape2D/Shape/extents</em> to <code>(120, 10)</code>), stretched horizontally so it fits the whole screen. <em>CollisionObject2D/Collision/Layer</em> set to <code>bit 4</code> (ceiling) and <em>CollisionObject2D/Collision/Mask</em> set to bit 1 (player).</li> +<li>“ScoreDetector”: similar to the “CeilingDetector”, but vertical (<em>CollisionShape2D/Shape/extents</em> to <code>(2.5, 128)</code>) and <em>CollisionObject2D/Collision/Layer</em> set to <code>bit 1</code> (player).</li> +<li>“WorldDetector”: <em>Node2D</em> with a script attached, and 3 <em>RayCast2D</em> as children:<ul> +<li>“NewTile”: <em>Raycast2D/Enabled</em> to true (checked), <em>Raycast2D/Cast To</em> <code>(0, 400)</code>, <em>Raycast2D/Collision Mask</em> to <code>bit 2</code> (ground) and <em>Node2D/Transform/Position</em> to <code>(152, -200)</code></li> +<li>“OldTile”: same as “NewTile”, except for the <em>Node2D/Transform/Position</em>, set it to <code>(-152, -200)</code>.</li> +<li>“OldPipe”: same as “OldTile”, except for the <em>Raycast2D/Collision Mask</em>, set it to <code>bit 3</code> (pipe).</li> +</ul> +</li> +</ul> +<h3 id="game">Game</h3> +<p>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 <em>Node2D</em> and also has an attached script. Also need to add 2 additional <em>AudioStreamPlayers</em> for the “start” and “score” sounds, as well as a <em>Sprite</em> for the background (<em>Sprite/Offset/Offset</em> set to <code>(0, 10)</code>) and a <em>Camera2D</em> (<em>Camera2D/Current</em> set to true (checked)). It should look something like this:</p> +<figure id="__yafg-figure-25"> +<img alt="Scene - Game - Node setup" src="images/g/flappybird_godot/scene_game_node_setup.png" title="Scene - Game - Node setup"> +<figcaption>Scene - Game - Node setup</figcaption> +</figure> +<p>The scene viewport should look something like the following:</p> +<figure id="__yafg-figure-26"> +<img alt="Scene - Game - Viewport" src="images/g/flappybird_godot/scene_game_viewport.png" title="Scene - Game - Viewport"> +<figcaption>Scene - Game - Viewport</figcaption> +</figure> +<h3 id="ui">UI</h3> +<h4 id="fonts">Fonts</h4> +<p>We need some font “Resources” to style the <em>Label</em> fonts. Under the <em>FileSystem</em> window, right click on the fonts directory (create one if needed) and click on “New Resource…” and select <em>DynamicFontData</em>, 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 <em>DynamicFontData/Font Path</em> to the actual “Silver.ttf” font (or whatever you want).</p> +<p>Then create a new resource and this time select <em>DynamicFont</em>, name it “SilverDynamicFont.tres”, then double click to edit and add the “SilverDynamicFontData.tres” to the <em>DynamicFont/Font/Font Data</em> property (and I personally toggled off the <em>DynamicFont/Font/Antialiased</em> property), now just set the <em>DynamicFont/Settings/(Size, Outline Size, Outline Color)</em> to 32, 1 and black, respectively (or any other values you want). It should look something like this:</p> +<figure id="__yafg-figure-27"> +<img alt="Resource - DynamicFont - Default font" src="images/g/flappybird_godot/resource_dynamic_font.png" title="Resource - DynamicFont - Default font"> +<figcaption>Resource - DynamicFont - Default font</figcaption> +</figure> +<p>Do the same for another <em>DynamicFont</em> which will be used for the score label, named “SilverScoreDynamicFont.tres”. Only changes are <em>Dynamic/Settings/(Size, Outline Size)</em> which are set to 128 and 2, respectively. The final files for the fonts should look something like this:</p> +<figure id="__yafg-figure-28"> +<img alt="Resource - Dynamicfont - Directory structure" src="images/g/flappybird_godot/resource_dynamic_font_directory_structure.png" title="Resource - Dynamicfont - Directory structure"> +<figcaption>Resource - Dynamicfont - Directory structure</figcaption> +</figure> +<h4 id="scene-setup">Scene setup</h4> +<p>This has a bunch of nested nodes, so I’ll try to be concise here. The root node is a <em>CanvasLayer</em> named “UI” with its own script attached, and for the children:</p> +<ul> +<li>“MarginContainer”: <em>MarginContainer</em> with <em>Control/Margin/(Left, Top)</em> set to <code>10</code> and <em>Control/Margin/(Right, Bottom)</em> set to <code>-10</code>.<ul> +<li>“InfoContainer”: <em>VBoxContainer</em> with <em>Control/Theme Overrides/Constants/Separation</em> set to <code>250</code>.<ul> +<li>“ScoreContainer”: <em>VBoxContainer</em>.<ul> +<li>“Score”: <em>Label</em> with <em>Label/Align</em> set to “Center”, <em>Control/Theme Overrides/Fonts/Font</em> to the “SilverScoreDynamicFont.tres”, if needed adjust the <em>DynamicFont</em> settings.</li> +<li>“HighScore: same as “Score”, escept for the <em>Control/Theme Overrides/Fonts/Font</em> which is set to “SilverDynamicFont.tres”.</li> +</ul> +</li> +<li>“StartGame”: Same as “HighScore”.</li> +</ul> +</li> +<li>“DebugContainer”: <em>VBoxContainer</em>.<ul> +<li>“FPS”: <em>Label</em>.</li> +</ul> +</li> +<li>“VersionContainer”: <em>VBoxContainer</em> with <em>BoxContainer/Alignment</em> set to “Begin”.<ul> +<li>“Version”: <em>Label</em> with <em>Label/Align</em> set to “Right”.</li> +</ul> +</li> +</ul> +</li> +</ul> +<p>The scene ends up looking like this:</p> +<figure id="__yafg-figure-29"> +<img alt="Scene - UI - Node setup" src="images/g/flappybird_godot/scene_ui.png" title="Scene - UI - Node setup"> +<figcaption>Scene - UI - Node setup</figcaption> +</figure> +<h3 id="main">Main</h3> +<p>This is the final scene where we connect the Game and the UI. It’s made of a <em>Node2D</em> with it’s own script attached and an instance of “Game” and “UI” as it’s children.</p> +<p>This is a good time to set the default scene when we run the game by going to <em>Project -> Project settings… -> General</em> and in <em>Application/Run</em> set the <em>Main Scene</em> to the “Main.tscn” scene.</p> +<h2 id="scripting">Scripting</h2> +<p>I’m going to keep this scripting part to the most basic code blocks, as it’s too much code, for a complete view you can head to the <a href="https://github.com/luevano/flappybird_godot">source code</a>.</p> +<p>As of now, the game itself doesn’t do anything if we hit play. The first thing to do so we have something going on is to do the minimal player scripting.</p> +<h3 id="player_1">Player</h3> +<p>The most basic code needed so the bird goes up and down is to just detect “jump” key presses and add a negative jump velocity so it goes up (<code>y</code> coordinate is reversed in godot…), we also check the velocity sign of the <code>y</code> coordinate to decide if the animation is playing or not.</p> +<pre><code class="language-gdscript">class_name Player +extends KinematicBody2D + +export(float, 1.0, 1000.0, 1.0) var JUMP_VELOCITY: float = 380.0 + +onready var sprite: AnimatedSprite = $Sprite + +var gravity: float = 10 * ProjectSettings.get_setting("physics/2d/default_gravity") +var velocity: Vector2 = Vector2.ZERO + + +func _physics_process(delta: float) -> void: + velocity.y += gravity * delta + + if Input.is_action_just_pressed("jump"): + velocity.y = -JUMP_VELOCITY + + if velocity.y < 0.0: + sprite.play() + else: + sprite.stop() + + velocity = move_and_slide(velocity) +</code></pre> +<p>You can play it now and you should be able to jump up and down, and the bird should stop on the ground (although you can keep jumping). One thing to notice is that when doing <code>sprite.stop()</code> it stays on the last frame, we can fix that using the code below (and then change <code>sprite.stop()</code> for <code>_stop_sprite()</code>):</p> +<pre><code class="language-gdscript">func _stop_sprite() -> void: + if sprite.playing: + sprite.stop() + if sprite.frame != 0: + sprite.frame = 0 +</code></pre> +<p>Where we just check that the last frame has to be the frame 0.</p> +<p>Now just a matter of adding other needed code for moving horizontally, add sound by getting a reference to the <em>AudioStreamPlayers</em> and doing <code>sound.play()</code> when needed, as well as handling death scenarios by adding a <code>signal died</code> at the beginning of the script and handle any type of death scenario using the below function:</p> +<pre><code class="language-gdscript">func _emit_player_died() -> void: + # bit 2 corresponds to pipe (starts from 0) + set_collision_mask_bit(2, false) + dead = true + SPEED = 0.0 + emit_signal("died") + # play the sounds after, because yield will take a bit of time, + # this way the camera stops when the player "dies" + velocity.y = -DEATH_JUMP_VELOCITY + velocity = move_and_slide(velocity) + hit_sound.play() + yield(hit_sound, "finished") + dead_sound.play() +</code></pre> +<p>Finally need to add the actual checks for when the player dies (like collision with ground or pipe) as well as a function that listens to a signal for when the player goes to the ceiling.</p> +<h3 id="worlddetector">WorldDetector</h3> +<p>The code is pretty simple, we just need a way of detecting if we ran out of ground and send a signal, as well as sending as signal when we start detecting ground/pipes behind us (to remove it) because the world is being generated as we move. The most basic functions needed are:</p> +<pre><code class="language-gdscript">func _was_colliding(detector: RayCast2D, flag: bool, signal_name: String) -> bool: + if detector.is_colliding(): + return true + if flag: + emit_signal(signal_name) + return false + return true + + +func _now_colliding(detector: RayCast2D, flag: bool, signal_name: String) -> bool: + if detector.is_colliding(): + if not flag: + emit_signal(signal_name) + return true + return false +</code></pre> +<p>We need to keep track of 3 “flags”: <code>ground_was_colliding</code>, <code>ground_now_colliding</code> and <code>pipe_now_colliding</code> (and their respective signals), which are going to be used to do the checks inside <code>_physics_process</code>. For example for checking for new ground: <code>ground_now_colliding = _now_colliding(old_ground, ground_now_colliding, "ground_started_colliding")</code>.</p> +<h3 id="worldtiles">WorldTiles</h3> +<p>This script is what handles the “GroundTileMap” as well as the “PipeTileMap” and just basically functions as a “Signal bus” connecting a bunch of signals from the “WorldDetector” with the <em>TileMaps</em> and just tracking how many pipes have been placed:</p> +<pre><code class="language-gdscript">export(int, 2, 20, 2) var PIPE_SEP: int = 6 +var tiles_since_last_pipe: int = PIPE_SEP - 1 + + +func _on_WorldDetector_ground_stopped_colliding() -> void: + emit_signal("place_ground") + + tiles_since_last_pipe += 1 + if tiles_since_last_pipe == PIPE_SEP: + emit_signal("place_pipe") + tiles_since_last_pipe = 0 + + +func _on_WorldDetector_ground_started_colliding() -> void: + emit_signal("remove_ground") + + +func _on_WorldDetector_pipe_started_colliding() -> void: + emit_signal("remove_pipe") +</code></pre> +<h4 id="groundtilemap">GroundTileMap</h4> +<p>This is the node that actually places the ground tiles upong receiving a signal. In general, what you want is to keep track of the newest tile that you need to place (empty spot) as well as the last tile that is in the tilemap (technically the first one if you count from left to right). I was experimenting with <code>enum</code>s so I used them to define the possible <code>Ground</code> tiles:</p> +<pre><code class="language-gdscript">enum Ground { + TILE_1, + TILE_2, + TILE_3, + TILE_DOWN_1, +} +</code></pre> +<p>This way you can just select the tile by doing <code>Ground.TILE_1</code>, which will correspond to the <code>int</code> value of <code>0</code>. So most of the code is just:</p> +<pre><code class="language-gdscript"># old_tile is the actual first tile, whereas the new_tile_position +# is the the next empty tile; these also correspond to the top tile +const _ground_level: int = 7 +const _initial_old_tile_x: int = -8 +const _initial_new_tile_x: int = 11 +var old_tile_position: Vector2 = Vector2(_initial_old_tile_x, _ground_level) +var new_tile_position: Vector2 = Vector2(_initial_new_tile_x, _ground_level) + + +func _place_new_ground() -> void: + set_cellv(new_tile_position, _get_random_ground()) + set_cellv(new_tile_position + Vector2.DOWN, Ground.TILE_DOWN_1) + new_tile_position += Vector2.RIGHT + + +func _remove_first_ground() -> void: + set_cellv(old_tile_position, -1) + set_cellv(old_tile_position + Vector2.DOWN, -1) + old_tile_position += Vector2.RIGHT +</code></pre> +<p>Where you might notice that the <code>_initial_new_tile_x</code> is <code>11</code>, instead of <code>10</code>, refer to <a href="#default-ground-tiles">Default ground tiles</a> where we placed tiles from <code>-8</code> to <code>10</code>, so the next empty one is <code>11</code>. These <code>_place_new_ground</code> and <code>_remove_first_ground</code> functions are called upon receiving the signal.</p> +<h4 id="pipetilemap">PipeTileMap</h4> +<p>This is really similar to the “GroundTileMap” code, instead of defining an <code>enum</code> 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):</p> +<figure id="__yafg-figure-30"> +<img alt="PipeTileMap - Tile set indexes" src="images/g/flappybird_godot/tile_set_pipes_indexes.png" title="PipeTileMap - Tile set indexes"> +<figcaption>PipeTileMap - Tile set indexes</figcaption> +</figure> +<p>Then you can use the following “pipe patterns”:</p> +<pre><code class="language-gdscript">var pipe: Dictionary = { + PipePattern.PIPE_1: [0, 1, 2, 2, 2, 2, 2, 2, 3, 4, -1, -1, -1, 0, 1, 2], + PipePattern.PIPE_2: [0, 1, 2, 2, 2, 2, 2, 3, 4, -1, -1, -1, 0, 1, 2, 2], + PipePattern.PIPE_3: [0, 1, 2, 2, 2, 2, 3, 4, -1, -1, -1, 0, 1, 2, 2, 2], + PipePattern.PIPE_4: [0, 1, 2, 2, 2, 3, 4, -1, -1, -1, 0, 1, 2, 2, 2, 2], + PipePattern.PIPE_5: [0, 1, 2, 2, 3, 4, -1, -1, -1, 0, 1, 2, 2, 2, 2, 2], + PipePattern.PIPE_6: [0, 1, 2, 3, 4, -1, -1, -1, 0, 1, 2, 2, 2, 2, 2, 2] +} +</code></pre> +<p>Now, the pipe system requires a bit more of tracking as we need to instantiate a “ScoreDetector” here, too. I ended up keeping track of the placed pipes/detectors by using a “pipe stack” (and “detector stack”) which is just an array of placed objects from which I pop the first when deleting them:</p> +<pre><code class="language-gdscript">onready var _pipe_sep: int = get_parent().PIPE_SEP +const _pipe_size: int = 16 +const _ground_level: int = 7 +const _pipe_level_y: int = _ground_level - 1 +const _initial_new_pipe_x: int = 11 +var new_pipe_starting_position: Vector2 = Vector2(_initial_new_pipe_x, _pipe_level_y) +var pipe_stack: Array + +# don't specify type for game, as it results in cyclic dependency, +# as stated here: https://godotengine.org/qa/39973/cyclic-dependency-error-between-actor-and-actor-controller +onready var game = get_parent().get_parent() +var detector_scene: PackedScene = preload("res://levels/detectors/score_detector/ScoreDetector.tscn") +var detector_offset: Vector2 = Vector2(16.0, -(_pipe_size / 2.0) * 16.0) +var detector_stack: Array +</code></pre> +<p>The <code>detector_offset</code> is just me being picky. For placing a new pipe, we get the starting position (bottom pipe tile) and build upwards, then instantiate a new “ScoreDetector” (<code>detector_scene</code>) and set it’s position to the pipe starting position plus the offset, so it’s centered in the pipe, then just need to connect the “body_entered” signal from the detector with the game, so we keep track of the scoring. Finally just add the placed pipe and detector to their corresponding stacks:</p> +<pre><code class="language-gdscript">func _place_new_pipe() -> void: + var current_pipe: Vector2 = new_pipe_starting_position + for tile in pipe[_get_random_pipe()]: + set_cellv(current_pipe, tile) + current_pipe += Vector2.UP + + var detector: Area2D = detector_scene.instance() + detector.position = map_to_world(new_pipe_starting_position) + detector_offset + detector.connect("body_entered", game, "_on_ScoreDetector_body_entered") + detector_stack.append(detector) + add_child(detector) + + pipe_stack.append(new_pipe_starting_position) + new_pipe_starting_position += _pipe_sep * Vector2.RIGHT +</code></pre> +<p>For removing pipes, it’s really similar but instead of getting the position from the next tile, we pop the first element from the (pipe/detector) stack and work with that. To remove the cells we just set the index to <code>-1</code>:</p> +<pre><code class="language-gdscript">func _remove_old_pipe() -> void: + var current_pipe: Vector2 = pipe_stack.pop_front() + var c: int = 0 + while c < _pipe_size: + set_cellv(current_pipe, -1) + current_pipe += Vector2.UP + c += 1 + + var detector: Area2D = detector_stack.pop_front() + remove_child(detector) + detector.queue_free() +</code></pre> +<p>These functions are called when receiving the signal to place/remove pipes.</p> +<h3 id="saved-data">Saved data</h3> +<p>Before proceeding, we require a way to save/load data (for the high scores). We’re going to use the <em>ConfigFile</em> node that uses a custom version of the “ini” file format. Need to define where to save the data:</p> +<pre><code class="language-gdscript">const DATA_PATH: String = "user://data.cfg" +const SCORE_SECTION: String = "score" +var _data: ConfigFile +</code></pre> +<p>Note that <code>user://</code> is a OS specific path in which the data can be stored on a per user basis, for more: <a href="https://docs.godotengine.org/en/stable/tutorials/io/data_paths.html">File paths</a>. Then, a way to load the save file:</p> +<pre><code class="language-gdscript">func _load_data() -> void: + # create an empty file if not present to avoid error while loading settings + var file: File = File.new() + if not file.file_exists(DATA_PATH): + file.open(DATA_PATH, file.WRITE) + file.close() + + _data = ConfigFile.new() + var err: int = _data.load(DATA_PATH) + if err != OK: + print("[ERROR] Cannot load data.") +</code></pre> +<p>A way to save the data:</p> +<pre><code class="language-gdscript">func save_data() -> void: + var err: int = _data.save(DATA_PATH) + if err != OK: + print("[ERROR] Cannot save data.") +</code></pre> +<p>And of course, a way to get and set the high score:</p> +<pre><code class="language-gdscript">func set_new_high_score(high_score: int) -> void: + _data.set_value(SCORE_SECTION, "high_score", high_score) + + +func get_high_score() -> int: + return _data.get_value(SCORE_SECTION, "high_score") +</code></pre> +<p>Then, whenever this script is loaded we load the data and if it’s a new file, then add the default high score of 0:</p> +<pre><code class="language-gdscript">func _ready() -> void: + _load_data() + + if not _data.has_section(SCORE_SECTION): + set_new_high_score(0) + save_data() +</code></pre> +<p>Now, this script in particular will need to be a <a href="https://docs.godotengine.org/en/stable/tutorials/scripting/singletons_autoload.html">Singleton (AutoLoad)</a>, which means that there will be only one instance and will be available across all scripts. To do so, go to <em>Project -> Project settings… -> AutoLoad</em> 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:</p> +<figure id="__yafg-figure-31"> +<img alt="Project settings - AutoLoad - SavedData singleton" src="images/g/flappybird_godot/project_settings_autoload_saved_data.png" title="Project settings - AutoLoad - SavedData singleton"> +<figcaption>Project settings - AutoLoad - SavedData singleton</figcaption> +</figure> +<h3 id="game_1">Game</h3> +<p>The game script it’s also like a “Signal bus” in the sense that it connects all its childs’ signals together, and also has the job of starting/stopping the <code>_process</code> and <code>_physics_process</code> methods from the childs as needed. First, we need to define the signals and and references to all child nodes:</p> +<pre><code class="language-gdscript">signal game_started +signal game_over +signal new_score(score, high_score) + +onready var player: Player = $Player +onready var background: Sprite= $Background +onready var world_tiles: WorldTiles = $WorldTiles +onready var ceiling_detector: Area2D = $CeilingDetector +onready var world_detector: Node2D = $WorldDetector +onready var camera: Camera2D = $Camera +onready var start_sound: AudioStreamPlayer = $StartSound +onready var score_sound: AudioStreamPlayer = $ScoreSound +</code></pre> +<p>It’s important to get the actual “player speed”, as we’re using a scale to make the game look bigger (remember, pixel art), to do so we need a reference to the “game_scale” we setup at the beginning and compute the <code>player_speed</code>:</p> +<pre><code class="language-gdscript">var _game_scale: float = ProjectSettings.get_setting("application/config/game_scale") +var player_speed: float + + +func _ready() -> void: + scale = Vector2(_game_scale, _game_scale) + # so we move at the actual speed of the player + player_speed = player.SPEED / _game_scale +</code></pre> +<p>This <code>player_speed</code> will be needed as we need to move all the nodes (“Background”, “Camera”, etc.) in the <code>x</code> axis as the player is moving. This is done in the <code>_physics_process</code>:</p> +<pre><code class="language-gdscript">func _physics_process(delta: float) -> void: + ceiling_detector.move_local_x(player_speed * delta) + world_detector.move_local_x(player_speed * delta) + background.move_local_x(player_speed * delta) + camera.move_local_x(player_speed * delta) +</code></pre> +<p>We also need a way to start and stop the processing of all the nodes:</p> +<pre><code class="language-gdscript">func _set_processing_to(on_off: bool, include_player: bool = true) -> void: + set_process(on_off) + set_physics_process(on_off) + if include_player: + player.set_process(on_off) + player.set_physics_process(on_off) + world_tiles.set_process(on_off) + world_tiles.set_physics_process(on_off) + ceiling_detector.set_process(on_off) + ceiling_detector.set_physics_process(on_off) +</code></pre> +<p>Where the <code>player</code> is a special case, as when the player dies, it should still move (only down), else it would just freeze in place. In <code>_ready</code> we connect all the necessary signals as well as initially set the processing to <code>false</code> using the last function. To start/restart the game we need to keep a flag called <code>is_game_running</code> initially set to <code>false</code> and then handle the (re)startability in <code>_input</code>:</p> +<pre><code class="language-gdscript">func _input(event: InputEvent) -> void: + if not is_game_running and event.is_action_pressed("jump"): + _set_processing_to(true) + is_game_running = true + emit_signal("game_started") + start_sound.play() + + if event.is_action_pressed("restart"): + get_tree().reload_current_scene() +</code></pre> +<p>Then we handle two specific signals:</p> +<pre><code class="language-gdscript">func _on_Player_died() -> void: + _set_processing_to(false, false) + emit_signal("game_over") + + +func _on_ScoreDetector_body_entered(body: Node2D) -> void: + score += 1 + if score > high_score: + high_score = score + SavedData.set_new_high_score(high_score) + SavedData.save_data() + emit_signal("new_score", score, high_score) + score_sound.play() +</code></pre> +<p>When the <code>player</code> dies, we set all processing to <code>false</code>, except for the player itself (so it can drop all the way to the ground). Also, when receiving a “scoring” signal, we manage the current score, as well as saving the new high score when applicable, note that we need to read the <code>high_score</code> at the beginning by calling <code>SavedData.get_high_score()</code>. This signal we emit will be received by the UI so it updates accordingly.</p> +<h3 id="ui_1">UI</h3> +<p>First thing is to get a reference to all the child <em>Labels</em>, an initial reference to the high score as well as the version defined in the project settings:</p> +<pre><code class="language-gdscript">onready var fps_label: Label = $MarginContainer/DebugContainer/FPS +onready var version_label: Label = $MarginContainer/VersionContainer/Version +onready var score_label: Label = $MarginContainer/InfoContainer/ScoreContainer/Score +onready var high_score_label: Label = $MarginContainer/InfoContainer/ScoreContainer/HighScore +onready var start_game_label: Label = $MarginContainer/InfoContainer/StartGame + +onready var _initial_high_score: int = SavedData.get_high_score() + +var _version: String = ProjectSettings.get_setting("application/config/version") +</code></pre> +<p>Then set the initial <em>Label</em> values as well as making the <code>fps_label</code> invisible:</p> +<pre><code class="language-gdscript">func _ready() -> void: + fps_label.visible = false + version_label.set_text("v%s" % _version) + high_score_label.set_text("High score: %s" % _initial_high_score) +</code></pre> +<p>Now we need to handle the <code>fps_label</code> update and toggle:</p> +<pre><code class="language-gdscript">func _input(event: InputEvent) -> void: + if event.is_action_pressed("toggle_debug"): + fps_label.visible = !fps_label.visible + + +func _process(delta: float) -> void: + if fps_label.visible: + fps_label.set_text("FPS: %d" % Performance.get_monitor(Performance.TIME_FPS)) +</code></pre> +<p>Finally the signal receiver handlers which are straight forward:</p> +<pre><code class="language-gdscript">func _on_Game_game_started() -> void: + start_game_label.visible = false + high_score_label.visible = false + + +func _on_Game_game_over() -> void: + start_game_label.set_text("Press R to restart") + start_game_label.visible = true + high_score_label.visible = true + + +func _on_Game_new_score(score: int, high_score: int) -> void: + score_label.set_text(String(score)) + high_score_label.set_text("High score: %s" % high_score) +</code></pre> +<h3 id="main_1">Main</h3> +<p>This is the shortest script, it just connects the signals between the “Game” and the “UI”:</p> +<pre><code class="language-gdscript">onready var game: Game = $Game +onready var ui: UI = $UI + +var _game_over: bool = false + + +func _ready() -> void: + game.connect("game_started", ui, "_on_Game_game_started") + game.connect("game_over", ui, "_on_Game_game_over") + game.connect("new_score", ui, "_on_Game_new_score") +</code></pre> +<h2 id="final-notes-and-exporting">Final notes and exporting</h2> +<p>At this point the game should be fully playable (if any detail missing feel free to look into the source code linked at the beginning). Only thing missing is an icon for the game; I did one pretty quicly with the assets I had.</p> +<h3 id="preparing-the-files">Preparing the files</h3> +<p>If you followed the directory structure I used, then only thing needed is to transform the icon to a native Windows <code>ico</code> format (if exporting to Windows, else ignore this part). For this you need <a href="https://imagemagick.org/index.php">ImageMagick</a> or some other program that can transform <code>png</code> (or whatever file format you used for the icon) to <code>ico</code>. I used [Chocolatey][https://chocolatey.org/] to install <code>imagemagick</code>, then to convert the icon itself used: <code>magick convert icon.png -define icon:auto-resize=256,128,64,48,32,16 icon.ico</code> as detailed in <em>Godot</em>‘s <a href="https://docs.godotengine.org/en/stable/tutorials/export/changing_application_icon_for_windows.html">Changing application icon for Windows</a>.</p> +<h3 id="exporting">Exporting</h3> +<p>You need to download the templates for exporting as detailed in <em>Godot</em>‘s <a href="https://docs.godotengine.org/en/stable/tutorials/export/exporting_projects.html">Exporting projects</a>. Basically you go to <em>Editor -> Manage Export Templates…</em> and download the latest one specific to your <em>Godot</em> version by clicking on “Download and Install”.</p> +<p>If exporting for Windows then you also need to download <code>rcedit</code> from <a href="https://github.com/electron/rcedit/releases/latest">here</a>. Just place it wherever you want (I put it next to the <em>Godot</em> executable).</p> +<p>Then go to <em>Project -> Export…</em> and the Window should be empty, add a new template by clicking on “Add…” at the top and then select the template you want. I used HTML5, Windows Desktop and Linux/X11. Really the only thing you need to set is the “Export Path” for each template, which is te location of where the executable will be written to, and in the case of the Windows Desktop template you could also setup stuff like “Company Name”, “Product Name”, “File/Product Version”, etc..</p> +<p>Once the templates are setup, select any and click on “Export Project” at the bottom, and make sure to untoggle “Export With Debug” in the window that pops up, this checkbox should be at the bottom of the new window.</p> + + <div class="page-nav"> + <span class="next"> + <a href="https://blog.luevano.xyz/g/gogodot_jam3_devlog_1.html" alt="Next"> + <i class="fas fa-arrow-left" alt="Arrow left"></i> + <span>Next</span> + </a> + </span> + + <span class="index"> + <a href="https://blog.luevano.xyz" alt="Index"> + <i class="fas fa-home" alt="Home"></i> + <span>Index</span> + </a> + </span> + + <span class="previous"> + <a href="https://blog.luevano.xyz/g/godot_project_structure.html" alt="Previous"> + <i class="fas fa-arrow-right" alt="Arrow right"></i> + <span>Previous</span> + </a> + </span> +</div> + + + <hr> + <div class="article-info"> + <p>By David Luévano</p> + <p>Created: Sun, May 29, 2022 @ 03:38 UTC</p> + <p>Modified: Sun, May 29, 2022 @ 03:44 UTC</p> + <div class="article-tags"> + <p>Tags: +<a href="https://blog.luevano.xyz/tag/@english.html">english</a>, <a href="https://blog.luevano.xyz/tag/@gamedev.html">gamedev</a>, <a href="https://blog.luevano.xyz/tag/@godot.html">godot</a> </p> +</div> + + </div> + </main> + + <footer> +<span> + <i class="fas fa-address-card" alt="Contact"></i> + <a href="https://blog.luevano.xyz/contact.html">Contact</a> +</span> + +<span> + <i class="fas fa-donate" alt="Donate"></i> + <a href="https://blog.luevano.xyz/donate.html">Donate</a> +</span> + +<span> + <i class="fas fa-rss" alt="RSS"></i> + <a target="_blank" href="https://blog.luevano.xyz/rss.xml">RSS</a> +</span> + +<br> +<span class="created-with"> + <i class="fas fa-hammer" alt="Hammer"></i> + Created with <a href="https://github.com/luevano/pyssg">pyssg</a> +</span> + +<br> +<span class="copyright"> + Copyright <i class="far fa-copyright" alt="Copyright"></i> 2023 David Luévano Alvarado +</span> + + </footer> + </body> +</html>
\ No newline at end of file diff --git a/live/blog/g/godot_project_structure.html b/live/blog/g/godot_project_structure.html new file mode 100644 index 0000000..3727da0 --- /dev/null +++ b/live/blog/g/godot_project_structure.html @@ -0,0 +1,268 @@ +<!DOCTYPE html> +<html class="theme-dark" lang="en +" + prefix="og: https://ogp.me/ns#"> + <head> + <base href="https://static.luevano.xyz"> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="icon" href="images/icons/favicon.ico"> +<title>General Godot project structure -- Luevano's Blog</title> + <meta name="description" content="Details on the project structure I'm using for Godot, based on preference and some research I did."/> +<link rel="alternate" type="application/rss+xml" href="https://blog.luevano.xyz/rss.xml" title="Luevano's Blog RSS"> + <!-- general style --> + <link rel="stylesheet" type="text/css" href="css/style.css"> + <link rel="stylesheet" type="text/css" href="fork-awesome/css/fork-awesome.min.css"> + <link rel="stylesheet" type="text/css" href="font-awesome/css/all.min.css"> + <!-- theme related --> + <script type="text/javascript" src="scripts/theme.js"></script> + <link id="theme-css" rel="stylesheet" type="text/css" href="css/theme.css"> + <!-- extra --> +<!-- highlight support for code blocks --> +<script type="text/javascript" src="hl/highlight.min.js"></script> +<script type="text/javascript"> + hljs.initHighlightingOnLoad(); +</script> +<link id="code-theme-css" rel="stylesheet" type="text/css" href="hl/styles/nord.min.css"> + + <!-- og meta --> + <meta property="og:title" content="General Godot project structure -- Luevano's Blog"/> + <meta property="og:type" content="article"/> + <meta property="og:url" content="https://blog.luevano.xyz/g/godot_project_structure.md"/> + <meta property="og:image" content="https://static.luevano.xyz/images/b/default.png"/> + <meta property="og:description" content="Details on the project structure I'm using for Godot, based on preference and some research I did."/> + <meta property="og:locale" content="en"/> + <meta property="og:site_name" content="Luevano's Blog"/> + </head> + + <body> + <header> +<nav> + <ul> + <li> + <a href="https://luevano.xyz/"><i class="fas fa-home" alt="Home"></i><span>Home</span></a> + </li> + + <li> + <a href="https://blog.luevano.xyz/"><i class="fas fa-book-open" alt="Blog"></i><span>Blog</span></a> + </li> + + <li> + <a href="https://art.luevano.xyz/"><i class="fas fa-paint-brush" alt="Art"></i><span>Art</span></a> + </li> + + <li><i class="fab fa-git" alt="Git"></i><span>Git</span> + <ul> + <li><a href="https://git.luevano.xyz/" target="_blank"><i class="fab fa-git-alt" alt="Git-alt"></i></a></li> + + <li><a href="https://github.com/luevano" target="_blank"><i class="fab fa-github" alt="Github"></i></a></li> + + <li><a href="https://gitlab.com/dluevano" target="_blank"><i class="fab fa-gitlab" alt="Gitlab"></i></a></li> + </ul> + </li> + + <li><i class="fas fa-box-open" alt="Stuff"></i><span>Stuff</span> + <ul> + <li><a href="https://gb.luevano.xyz/"><i class="fas fa-gamepad" alt="Gameboy"></i><span>Gameboy</span></a></li> + </ul> + </li> + </ul> +</nav> + +<button class="theme-switcher" onclick="toggleTheme()"><i class="fas fa-moon"></i><i class="fas fa-sun"></i></button> + + </header> + + <main> + <h1>General Godot project structure</h1> + + <p>One of my first issues when starting a project is how to structure everything. So I had to spend some time researching best practices and go with what I like the most and after trying some of them I wanted to write down somewhere what I’m sticking with.</p> +<p>The first place to look for is, of course, the official <em>Godot</em> documentation on <a href="https://docs.godotengine.org/en/stable/tutorials/best_practices/project_organization.html">Project organization</a>; along with project structure discussion, also comes with best practices for code style and what-not. I don’t like this project/directory structure that much, just because it tells you to bundle everything under the same directory but it’s a really good starting point, for example it tells you to use:</p> +<ul> +<li>/models/town/house/<ul> +<li>house.dae</li> +<li>window.png</li> +<li>door.png</li> +</ul> +</li> +</ul> +<p>Where I would prefer to have more modularity, for example:</p> +<ul> +<li>/levels/structures/town/house (or /levels/town/structures/house)<ul> +<li>window/<ul> +<li>window.x</li> +<li>window.y</li> +<li>window.z</li> +</ul> +</li> +<li>door/<ul> +<li>…</li> +</ul> +</li> +<li>house.x</li> +<li>house.y</li> +<li>house.z</li> +</ul> +</li> +</ul> +<p>It might look like it’s more work, but I prefer it like this. I wish <a href="https://www.braindead.bzh/entry/creating-a-game-with-godot-engine-ep-2-project-organization">this site</a> was still available, as I got most of my ideas from there and was a pretty good resource, but apparently the owner is not maintaining his site anymore; but there is <a href="https://www.reddit.com/r/godot/comments/7786ee/comment/dojuzuf/?utm_source=share&utm_medium=web2x&context=3">this excelent comment on reddit</a> which shows a project/directory structure more in line with what I’m currently using (and similr to the site that is down that I liked). I ended up with:</p> +<ul> +<li>/.git</li> +<li>/assets (raw assets/editable assets/asset packs)</li> +<li>/releases (executables ready to publish)</li> +<li>/src (the actual godot project)<ul> +<li>.godot/</li> +<li>actors/ (or entities)<ul> +<li>player/<ul> +<li>sprites/</li> +<li>player.x</li> +<li>…</li> +</ul> +</li> +<li>enemy/ (this could be a dir with subdirectories for each type of enemy for example…)<ul> +<li>sprites/</li> +<li>enemy.x</li> +<li>…</li> +</ul> +</li> +<li>actor.x</li> +<li>…</li> +</ul> +</li> +<li>levels/ (or scenes)<ul> +<li>common/<ul> +<li>sprites/</li> +<li>…</li> +</ul> +</li> +<li>main/<ul> +<li>…</li> +</ul> +</li> +<li>overworld/<ul> +<li>…</li> +</ul> +</li> +<li>dugeon/<ul> +<li>…</li> +</ul> +</li> +<li>Game.tscn (I’m considering the “Game” as a level/scene)</li> +<li>game.gd</li> +</ul> +</li> +<li>objects/<ul> +<li>box/<ul> +<li>…</li> +</ul> +</li> +<li>…</li> +</ul> +</li> +<li>screens/<ul> +<li>main_menu/<ul> +<li>…</li> +</ul> +</li> +<li>…</li> +</ul> +</li> +<li>globals/ (singletons/autoloads)</li> +<li>ui/<ul> +<li>menus/<ul> +<li>…</li> +</ul> +</li> +<li>…</li> +</ul> +</li> +<li>sfx/<ul> +<li>…</li> +</ul> +</li> +<li>vfx/<ul> +<li>…</li> +</ul> +</li> +<li>etc/<ul> +<li>…</li> +</ul> +</li> +<li>Main.tscn (the entry point of the game)</li> +<li>main.gd</li> +<li>icon.png (could also be on a separate “icons” directory)</li> +<li>project.godot</li> +<li>…</li> +</ul> +</li> +<li>\<any other repository related files></li> +</ul> +<p>And so on, I hope the idea is clear. I’ll probably change my mind on the long run, but for now this has been working fine.</p> + + <div class="page-nav"> + <span class="next"> + <a href="https://blog.luevano.xyz/g/flappybird_godot_devlog_1.html" alt="Next"> + <i class="fas fa-arrow-left" alt="Arrow left"></i> + <span>Next</span> + </a> + </span> + + <span class="index"> + <a href="https://blog.luevano.xyz" alt="Index"> + <i class="fas fa-home" alt="Home"></i> + <span>Index</span> + </a> + </span> + + <span class="previous"> + <a href="https://blog.luevano.xyz/g/starting_gamedev_blogging.html" alt="Previous"> + <i class="fas fa-arrow-right" alt="Arrow right"></i> + <span>Previous</span> + </a> + </span> +</div> + + + <hr> + <div class="article-info"> + <p>By David Luévano</p> + <p>Created: Sun, May 22, 2022 @ 01:16 UTC</p> + <p>Modified: Tue, May 24, 2022 @ 04:35 UTC</p> + <div class="article-tags"> + <p>Tags: +<a href="https://blog.luevano.xyz/tag/@english.html">english</a>, <a href="https://blog.luevano.xyz/tag/@gamedev.html">gamedev</a>, <a href="https://blog.luevano.xyz/tag/@short.html">short</a> </p> +</div> + + </div> + </main> + + <footer> +<span> + <i class="fas fa-address-card" alt="Contact"></i> + <a href="https://blog.luevano.xyz/contact.html">Contact</a> +</span> + +<span> + <i class="fas fa-donate" alt="Donate"></i> + <a href="https://blog.luevano.xyz/donate.html">Donate</a> +</span> + +<span> + <i class="fas fa-rss" alt="RSS"></i> + <a target="_blank" href="https://blog.luevano.xyz/rss.xml">RSS</a> +</span> + +<br> +<span class="created-with"> + <i class="fas fa-hammer" alt="Hammer"></i> + Created with <a href="https://github.com/luevano/pyssg">pyssg</a> +</span> + +<br> +<span class="copyright"> + Copyright <i class="far fa-copyright" alt="Copyright"></i> 2023 David Luévano Alvarado +</span> + + </footer> + </body> +</html>
\ No newline at end of file diff --git a/live/blog/g/gogodot_jam3_devlog_1.html b/live/blog/g/gogodot_jam3_devlog_1.html new file mode 100644 index 0000000..7d3c2d3 --- /dev/null +++ b/live/blog/g/gogodot_jam3_devlog_1.html @@ -0,0 +1,733 @@ +<!DOCTYPE html> +<html class="theme-dark" lang="en +" + prefix="og: https://ogp.me/ns#"> + <head> + <base href="https://static.luevano.xyz"> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="icon" href="images/icons/favicon.ico"> +<title>Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1 -- Luevano's Blog</title> + <meta name="description" content="Details on the implementation for the game I created for the Go Godot Jam 3, which theme is Evolution."/> +<link rel="alternate" type="application/rss+xml" href="https://blog.luevano.xyz/rss.xml" title="Luevano's Blog RSS"> + <!-- general style --> + <link rel="stylesheet" type="text/css" href="css/style.css"> + <link rel="stylesheet" type="text/css" href="fork-awesome/css/fork-awesome.min.css"> + <link rel="stylesheet" type="text/css" href="font-awesome/css/all.min.css"> + <!-- theme related --> + <script type="text/javascript" src="scripts/theme.js"></script> + <link id="theme-css" rel="stylesheet" type="text/css" href="css/theme.css"> + <!-- extra --> +<!-- highlight support for code blocks --> +<script type="text/javascript" src="hl/highlight.min.js"></script> +<script type="text/javascript"> + hljs.initHighlightingOnLoad(); +</script> +<link id="code-theme-css" rel="stylesheet" type="text/css" href="hl/styles/nord.min.css"> + + <!-- og meta --> + <meta property="og:title" content="Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1 -- Luevano's Blog"/> + <meta property="og:type" content="article"/> + <meta property="og:url" content="https://blog.luevano.xyz/g/gogodot_jam3_devlog_1.md"/> + <meta property="og:image" content="https://static.luevano.xyz/images/b/default.png"/> + <meta property="og:description" content="Details on the implementation for the game I created for the Go Godot Jam 3, which theme is Evolution."/> + <meta property="og:locale" content="en"/> + <meta property="og:site_name" content="Luevano's Blog"/> + </head> + + <body> + <header> +<nav> + <ul> + <li> + <a href="https://luevano.xyz/"><i class="fas fa-home" alt="Home"></i><span>Home</span></a> + </li> + + <li> + <a href="https://blog.luevano.xyz/"><i class="fas fa-book-open" alt="Blog"></i><span>Blog</span></a> + </li> + + <li> + <a href="https://art.luevano.xyz/"><i class="fas fa-paint-brush" alt="Art"></i><span>Art</span></a> + </li> + + <li><i class="fab fa-git" alt="Git"></i><span>Git</span> + <ul> + <li><a href="https://git.luevano.xyz/" target="_blank"><i class="fab fa-git-alt" alt="Git-alt"></i></a></li> + + <li><a href="https://github.com/luevano" target="_blank"><i class="fab fa-github" alt="Github"></i></a></li> + + <li><a href="https://gitlab.com/dluevano" target="_blank"><i class="fab fa-gitlab" alt="Gitlab"></i></a></li> + </ul> + </li> + + <li><i class="fas fa-box-open" alt="Stuff"></i><span>Stuff</span> + <ul> + <li><a href="https://gb.luevano.xyz/"><i class="fas fa-gamepad" alt="Gameboy"></i><span>Gameboy</span></a></li> + </ul> + </li> + </ul> +</nav> + +<button class="theme-switcher" onclick="toggleTheme()"><i class="fas fa-moon"></i><i class="fas fa-sun"></i></button> + + </header> + + <main> + <h1>Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1</h1> + + <p>The jam’s theme is Evolution and all the details are listed <a href="https://itch.io/jam/go-godot-jam-3">here</a>. <del>This time I’m logging as I go, so there might be some changes to the script or scenes along the way</del> <ins>I couldn’t actually do this, as I was running out of time.</ins>. Note that I’m not going to go into much details, the obvious will be ommitted.</p> +<p>I wanted to do a <em>Snake</em> clone, and I’m using this jam as an excuse to do it and add something to it. The features include:</p> +<ul> +<li>Snakes will pass their stats in some form to the next snakes.</li> +<li>Non-grid snake movement. I just hate the grid constraint, so I wanted to make it move in any direction.</li> +<li>Depending on the food you eat, you’ll gain new mutations/abilities <del>and the more you eat the more that mutation develops.</del> <ins>didn’t have time to add this feature, sad.</ins></li> +<li>Procedural map creation.</li> +</ul> +<p>I created this game using <em>Godot 3.5-rc3</em>. You can find the source code in my GitHub <a href="https://github.com/luevano/gogodot_jam3">here</a> 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:</p> +<p style="text-align:center"><iframe src="https://itch.io/embed/1562701?dark=true" width="552" height="167" frameborder="0"><a href="https://lorentzeus.itch.io/snake-tronic">Snake-tronic by Lorentzeus</a></iframe></p> + +<p>You can also find the jam entry <a href="https://itch.io/jam/go-godot-jam-3/rate/1562701">here</a>.</p> +<p>Similarly with the my FlappyBird clone, I plan to update this to a better state.</p> +<h2 id="initial-setup">Initial setup</h2> +<p>Again, similar to the <a href="https://blog.luevano.xyz/g/flappybird_godot_devlog_1.html">FlappyBird</a> clone I developed, I’m using the directory structure I wrote about on <a href="https://blog.luevano.xyz/g/godot_project_structure.html">Godot project structure</a> with slight modifications to test things out. Also using similar <em>Project settings</em> as those from the <em>FlappyBird</em> clone like the pixel art texture imports, keybindings, layers, etc..</p> +<p>I’ve also setup <a href="https://github.com/bram-dingelstad/godot-gifmaker">GifMaker</a>, with slight modifications as the <em>AssetLib</em> doesn’t install it correctly and contains unnecessry stuff: moved necessary files to the <code>res://addons</code> directory, deleted test scenes and files in general, and copied the license to the <code>res://docs</code> 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.<ins>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.</ins></p> +<p>This time I’m also going to be using an <a href="https://www.gdquest.com/docs/guidelines/best-practices/godot-gdscript/event-bus/">Event bus</a> singleton (which I’m going to just call <em>Event</em>) as managing signals was pretty annoying on my last project; as well as a <em>Global</em> singleton for essential stuff so I don’t have to do as many cross references between nodes/scenes.</p> +<h2 id="assets">Assets</h2> +<p>This time I’ll be creating my own assets in <a href="https://www.aseprite.org/">Aseprite</a>, wont be that good, but enough to prototype and get things going.</p> +<p>Other than that I used few key sprites from <a href="https://vryell.itch.io/">vryell</a>: <a href="https://vryell.itch.io/controller-keyboard-icons">Controller & Keyboard Icons</a> and a font from <a href="https://datagoblin.itch.io/">datagoblin</a>: <a href="https://datagoblin.itch.io/monogram">Monogram</a>.</p> +<h2 id="the-snake">The snake</h2> +<p>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:</p> +<figure id="__yafg-figure-32"> +<img alt="FileSystem - Snake dir structure" src="images/g/gogodot_jam3/file_system_snake_dir_structure.png" title="FileSystem - Snake dir structure"> +<figcaption>FileSystem - Snake dir structure</figcaption> +</figure> +<h3 id="basic-movement">Basic movement</h3> +<p>The most basic thing is to move the head, this is what we have control of. Create a scene called <code>Head.tscn</code> and setup the basic <em>KinematicBody2D</em> with it’s own <em>Sprite</em> and <em>CollisionShape2D</em> (I used a small circle for the tip of the head), and set the <em>Collision Layer/Mask</em> accordingly, for now just <code>layer = bit 1</code>. 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 <code>head.gd</code> attached to the root (<em>KinematicBody2D</em>) and added:</p> +<pre><code class="language-gdscript">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())) +</code></pre> +<p>After tunning all the necessary parameters you should get something like this:</p> +<figure id="__yafg-figure-33"> +<img alt="Snake - Basic movement (left and right controls)" src="images/g/gogodot_jam3/snake_basic_movement.gif" title="Snake - Basic movement (left and right controls)"> +<figcaption>Snake - Basic movement (left and right controls)</figcaption> +</figure> +<h3 id="setting-up-path-following">Setting up path following</h3> +<p>To move other snake parts by following the snake head the only solution I found was to use the <em>Path2D</em> and <em>PathFollow2D</em> nodes. <em>Path2D</em> basically just handles the curve/path that <em>PathFollow2D</em> will use to move its child node; and I say “child node” in singular… as <em>PathFollow2D</em> 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.</p> +<p>Added the signal <code>snake_path_new_point(coordinates)</code> to the <em>Event</em> singleton and then add the following to <code>head.gd</code>:</p> +<pre><code class="language-gdscript">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 +</code></pre> +<p>This will be pinging the current snake head position every <code>0.01</code> seconds (defined in <em>Global</em>). Now create a new scene called <code>Snake.tscn</code> which will contain a <em>Node2D</em>, a <em>Path2D</em> and an instance of <em>Head</em> as its childs. Create a new script called <code>snake.gd</code> attached to the root (<em>Node2D</em>) with the following content:</p> +<pre><code class="language-gdscript">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() +</code></pre> +<p>With this, we’re now populating the <em>Path2D</em> curve points with the position of the snake head. You should be able to see it because of the <code>_draw</code> call. If you run it you should see something like this:</p> +<figure id="__yafg-figure-34"> +<img alt="Snake - Basic movement with path" src="images/g/gogodot_jam3/snake_basic_movement_with_path.gif" title="Snake - Basic movement with path"> +<figcaption>Snake - Basic movement with path</figcaption> +</figure> +<h3 id="define-body-parts-for-the-snake">Define body parts for the snake</h3> +<p>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 <em>PathFollow2D</em> to use the live-generating <em>Path2D</em>, the only caveat is that we need one of these per body part/tail (this took me hours to figure out, <em>thanks documentation</em>).</p> +<p>Create a new scene called <code>Body.tscn</code> with a <em>PathFollow2D</em> as its root and an <em>Area2D</em> as its child, then just add the necessary <em>Sprite</em> and <em>CollisionShap2D</em> for the <em>Area2D</em>, I’m using <code>layer = bit 2</code> for its collision. Create a new script called <code>generic_segment.gd</code> with the following code:</p> +<pre><code class="language-gdscript">extends PathFollow2D + +export(String, "body", "tail") var TYPE: String = "body" + + +func _physics_process(delta: float) -> void: + offset += Global.SNAKE_SPEED * delta +</code></pre> +<p>And this can be attached to the <em>Body</em>‘s root node (<em>PathFollow2D</em>), no extra setup needed. Repeat the same steps for creating the <code>Tail.tscn</code> scene and when attaching the <code>generic_segment.gd</code> script just configure the <code>Type</code> parameter to <code>tail</code> in the GUI (by selecting the node with the script attached and editing in the <em>Inspector</em>).</p> +<h3 id="adding-body-parts">Adding body parts</h3> +<p>Now it’s just a matter of handling when to add new body parts in the <code>snake.gd</code> 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:</p> +<pre><code class="language-gdscript">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) +</code></pre> +<p>Select the <em>Snake</em> node and add the <em>Body</em> and <em>Tail</em> scene to the parameters, respectively. Then when running you should see something like this:</p> +<figure id="__yafg-figure-35"> +<img alt="Snake - Basic movement with all body parts" src="images/g/gogodot_jam3/snake_basic_movement_added_body_parts.gif" title="Snake - Basic movement with all body parts"> +<figcaption>Snake - Basic movement with all body parts</figcaption> +</figure> +<p>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: <code>snake_adding_new_segment(type)</code>, <code>snake_added_new_segment(type)</code>, <code>snake_added_initial_segments</code> and use them when makes sense. Now we need to add the following:</p> +<pre><code class="language-gdscript">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 +</code></pre> +<p>As well as updating <code>_add_initial_segment</code> with the following so it adds the new segment on the specific variable:</p> +<pre><code class="language-gdscript">if _temp_body_segment.TYPE == "body": + body_segment_stack.append(_temp_body_segment) +else: + tail_segment = _temp_body_segment +</code></pre> +<p>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:</p> +<pre><code class="language-gdscript"># 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) +</code></pre> +<p>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:</p> +<figure id="__yafg-figure-36"> +<img alt="Snake - Basic movement with dynamic addition of new segments" src="images/g/gogodot_jam3/snake_basic_movement_with_dynamic_segments.gif" title="Snake - Basic movement with dynamic addition of new segments"> +<figcaption>Snake - Basic movement with dynamic addition of new segments</figcaption> +</figure> +<p>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 <code>snake_segment_body_entered(body)</code>) in a <code>main.gd</code> script that is the entry point for the game:</p> +<pre><code class="language-gdscript">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]) +</code></pre> +<p>Which will stop the snake node and all children.</p> +<h3 id="fix-on-body-segments-following-head">Fix on body segments following head</h3> +<p>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 <em>Curve2D</em> is. To do this I just send a signal (<code>snake_rotated</code>) whenever the snake rotates and make a small correction (in <code>generic_segment.gd</code>):</p> +<pre><code class="language-gdscript">func _on_snake_rotated() -> void: + offset -= 0.75 * Global.SNAKE_SPEED * pow(get_physics_process_delta_time(), 2) +</code></pre> +<p>This is completely random, I tweaked it manually after a lot of iterations.</p> +<h2 id="the-food">The food</h2> +<p>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: <code>food_placing_new_food(type)</code>, <code>food_placed_new_food(type)</code> and <code>food_eaten(type)</code>.</p> +<p>First thing is creating the <code>Food.tscn</code> which is just an <em>Area2D</em> with its necessary children with an attached script called <code>food.gd</code>. The script is really simple:</p> +<pre><code class="language-gdscript">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() +</code></pre> +<p>Then this <code>food_eaten</code> signal is received in <code>snake.gd</code> to add a new segment to the queue.</p> +<p>Finally, for the food manager I just created a <code>FoodManager.tscn</code> with a <em>Node2D</em> with an attached script called <code>food_manager.gd</code>. To get a random position:</p> +<pre><code class="language-gdscript">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) +</code></pre> +<p>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:</p> +<pre><code class="language-gdscript">func _place_new_food() -> void: + var food: Area2D = FOOD.instance() + var position: Vector2 = _get_random_pos() + food.global_position = position + add_child(food) +</code></pre> +<p>And this is used in <code>_process</code> 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:</p> +<figure id="__yafg-figure-37"> +<img alt="Snake - Food basic interaction" src="images/g/gogodot_jam3/snake_food_basic_interaction.gif" title="Snake - Food basic interaction"> +<figcaption>Snake - Food basic interaction</figcaption> +</figure> +<h2 id="za-warudo-the-world">Za warudo! (The world)</h2> +<p>It just happend that I saw a video to create random maps by using a method called <a href="https://www.mit.edu/~kardar/teaching/projects/chemotaxis(AndreaSchmidt)/random.htm">random walks</a>, this video was made by <a href="https://www.youtube.com/c/NADLABS">NAD LABS</a>: <a href="https://www.youtube.com/watch?v=ppP2Doq3p7s">Nuclear Throne Like Map Generation In Godot</a>. 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):</p> +<figure id="__yafg-figure-38"> +<img alt="World map generator - Random map 1" src="images/g/gogodot_jam3/world_generator_1.png" title="World map generator - Random map 1"> +<figcaption>World map generator - Random map 1</figcaption> +</figure> +<figure id="__yafg-figure-39"> +<img alt="World map generator - Random map 2" src="images/g/gogodot_jam3/world_generator_2.png" title="World map generator - Random map 2"> +<figcaption>World map generator - Random map 2</figcaption> +</figure> +<figure id="__yafg-figure-40"> +<img alt="World map generator - Random map 3" src="images/g/gogodot_jam3/world_generator_3.png" title="World map generator - Random map 3"> +<figcaption>World map generator - Random map 3</figcaption> +</figure> +<p>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 <em>NAD LABS</em>‘ 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:</p> +<pre><code class="language-gdscript">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 +</code></pre> +<p>Where <code>get_cells_around</code> is just a function that gets the safe cells around the origin. And this <code>get_valid_map_coords</code> just returns used cells minus the safe cells, to place food. <code>get_centered_world_position</code> is so we can center the food in the tiles.</p> +<p>Some signals I used for the world gen: <code>world_gen_walker_started(id)</code>, <code>world_gen_walker_finished(id)</code>, <code>world_gen_walker_died(id)</code> and <code>world_gen_spawn_walker_unit(location)</code>.</p> +<h3 id="food-placement">Food placement</h3> +<p>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.</p> +<p>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:</p> +<pre><code class="language-gdscript">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() +</code></pre> +<p>Where the <code>update_texture</code> 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.</p> +<p>Then basic/special food just extend base food, define a <code>Type</code> enum and preloads the necessary textures, for example:</p> +<pre><code class="language-gdscript">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") +</code></pre> +<p>Now, some of the most important change to <code>food_manager.gd</code> is to get an actual random valid position:</p> +<pre><code class="language-gdscript">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] +</code></pre> +<p>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: <code>food_placing_new_food(type)</code>, <code>food_placed_new_food(type, location)</code> and <code>food_eaten(type, location)</code>.</p> +<h2 id="stats-clas-and-loadingsaving-data">Stats clas and loading/saving data</h2> +<p>I got the idea of saving the current stats (points, max body segments, etc.) in a separate <em>Stats</em> 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 <code>tres</code> files).</p> +<h3 id="stats-class">Stats class</h3> +<p>The <em>Stats</em> “class” is just a script that extends from <em>Node</em> called <code>stats.gd</code>. It needs to define the <code>class_name</code> as <code>Stats</code>. The main content:</p> +<pre><code class="language-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 +</code></pre> +<p>And with the ugliest functions:</p> +<pre><code class="language-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"] +</code></pre> +<p>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.</p> +<h3 id="loadsave-data">Load/save data</h3> +<p>The load/save function is pretty standard. It’s a singleton/autoload called <em>SavedData</em> with a script that extends from <em>Node</em> called <code>save_data.gd</code>:</p> +<pre><code class="language-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() +</code></pre> +<p>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 (<em>Stats</em> class related issues).</p> +<h2 id="scoring">Scoring</h2> +<p>For this I created a scoring mechanisms and just called it <em>ScoreManager</em> (<code>score_manager.gd</code>) which just basically listens to <code>food_eaten</code> signal and adds points accordingly to the current <em>Stats</em> object loaded. The main function is:</p> +<pre><code class="language-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) +</code></pre> +<p>Where the most important function is:</p> +<pre><code class="language-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 +</code></pre> +<p>Which will add the necessary points to <code>Stats.points</code> and return the amount of new snake segments to grow. After this <code>_spawn_added_score_segment</code> and <code>_spawn_added_segment_text</code> just spawn a <em>Label</em> with the info on the points/segments gained; this is custom UI I created, nothing fancy.</p> +<p>Last thing is taht in <code>_process_points</code> 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.</p> +<p>This <em>ScoreManager</em> also handles the calculation for the <code>game_over</code> signal, to calculte progress, set necessary <em>Stats</em> values and save the data:</p> +<pre><code class="language-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 +</code></pre> +<p>Then this sends a signal <code>display_stats</code> to activate UI elements that shows the progression.</p> +<p>Naturally, the saved <em>Stats</em> are loaded whenever needed. For example, for the <em>Snake</em>, 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 <em>Stats</em> at the end, then on restart we load the updated one.</p> +<h2 id="snake-redesigned-with-the-state-machine-pattern">Snake redesigned with the state machine pattern</h2> +<p>I redesigned the snake code (the head, actually) to use the state machine pattern by following <a href="https://gdscript.com/solutions/godot-state-machine/">this guide</a> which is definitely a great guide, straight to the point and easy to implement.</p> +<p>Other than what is shown in the guide, I implemented some important functions in the <code>state_machine.gd</code> script itself, to be used by each of the states as needed:</p> +<pre><code class="language-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") +</code></pre> +<p>And then in the <em>StateMachine</em>‘s <code>_process</code>:</p> +<pre><code class="language-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) +</code></pre> +<p>And now it’s just a matter of implementing the necessary states. I used 4: <code>normal_stage.gd</code>, <code>slow_state.gd</code>, <code>dash_state.gd</code> and <code>jump_state.gd</code>.</p> +<p>The <code>normal_state.gd</code> contains what the original <code>head.gd</code> code contained:</p> +<pre><code class="language-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") +</code></pre> +<p>Here, the <code>exit</code> method is basically to change to the next state. And lastly, I’m only gonna show the <code>dash_state.gd</code> as the other ones are pretty similar:</p> +<pre><code class="language-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) +</code></pre> +<p>Where the important parts happen in the <code>enter</code> and <code>exit</code> functions. We need to change the <code>Global.SNAKE_SPEED</code> with the <code>Global.SNAKE_DASH_SPEED</code> on <code>start</code>and start the timer for how long should the dash last. And on the <code>exit</code> we reset the <code>Global.SNAKE_SPEED</code> back to normal. There is probably a better way of updating the <code>Global.SNAKE_SPEED</code> but this works just fine.</p> +<p>For the other ones is the same. Only difference with the <code>jump_state.gd</code> is that the collision from head to body is disabled, and no rotation is allowed (by not calling the <code>rotate_on_input</code> function).</p> +<h2 id="other-minor-stuff">Other minor stuff</h2> +<p>Not as important but worth mentioning:</p> +<ul> +<li>Added restartability function.</li> +<li>Added signals for game control: <code>game_over</code> and <code>game_start</code>, but ended not using them.</li> +<li>Fixed issue where the <em>Curve2D</em> stayed the same even when restarting by just setting an empty curve on starting the node.</li> +<li>Added a debug mode for drawing of the <em>Curve2D</em> instead of always drawing.</li> +<li>Tweaked the tracking of the snake size.</li> +<li>Tweaked the food system to contain more attributes and use a base food node.</li> +<li>Added a HUD with mini snake sprites.</li> +<li>Added a HUD for growth progress on snake body segments and abilities.</li> +<li>Refactored the nodes to make it work with <code>change_scene_to</code>, and added a main menu.</li> +<li>Added GUI for dead screen, showing the progress.</li> +</ul> +<h2 id="final-notes">Final notes</h2> +<p>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.</p> +<p>For exporting and everything else, I went with what I did for my <a href="https://blog.luevano.xyz/g/flappybird_godot_devlog_1#final-notes-and-exporting">FlappyBird Godot clone</a></p> + + <div class="page-nav"> + + <span class="index"> + <a href="https://blog.luevano.xyz" alt="Index"> + <i class="fas fa-home" alt="Home"></i> + <span>Index</span> + </a> + </span> + + <span class="previous"> + <a href="https://blog.luevano.xyz/g/flappybird_godot_devlog_1.html" alt="Previous"> + <i class="fas fa-arrow-right" alt="Arrow right"></i> + <span>Previous</span> + </a> + </span> +</div> + + + <hr> + <div class="article-info"> + <p>By David Luévano</p> + <p>Created: Fri, Jun 10, 2022 @ 09:17 UTC</p> + <div class="article-tags"> + <p>Tags: +<a href="https://blog.luevano.xyz/tag/@english.html">english</a>, <a href="https://blog.luevano.xyz/tag/@gamedev.html">gamedev</a>, <a href="https://blog.luevano.xyz/tag/@gamejam.html">gamejam</a>, <a href="https://blog.luevano.xyz/tag/@godot.html">godot</a> </p> +</div> + + </div> + </main> + + <footer> +<span> + <i class="fas fa-address-card" alt="Contact"></i> + <a href="https://blog.luevano.xyz/contact.html">Contact</a> +</span> + +<span> + <i class="fas fa-donate" alt="Donate"></i> + <a href="https://blog.luevano.xyz/donate.html">Donate</a> +</span> + +<span> + <i class="fas fa-rss" alt="RSS"></i> + <a target="_blank" href="https://blog.luevano.xyz/rss.xml">RSS</a> +</span> + +<br> +<span class="created-with"> + <i class="fas fa-hammer" alt="Hammer"></i> + Created with <a href="https://github.com/luevano/pyssg">pyssg</a> +</span> + +<br> +<span class="copyright"> + Copyright <i class="far fa-copyright" alt="Copyright"></i> 2023 David Luévano Alvarado +</span> + + </footer> + </body> +</html>
\ No newline at end of file diff --git a/live/blog/g/starting_gamedev_blogging.html b/live/blog/g/starting_gamedev_blogging.html new file mode 100644 index 0000000..770be0f --- /dev/null +++ b/live/blog/g/starting_gamedev_blogging.html @@ -0,0 +1,149 @@ +<!DOCTYPE html> +<html class="theme-dark" lang="en +" + prefix="og: https://ogp.me/ns#"> + <head> + <base href="https://static.luevano.xyz"> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <link rel="icon" href="images/icons/favicon.ico"> +<title>Will start blogging about gamedev -- Luevano's Blog</title> + <meta name="description" content="Since I'm starting to get more into gamedev stuff, I'll start blogging about it just to keep consistent."/> +<link rel="alternate" type="application/rss+xml" href="https://blog.luevano.xyz/rss.xml" title="Luevano's Blog RSS"> + <!-- general style --> + <link rel="stylesheet" type="text/css" href="css/style.css"> + <link rel="stylesheet" type="text/css" href="fork-awesome/css/fork-awesome.min.css"> + <link rel="stylesheet" type="text/css" href="font-awesome/css/all.min.css"> + <!-- theme related --> + <script type="text/javascript" src="scripts/theme.js"></script> + <link id="theme-css" rel="stylesheet" type="text/css" href="css/theme.css"> + <!-- extra --> +<!-- highlight support for code blocks --> +<script type="text/javascript" src="hl/highlight.min.js"></script> +<script type="text/javascript"> + hljs.initHighlightingOnLoad(); +</script> +<link id="code-theme-css" rel="stylesheet" type="text/css" href="hl/styles/nord.min.css"> + + <!-- og meta --> + <meta property="og:title" content="Will start blogging about gamedev -- Luevano's Blog"/> + <meta property="og:type" content="article"/> + <meta property="og:url" content="https://blog.luevano.xyz/g/starting_gamedev_blogging.md"/> + <meta property="og:image" content="https://static.luevano.xyz/images/b/default.png"/> + <meta property="og:description" content="Since I'm starting to get more into gamedev stuff, I'll start blogging about it just to keep consistent."/> + <meta property="og:locale" content="en"/> + <meta property="og:site_name" content="Luevano's Blog"/> + </head> + + <body> + <header> +<nav> + <ul> + <li> + <a href="https://luevano.xyz/"><i class="fas fa-home" alt="Home"></i><span>Home</span></a> + </li> + + <li> + <a href="https://blog.luevano.xyz/"><i class="fas fa-book-open" alt="Blog"></i><span>Blog</span></a> + </li> + + <li> + <a href="https://art.luevano.xyz/"><i class="fas fa-paint-brush" alt="Art"></i><span>Art</span></a> + </li> + + <li><i class="fab fa-git" alt="Git"></i><span>Git</span> + <ul> + <li><a href="https://git.luevano.xyz/" target="_blank"><i class="fab fa-git-alt" alt="Git-alt"></i></a></li> + + <li><a href="https://github.com/luevano" target="_blank"><i class="fab fa-github" alt="Github"></i></a></li> + + <li><a href="https://gitlab.com/dluevano" target="_blank"><i class="fab fa-gitlab" alt="Gitlab"></i></a></li> + </ul> + </li> + + <li><i class="fas fa-box-open" alt="Stuff"></i><span>Stuff</span> + <ul> + <li><a href="https://gb.luevano.xyz/"><i class="fas fa-gamepad" alt="Gameboy"></i><span>Gameboy</span></a></li> + </ul> + </li> + </ul> +</nav> + +<button class="theme-switcher" onclick="toggleTheme()"><i class="fas fa-moon"></i><i class="fas fa-sun"></i></button> + + </header> + + <main> + <h1>Will start blogging about gamedev</h1> + + <p>I’ve been wanting to get into gamedev for a while now, but it’s always a pain to stay consistent. I just recently started to get into gamedev again, and this time I’m trying to actually do stuff.</p> +<p>So, the plan is to blog about my progress and clone some simple games just to get started. I’m thinking on sticking with <a href="https://godotengine.org/">Godot</a> just because I like that it’s open source, it’s getting better and better overtime (big rewrite happening right now) and I already like how the engine works. <del>Specifically I’ll start using <em>Godot 4</em> even though it’s not done yet, to get used to the new features, specifically pumped for <a href="https://godotengine.org/article/gdscript-progress-report-feature-complete-40">GDScript 2.0</a>.</del> <ins>Actually… (for the small clones/ripoffs) I’ll need to use <em>Godot 3.X</em> (probably 3.5), as <em>Godot 4</em> doesn’t have support to export to webassembly (HTML5) yet, and I want that to publish to <a href="https://itch.io/">itch.io</a> and my website. I’ll continue to use <em>Godot 4</em> for bigger projects, as they will take longer and I hope that by the time I need to publish, there’s no issues to export.</ins></p> +<p>For a moment I almost started a new subdomain just for gamedev stuff, but decided to just use a different directory for subtleness; this directory and use of tags should be enough. I’ll be posting the entry about the first rip-off I’m <em>developing</em> (FlappyBird L O L) shortly.</p> + + <div class="page-nav"> + <span class="next"> + <a href="https://blog.luevano.xyz/g/godot_project_structure.html" alt="Next"> + <i class="fas fa-arrow-left" alt="Arrow left"></i> + <span>Next</span> + </a> + </span> + + <span class="index"> + <a href="https://blog.luevano.xyz" alt="Index"> + <i class="fas fa-home" alt="Home"></i> + <span>Index</span> + </a> + </span> + + <span class="previous"> + <a href="https://blog.luevano.xyz/a/password_manager_authenticator_setup.html" alt="Previous"> + <i class="fas fa-arrow-right" alt="Arrow right"></i> + <span>Previous</span> + </a> + </span> +</div> + + + <hr> + <div class="article-info"> + <p>By David Luévano</p> + <p>Created: Tue, May 17, 2022 @ 05:19 UTC</p> + <p>Modified: Sun, May 22, 2022 @ 00:27 UTC</p> + <div class="article-tags"> + <p>Tags: +<a href="https://blog.luevano.xyz/tag/@english.html">english</a>, <a href="https://blog.luevano.xyz/tag/@gamedev.html">gamedev</a>, <a href="https://blog.luevano.xyz/tag/@short.html">short</a>, <a href="https://blog.luevano.xyz/tag/@update.html">update</a> </p> +</div> + + </div> + </main> + + <footer> +<span> + <i class="fas fa-address-card" alt="Contact"></i> + <a href="https://blog.luevano.xyz/contact.html">Contact</a> +</span> + +<span> + <i class="fas fa-donate" alt="Donate"></i> + <a href="https://blog.luevano.xyz/donate.html">Donate</a> +</span> + +<span> + <i class="fas fa-rss" alt="RSS"></i> + <a target="_blank" href="https://blog.luevano.xyz/rss.xml">RSS</a> +</span> + +<br> +<span class="created-with"> + <i class="fas fa-hammer" alt="Hammer"></i> + Created with <a href="https://github.com/luevano/pyssg">pyssg</a> +</span> + +<br> +<span class="copyright"> + Copyright <i class="far fa-copyright" alt="Copyright"></i> 2023 David Luévano Alvarado +</span> + + </footer> + </body> +</html>
\ No newline at end of file |