diff options
| author | David Luevano Alvarado <david@luevano.xyz> | 2023-05-05 03:16:06 -0600 |
|---|---|---|
| committer | David Luevano Alvarado <david@luevano.xyz> | 2023-05-05 03:16:06 -0600 |
| commit | 70e783628b1bf863da45cc8879b06288a498840b (patch) | |
| tree | 6a61d3134fbb100f0fc04e9e96782d29e24bb5ed /src | |
| parent | ec2aa74d36670d74c153aa0022ab22e79502a061 (diff) | |
update css, make articles more uniform, add toc and add functionality to scroll to the top
Diffstat (limited to 'src')
| -rw-r--r-- | src/art/a/hand_sketches.md | 2 | ||||
| -rw-r--r-- | src/blog/a/acomodada_la_pagina_de_arte.md | 2 | ||||
| -rw-r--r-- | src/blog/a/asi_nomas_esta_quedando.md | 4 | ||||
| -rw-r--r-- | src/blog/a/el_blog_ya_tiene_timestamps.md | 7 | ||||
| -rw-r--r-- | src/blog/a/first_blog_post.md | 6 | ||||
| -rw-r--r-- | src/blog/a/git_server_with_cgit.md | 24 | ||||
| -rw-r--r-- | src/blog/a/mail_server_with_postfix.md | 45 | ||||
| -rw-r--r-- | src/blog/a/new_blogging_system.md | 6 | ||||
| -rw-r--r-- | src/blog/a/password_manager_authenticator_setup.md | 2 | ||||
| -rw-r--r-- | src/blog/a/rewrote_pyssg_again.md | 4 | ||||
| -rw-r--r-- | src/blog/a/tenia_esto_descuidado.md | 8 | ||||
| -rw-r--r-- | src/blog/a/volviendo_a_usar_la_pagina.md | 4 | ||||
| -rw-r--r-- | src/blog/a/vpn_server_with_openvpn.md | 25 | ||||
| -rw-r--r-- | src/blog/a/website_with_nginx.md | 27 | ||||
| -rw-r--r-- | src/blog/a/xmpp_server_with_prosody.md | 39 | ||||
| -rw-r--r-- | src/blog/g/flappybird_godot_devlog_1.md | 242 | ||||
| -rw-r--r-- | src/blog/g/godot_project_structure.md | 1 | ||||
| -rw-r--r-- | src/blog/g/gogodot_jam3_devlog_1.md | 93 | ||||
| -rw-r--r-- | src/blog/g/starting_gamedev_blogging.md | 7 |
19 files changed, 300 insertions, 248 deletions
diff --git a/src/art/a/hand_sketches.md b/src/art/a/hand_sketches.md index fb6d02b..e9dec11 100644 --- a/src/art/a/hand_sketches.md +++ b/src/art/a/hand_sketches.md @@ -12,6 +12,6 @@ Me dibujé la mano varias veces con un pincel que me encontré de Krita muy buen Según yo probé "métodos" (y como dos-tres pinceles) diferentes, pero realmente están muy similares en "procedimiento". Igual quedé conforme con el resultado. -Ahora con el anuncio del ???Elden Ring??? se antojó hacerse un dibujo relacionado, pero aún no sé qué ni cómo, pero quizá me eche algo así. +Ahora con el anuncio del ==Elden Ring== se antojó hacerse un dibujo relacionado, pero aún no sé qué ni cómo, pero quizá me eche algo así. Pues ahí mero. Y por cierto que muchas gracias a quien me donó hace unos días por el dibujo pasado, se aprecia mi bro. diff --git a/src/blog/a/acomodada_la_pagina_de_arte.md b/src/blog/a/acomodada_la_pagina_de_arte.md index 2cac170..9321efb 100644 --- a/src/blog/a/acomodada_la_pagina_de_arte.md +++ b/src/blog/a/acomodada_la_pagina_de_arte.md @@ -8,6 +8,6 @@ tags: short Así es, ya quedó acomodado el sub-dominio `art.luevano.xyz` pos pal [arte](https://art.luevano.xyz) veda. Entonces pues ando feliz por eso. -Este pedo fue gracias a que me reescribí la forma en la que `pyssg` maneja los templates, ahora uso el sistema de `jinja` en vez del cochinero que hacía antes. +Este pedo fue gracias a que me reescribí la forma en la que [`pyssg`](${PYSSG_URL}) maneja los templates, ahora uso el sistema de [`jinja`](https://jinja.palletsprojects.com/en/3.1.x/) en vez del cochinero que hacía antes. Y pues nada más eso, aquí está el [primer post](https://art.luevano.xyz/a/elephant_octopus.html) y por supuesto acá está el link del RSS [https://art.luevano.xyz/rss.xml](https://art.luevano.xyz/rss.xml). diff --git a/src/blog/a/asi_nomas_esta_quedando.md b/src/blog/a/asi_nomas_esta_quedando.md index c1ed74c..6577ca8 100644 --- a/src/blog/a/asi_nomas_esta_quedando.md +++ b/src/blog/a/asi_nomas_esta_quedando.md @@ -12,6 +12,8 @@ También me puse a acomodar un servidor de [XMPP](https://xmpp.org/) el cual, en Ahorita este server es SUMISO (*compliant* en español, jeje) para jalar con la app [conversations](https://conversations.im/) y con la red social [movim](https://movim.eu/), pero realmente funcionaría con casi cualquier cliente de XMPP, amenos que ese cliente implemente algo que no tiene mi server. Y también acomodé un server de [Matrix](https://matrix.org/) que es muy similar pero es bajo otro protocolo y se siente más como un discord/slack (al menos en el [element](https://element.io/)), muy chingón también. -Si bien aún quedan cosas por hacer sobre estos dos servers que me acomodé (además de hacerles unas entradas para documentar cómo lo hice), quiero moverme a otra cosa que sería acomodar una sección de dibujos, lo cual en teoría es bien sencillo, pero como quiero poder automatizar la publicación de estos, quiero modificar un poco el [pyssg](https://github.com/luevano/pyssg) para que jale chido para este pex. +Si bien aún quedan cosas por hacer sobre estos dos servers que me acomodé (además de hacerles unas entradas para documentar cómo lo hice), quiero moverme a otra cosa que sería acomodar una sección de dibujos, lo cual en teoría es bien sencillo, pero como quiero poder automatizar la publicación de estos, quiero modificar un poco el [`pyssg`](${PYSSG_URL}) para que jale chido para este pex. Ya por último también quiero moverle un poco al CSS, porque lo dejé en un estado muy culerón y quiero meterle/ajustar unas cosas para que quede más limpio y medianamente bonito... *dentro de lo que cabe porque evidentemente me vale verga si se ve como una página del 2000*. + +**Actualización**: Ya tumbé el servidor de XMPP porque consumía bastantes recursos y no lo usaba tanto, si en un futuro consigo un mejor servidor podría volver a hostearlo.
\ No newline at end of file diff --git a/src/blog/a/el_blog_ya_tiene_timestamps.md b/src/blog/a/el_blog_ya_tiene_timestamps.md index 4fbe9bd..b011732 100644 --- a/src/blog/a/el_blog_ya_tiene_timestamps.md +++ b/src/blog/a/el_blog_ya_tiene_timestamps.md @@ -11,6 +11,9 @@ Pues eso, esta entrada es sólo para tirar update sobre mi [primer post](https:/ Ya lo único que queda es cambiar un poco el formato del blog (y de la página en general), porque en un momento de desesperación puse todo el texto en justificado y pues no se ve chido siempre, entonces queda corregir eso. *Y aunque me tomó más tiempo del que quisiera, así nomás quedó, diría un cierto personaje.* -El `ssg` modificado está en mis [dotfiles](https://git.luevano.xyz/.dots) (o directamente [aquí](https://git.luevano.xyz/.dots/tree/.local/bin/ssg)). +~~El `ssg` modificado está en mis [dotfiles](https://git.luevano.xyz/.dots) (o directamente [aquí](https://git.luevano.xyz/.dots/tree/.local/bin/ssg)).~~ +^^Como al final ya no usé el `ssg` modificado, este pex ya no existe.^^ -Por último, también quité las extensiones `.html` de las URLs, porque se veía bien pitero, pero igual los links con `.html` al final redirigen a su link sin `.html`, así que no hay rollo alguno. +Por último, también quité las extensiones `.html` de las URLs, porque se ve bien pitero, pero igual los links con `.html` al final redirigen a su link sin `.html`, así que no hay rollo alguno. + +**Actualización**: Ahora estoy usando mi propia solución en vez de `ssg`, que la llamé [`pyssg`](${PYSSG_URL}), de la cual empiezo a hablar [acá](https://blog.luevano.xyz/a/new_blogging_system.html). diff --git a/src/blog/a/first_blog_post.md b/src/blog/a/first_blog_post.md index b4851f2..1cdeb5e 100644 --- a/src/blog/a/first_blog_post.md +++ b/src/blog/a/first_blog_post.md @@ -7,8 +7,10 @@ tags: short tools english -I'm making this post just to figure out how [`ssg5`](https://www.romanzolotarev.com/ssg.html) and [`lowdown`](https://kristaps.bsd.lv/lowdown/) are supposed to work (and eventually also [`rssg`](https://www.romanzolotarev.com/rssg.html)). +I'm making this post just to figure out how [`ssg5`](https://www.romanzolotarev.com/ssg.html) and [`lowdown`](https://kristaps.bsd.lv/lowdown/) are supposed to work, and eventually [`rssg`](https://www.romanzolotarev.com/rssg.html). -At the moment, I'm not satisfied because there's no automatic date insertion into the 1) html file, 2) the blog post itself and 3) the listing system in the [blog homepage](https://blog.luevano.xyz/) (and there's also the problem with the ordering of the entries...). And all of this just because I didn't want to use [Luke's](https://github.com/LukeSmithxyz/lb) solution (don't really like that much how he handles the scripts... *but they just work*). +At the moment I'm not satisfied because there's no automatic date insertion into the 1) html file, 2) the blog post itself and 3) the listing system in the [blog homepage](https://blog.luevano.xyz/) which also has a problem with the ordering of the entries. And all of this just because I didn't want to use Luke's [lb](https://github.com/LukeSmithxyz/lb) solution as I don't really like that much how he handles the scripts (*but they just work*). Hopefully, for tomorrow all of this will be sorted out and I'll have a working blog system. + +**Update**: I'm now using my own solution which I called [`pyssg`](${PYSSG_URL}), of which I talk about [here](https://blog.luevano.xyz/a/new_blogging_system.html). diff --git a/src/blog/a/git_server_with_cgit.md b/src/blog/a/git_server_with_cgit.md index 4eb440c..63fae28 100644 --- a/src/blog/a/git_server_with_cgit.md +++ b/src/blog/a/git_server_with_cgit.md @@ -4,21 +4,26 @@ lang: en summary: How to create a git server using cgit on a server running Nginx. This is a follow up on post about creating a website with Nginx and Certbot. tags: server tools + code tutorial english -My git server is all I need to setup to actually *kill* my other server (I've been moving from servers on these last 2-3 blog entries), that's why I'm already doing this entry. I'm basically following [git's guide on setting up a server](https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server) plus some specific stuff for (btw i use) Arch Linux ([Arch Linux Wiki: Git server](https://wiki.archlinux.org/index.php/Git_server#Web_interfaces) and [Step by step guide on setting up git server in arch linux (pushable)](https://miracoin.wordpress.com/2014/11/25/step-by-step-guide-on-setting-up-git-server-in-arch-linux-pushable/)). +My git server is all I need to setup to actually *kill* my other server (I've been moving from servers on these last 2-3 blog entries), that's why I'm already doing this entry. I'm basically following [git's guide on setting up a server](https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server) plus some specific stuff for ==btw i use== Arch Linux ([Arch Linux Wiki: Git server](https://wiki.archlinux.org/index.php/Git_server#Web_interfaces) and [Step by step guide on setting up git server in arch linux (pushable)](https://miracoin.wordpress.com/2014/11/25/step-by-step-guide-on-setting-up-git-server-in-arch-linux-pushable/)). -Note that this is mostly for personal use, so there's no user/authentication control other than that of SSH. Also, most if not all commands here are run as root. +Note that this is mostly for personal use, so there's no user/authentication control other than that of normal `ssh`. And as with the other entries, most if not all commands here are run as root unless stated otherwise. -## Prerequisites +# Table of contents + +[TOC] + +# Prerequisites I might get tired of saying this (it's just copy paste, basically)... but you will need the same prerequisites as before (check my [website](https://blog.luevano.xyz/a/website_with_nginx.html) and [mail](https://blog.luevano.xyz/a/mail_server_with_postfix.html) entries), with the extras: - (Optional, if you want a "front-end") A **CNAME** for "git" and (optionally) "www.git", or some other name for your sub-domains. - An SSL certificate, if you're following the other entries, add a `git.conf` and run `certbot --nginx` to extend the certificate. -## Git +# Git [Git](https://wiki.archlinux.org/title/git) is a version control system. @@ -76,14 +81,14 @@ You're basically done. Now you should be able to push/pull repositories to your ```sh git init --bare {repo_name}.git -chown -R git:git repo_name.git +chown -R git:git {repo_name}.git ``` -Those two lines above will need to be run each time you want to add a new repository to your server (yeah, kinda lame... although there are options to "automate" this, I like it this way). +==Those two lines above will need to be run each time you want to add a new repository to your server==. There are options to "automate" this but I like it this way. After that you can already push/pull to your repository. I have my repositories (locally) set up so I can push to more than one remote at the same time (my server, GitHub, GitLab, etc.); to do so, check [this gist](https://gist.github.com/rvl/c3f156e117e22a25f242). -## Cgit +# Cgit [Cgit](https://wiki.archlinux.org/title/Cgit) is a fast web interface for git. @@ -139,11 +144,10 @@ repo.url={url} repo.path={dir_path} repo.owner={owner} repo.desc={short_description} - ... ``` -Where you can uncomment the `robots` line to let web crawlers (like Google's) to index your `git` web app. And at the end keep all your repositories (the ones you want to make public), for example for my [*dotfiles*](https://git.luevano.xyz/.dots) I have: +Where you can uncomment the `robots` line to not let web crawlers (like Google's) to index your `git` web app. And at the end keep all your repositories (the ones you want to make public), for example for my [*dotfiles*](https://git.luevano.xyz/.dots) I have: ```apache ... @@ -156,6 +160,8 @@ repo.desc=These are my personal dotfiles. Otherwise you could let `cgit` to automatically detect your repositories (you have to be careful if you want to keep "private" repos) using the option `scan-path` and setup `.git/description` for each repository. For more, you can check [cgitrc(5)](https://man.archlinux.org/man/cgitrc.5). +## Cgit's file rendering + By default you can't see the files on the site, you need a highlighter to render the files, I use `highlight`. Install the `highlight` package: ```sh diff --git a/src/blog/a/mail_server_with_postfix.md b/src/blog/a/mail_server_with_postfix.md index 63bf564..cd3ba63 100644 --- a/src/blog/a/mail_server_with_postfix.md +++ b/src/blog/a/mail_server_with_postfix.md @@ -4,22 +4,27 @@ lang: en summary: How to create mail server using Postfix, Dovecot, SpamAssassin and OpenDKIM. This is a follow up on post about creating a website with Nginx and Certbot. tags: server tools + code tutorial english -The entry is going to be long because it's a *tedious* process. This is also based on [Luke Smith's script](https://github.com/LukeSmithxyz/emailwiz), but adapted to Arch Linux (his script works on debian-based distributions). This entry is mostly so I can record all the notes required while I'm in the process of installing/configuring the mail server on a new VPS of mine; also I'm going to be writing a script that does everything in one go (for Arch Linux), that will be hosted [here](https://git.luevano.xyz/server_scripts.git). +The entry is going to be long because it's a *tedious* process. This is also based on [Luke Smith's script](https://github.com/LukeSmithxyz/emailwiz), but adapted to Arch Linux (his script works on debian-based distributions). This entry is mostly so I can record all the notes required while I'm in the process of installing/configuring the mail server on a new VPS of mine; ~~also I'm going to be writing a script that does everything in one go (for Arch Linux), that will be hosted [here](https://git.luevano.xyz/server_scripts.git).~~ ^^I haven't had time to do the script so nevermind this, if I ever do it I'll make a new entry regarding it.^^ -This configuration works for local users (users that appear in `/etc/passwd`), and does not use any type of SQL Database. And note that most if not all commands executed here are run with root privileges. +This configuration works for local users (users that appear in `/etc/passwd`), and does not use any type of SQL database. And note that most if not all commands executed here are run with root privileges, unless stated otherwise. -## Prerequisites +# Table of contents + +[TOC] + +# Prerequisites Basically the same as with the [website with Nginx and Certbot](https://blog.luevano.xyz/a/website_with_nginx.html), with the extras: - You will need a **CNAME** for "mail" and (optionally) "www.mail", or whatever you want to call the sub-domains (although the [RFC 2181](https://tools.ietf.org/html/rfc2181#section-10.3) states that it NEEDS to be an **A** record, fuck the police). - An SSL certificate. You can use the SSL certificate obtained following my last post using `certbot` (just create a `mail.conf` and run `certbot --nginx` again). -- Ports 25, 587 (SMTP), 465 (SMTPS), 143 (IMAP) and 993 (IMAPS) open on the firewall. +- Ports `25`, `587` (SMTP), `465` (SMTPS), `143` (IMAP) and `993` (IMAPS) open on the firewall (I use `ufw`). -## Postfix +# Postfix [Postfix](https://wiki.archlinux.org/title/postfix) is a "mail transfer agent" which is the component of the mail server that receives and sends emails via SMTP. @@ -70,7 +75,7 @@ smtpd_sasl_security_options = noanonymous, noplaintext smtpd_sasl_tls_security_options = noanonymous ``` -Specify the mailbox home (this is going to be a directory inside your user's home containing the actual mail files): +Specify the mailbox home, this is going to be a directory inside your user's home containing the actual mail files, for example it will end up being`/home/david/Mail/Inbox`: ```apache home_mailbox = Mail/Inbox/ @@ -90,9 +95,7 @@ non_smtpd_milters = inet:127.0.0.1:8891 mailbox_command = /usr/lib/dovecot/deliver ``` -Where `{yourdomainname}` is `luevano.xyz` in my case, or if you have `localhost` configured to your domain, then use `localhost` for `myhostname` (`myhostname = localhost`). - -Lastly, if you don't want the sender's IP and user agent (application used to send the mail), add the following line: +Where `{yourdomainname}` is `luevano.xyz` in my case. Lastly, if you don't want the sender's IP and user agent (application used to send the mail), add the following line: ```apache smtp_header_checks = regexp:/etc/postfix/smtp_header_checks @@ -149,7 +152,7 @@ systemctl start postfix.service systemctl enable postfix.service ``` -## Dovecot +# Dovecot [Dovecot](https://wiki.archlinux.org/title/Dovecot) is an IMAP and POP3 server, which is what lets an email application retrieve the mail. @@ -310,9 +313,9 @@ systemctl start dovecot.service systemctl enable dovecot.service ``` -## OpenDKIM +# OpenDKIM -[OpenDKIM](https://wiki.archlinux.org/title/OpenDKIM) is needed so services like G\*\*gle (we don't mention that name here \[\[\[this is a meme\]\]\]) don't throw the mail to the trash. DKIM stands for "DomainKeys Identified Mail". +[OpenDKIM](https://wiki.archlinux.org/title/OpenDKIM) is needed so services like G\*\*gle don't throw the mail to the trash. DKIM stands for "DomainKeys Identified Mail". Install the `opendkim` package: @@ -395,7 +398,9 @@ systemctl start opendkim.service systemctl enable opendkim.service ``` -And don't forget to add the following **TXT** records on your domain registrar (these examples are for Epik): +## OpenDKIM DNS TXT records + +Add the following **TXT** records on your domain registrar (these examples are for Epik): 1. *DKIM* entry: look up your `{yoursubdomain}.txt` file, it should look something like: @@ -405,7 +410,7 @@ And don't forget to add the following **TXT** records on your domain registrar ( "..." ) ; ----- DKIM key mail for {yourdomain} ``` -In the TXT record you will place `{yoursubdomain}._domainkey` as the "Host" and `"v=DKIM1; k=rsa; s=email; " "p=..." "..."` in the "TXT Value" (replace the dots with the actual value you see in your file). +In the **TXT** record you will place `{yoursubdomain}._domainkey` as the "Host" and `"v=DKIM1; k=rsa; s=email; " "p=..." "..."` in the "TXT Value" (replace the dots with the actual value you see in your file). 2. *DMARC* entry: just `_dmarc.{yourdomain}` as the "Host" and `"v=DMARC1; p=reject; rua=mailto:dmarc@{yourdomain}; fo=1"` as the "TXT Value". @@ -413,7 +418,7 @@ In the TXT record you will place `{yoursubdomain}._domainkey` as the "Host" and And at this point you could test your mail for spoofing and more. -## SpamAssassin +# SpamAssassin [SpamAssassin](https://wiki.archlinux.org/title/SpamAssassin) is just *a mail filter to identify spam*. @@ -492,13 +497,13 @@ systemctl start spamassassin.service systemctl enable spamassassin.service ``` -## Wrapping up +# Wrapping up -We should have a working mail server by now. Before continuing check your journal logs (`journalctl -xe --unit={unit}`, where `{unit}` could be `spamassassin.service` for example) to see if there was any error whatsoever and try to debug it, it should be a typo somewhere (the logs are generally really descriptive) because all the settings and steps detailed here just (literally just finished doing everything on a new server as of the writing of this text) worked *(((it just werks on my machine)))*. +We should have a working mail server by now. Before continuing check your journal logs (`journalctl -xe --unit={unit}`, where `{unit}` could be `spamassassin.service` for example) to see if there was any error whatsoever and try to debug it, it should be a typo somewhere because all the settings and steps detailed here just worked; I literally just finished doing everything on a new server as of the writing of this text, ==it just werks on my machine==. Now, to actually use the mail service: first of all, you need a *normal* account (don't use root) that belongs to the `mail` group (`gpasswd -a user group` to add a user `user` to group `group`) and that has a password. -Next, to actually login into a mail app/program/whateveryouwanttocallit, you will use the following settings, at least for `thunderdbird`(I tested in windows default mail app and you don't need a lot of settings): +Next, to actually login into a mail app/program, you will use the following settings, at least for `thunderdbird`(I tested in windows default mail app and you don't need a lot of settings): - \* server: subdomain.domain (mail.luevano.xyz in my case) - **SMTP** port: 587 @@ -512,6 +517,4 @@ Next, to actually login into a mail app/program/whateveryouwanttocallit, you wil All that's left to do is test your mail server for spoofing, and to see if everything is setup correctly. Go to [DKIM Test](https://www.appmaildev.com/en/dkim) and follow the instructions (basically click next, and send an email with whatever content to the email that they provide). After you send the email, you should see something like: - - -Finally, that's actually it for this entry, if you have any problem whatsoever you can [contact me](https://luevano.xyz/contact.html). + diff --git a/src/blog/a/new_blogging_system.md b/src/blog/a/new_blogging_system.md index a855259..7252a2c 100644 --- a/src/blog/a/new_blogging_system.md +++ b/src/blog/a/new_blogging_system.md @@ -11,10 +11,12 @@ So, I was tired of working with `ssg` (and then `sbg` which was a modified versi The solution? Write a new program "from scratch" in *pYtHoN*. Yes it is bloated, yes it is in its early stages, but it works just as I want it to work, and I'm pretty happy so far with the results and have with even more ideas in mind to "optimize" and generally clean my wOrKfLoW to post new blog entries. I even thought of using it for posting into a "feed" like gallery for drawings or pictures in general. -I called it [`pyssg`](https://github.com/luevano/pyssg), because it sounds nice and it wasn't taken in the PyPi. It is just a terminal program that reads either a configuration file or the options passed as flags when calling the program. +I called it [`pyssg`](${PYSSG_URL}), because it sounds nice and it wasn't taken in the PyPi. It is just a terminal program that reads either a configuration file or the options passed as flags when calling the program. It still uses Markdown files because I find them very easy to work with. And instead of just having a "header" and a "footer" applied to each parsed entry, you will have templates (generated with the program) for each piece that I thought made sense (idea taken from `blogit`): the common header and footer, the common header and footer for each entry and, header, footer and list elements for articles and tags. When parsing the Markdown file these templates are applied and stitched together to make a single HTML file. Also generates an RSS feed and the `sitemap.xml` file, which is nice. -It might sound convoluted, but it works pretty well, with of course room to improve; I'm open to suggestions, issue reporting or direct contributions [here](https://github.com/luevano/pyssg). BTW, it only works on Linux for now (and don't think on making it work on windows, but feel free to do PR for the compatibility). +It might sound convoluted, but it works pretty well, with of course room to improve; I'm open to suggestions, issue reporting or direct contributions [here](https://github.com/luevano/pyssg). For now, it is only tested on Linux (and don't think on making it work on windows, but feel free to do PR for the compatibility). That's it for now, the new RSS feed is available here: [https://blog.luevano.xyz/rss.xml](https://blog.luevano.xyz/rss.xml). + +**Update**: Since writing this entry, [`pyssg`](${PYSSG_URL}) has evolved quite a bit, so not everything described here is still true. For the latest updates check the newest entries or the git repository itself. diff --git a/src/blog/a/password_manager_authenticator_setup.md b/src/blog/a/password_manager_authenticator_setup.md index f0e8c76..9c5a03b 100644 --- a/src/blog/a/password_manager_authenticator_setup.md +++ b/src/blog/a/password_manager_authenticator_setup.md @@ -8,7 +8,7 @@ tags: tools **Disclaimer**: I won't go into many technical details here of how to install/configure/use the software, this is just supposed to be a short description on my setup. -It's been a while since I started using a password manager at all, and I'm happy that I started with [KeePassXC](https://keepassxc.org/) (open source, multiplatform password manager that it's completely offline) as a direct recommendation from [lm](https://www.lmcj.xyz/); before this I was using the same password for everything (like a lot of people), which is a well know privacy issue as noted in detail by [Leo](https://askleo.com/different-passwords-for-everything/) (I don't personally recommed LastPass as Leo does). Note that you will still need a *master password* to lock/unlock your password database (you can additionally use a hardware key and a key file). +It's been a while since I started using a password manager at all, and I'm happy that I started with [KeePassXC](https://keepassxc.org/) (open source, multiplatform password manager that it's completely offline) as a direct recommendation from [==EL ELE EME==](https://www.lmcj.xyz/); before this I was using the same password for everything (like a lot of people), which is a well know privacy issue as noted in detail by [Leo](https://askleo.com/different-passwords-for-everything/) (I don't personally recommed LastPass as Leo does). Note that you will still need a *master password* to lock/unlock your password database (you can additionally use a hardware key and a key file). Anyways, setting up *keepass* is pretty simple, as there is a client for almost any device; note that *keepass* is basically just the format and the base for all of the clients, as its common with pretty much any open source software. In my case I'm using [KeePassXC](https://keepassxc.org/) in my computer and [KeePassDX](https://www.keepassdx.com/) in my phone (Android). The only concern is keeping everything in sync because *keepass* doesn't have any automatic method of synchronizing between devices because of security reasons (as far as I know), meaning that you have to manage that yourself. diff --git a/src/blog/a/rewrote_pyssg_again.md b/src/blog/a/rewrote_pyssg_again.md index 70ec8dd..b00538c 100644 --- a/src/blog/a/rewrote_pyssg_again.md +++ b/src/blog/a/rewrote_pyssg_again.md @@ -7,8 +7,8 @@ tags: update short english -I've been wanting to change the way [pyssg](https://github.com/luevano/pyssg) reads config files and generates `HTML` files so that it is more flexible and I don't need to have 2 separate build commands and configs (for [blog](https://blog.luevano.xyz) and [art](https://art.luevano.xyz)), and also to handle other types of "sites"; because `pyssg` was built with blogging in mind, so it was a bit limited to how it could be used. So I had to kind of *rewrite* `pyssg`, and with the latest version I can now generate the whole site and use the same templates for everything, quite neat for my use case. +I've been wanting to change the way [`pyssg`](https://github.com/luevano/pyssg) reads config files and generates `HTML` files so that it is more flexible and I don't need to have 2 separate build commands and configs (for [blog](https://blog.luevano.xyz) and [art](https://art.luevano.xyz)), and also to handle other types of "sites"; because `pyssg` was built with blogging in mind, so it was a bit limited to how it could be used. So I had to kind of *rewrite* `pyssg`, and with the latest version I can now generate the whole site and use the same templates for everything, quite neat for my use case. Anyways, so I bought a new domain for all `pyssg` related stuff, mostly because I wanted somewhere to test live builds while developing, it is of course [pyssg.xyz](https://pyssg.xyz); as of now it is the same template, CSS and scripts that I use here, probably will change in the future. I'll be testing new features and anything `pyssg` related stuff. -I should start pointing all links to `pyssg` to the actual site instead of the github repository (or my [git](https://git.luevano.xyz) repository), but I haven't decided how to handle everything.
\ No newline at end of file +I should start pointing all links to `pyssg` to the actual site instead of the github repository (or my [git](https://git.luevano.xyz) repository), but I haven't decided how to handle everything. diff --git a/src/blog/a/tenia_esto_descuidado.md b/src/blog/a/tenia_esto_descuidado.md index 1d90745..6b31530 100644 --- a/src/blog/a/tenia_esto_descuidado.md +++ b/src/blog/a/tenia_esto_descuidado.md @@ -1,4 +1,4 @@ -title: Tenia este pex algo descuidado +title: Tenía este pex algo descuidado author: David Luévano lang: es summary: Nada más un update en el estado del blog y lo que he andado haciendo. @@ -8,12 +8,12 @@ tags: short Así es, tenía un poco descuidado este pex, siendo la razón principal que andaba ocupado con cosas de *la vida profesional*, ayay. Pero ya que ando un poco más despejado y menos estresado voy a seguir usando el blog y a ver qué más hago. -Tengo unas entradas pendientes que quiero hacer del estilo de "tutorial" o "how-to", pero me lo he estado debatiendo, porque Luke ya empezó a hacerlo más de verdad en [landchad.net](https://landchad.net/), lo cual recomiendo bastante pues igual yo empecé a hacer esto por él (y por [lm](https://lmcj.xyz/)); aunque la verdad pues es muy específico a como él hace las cosas y quizá sí puede haber diferencias, pero ya veré en estos días. La próxima que quiero hacer es sobre el VPN, porque no lo he *setupeado* desde que reinicié El Página Web y La Servidor, entonces acomodaré el VPN de nuevo y de pasada tiro entrada de eso. +Tengo unas entradas pendientes que quiero hacer del estilo de "tutorial" o "how-to", pero me lo he estado debatiendo, porque Luke ya empezó a hacerlo más de verdad en [landchad.net](https://landchad.net/), lo cual recomiendo bastante pues igual yo empecé a hacer esto por él (y por [==EL ELE EME==](https://lmcj.xyz/)); aunque la verdad pues es muy específico a como él hace las cosas y quizá sí puede haber diferencias, pero ya veré en estos días. La próxima que quiero hacer es sobre el VPN, porque no lo he *setupeado* desde que reinicié El Página Web y La Servidor, entonces acomodaré el VPN de nuevo y de pasada tiro entrada de eso. -También dejé un dibujo pendiente, que la neta lo dejé por 2 cosas: está bien cabrón (porque también lo quiero colorear) y porque estaba ocupado; de lo cuál ya sólo queda el *está bien cabrón* pero no he tenido el valor de retomarlo. Lo triste es que ya pasó el tiempo del hype y ya no tengo mucha motivación para terminarlo más que el hecho de que cuando lo termine empezaré a usar Clip Studio Paint en vez de Krita, porque compré una licencia ahora que estuvo en 50% de descuento (sí, me mamé). +También dejé un dibujo pendiente, que la neta lo dejé por 2 cosas: está bien cabrón (porque también lo quiero colorear) y porque estaba ocupado; de lo cuál ya sólo queda el *está bien cabrón* pero no he tenido el valor de retomarlo. Lo triste es que ya pasó el tiempo del hype y ya no tengo mucha motivación para terminarlo más que el hecho de que cuando lo termine empezaré a usar Clip Studio Paint en vez de Krita, porque compré una licencia ahora que estuvo en 50% de descuento. Algo bueno es que me he estado sintiendo muy bien conmigo mismo últimamente, aunque casi no hable de eso. Sí hay una razón en específico, pero es una razón algo tonta. Espero así siga. -Ah, y también quería acomodarme una sección de comentarios, pero como siempre, todas las opciones están bien *bloated*, entonces pues me voy a hacer una en corto seguramente en Python para *el back*, MySQL para la base de datos y Javascript para la conexión acá en *el front*, algo tranqui. +~~Ah, y también quería acomodarme una sección de comentarios, pero como siempre, todas las opciones están bien *bloated*, entonces pues me voy a hacer una en corto seguramente en Python para *el back*, MySQL para la base de datos y Javascript para la conexión acá en *el front*, algo tranqui.~~ ^^Nel, siempre no ocupo esto, pa' qué.^^ Sobres pues. diff --git a/src/blog/a/volviendo_a_usar_la_pagina.md b/src/blog/a/volviendo_a_usar_la_pagina.md index de6d0cc..265f6f0 100644 --- a/src/blog/a/volviendo_a_usar_la_pagina.md +++ b/src/blog/a/volviendo_a_usar_la_pagina.md @@ -8,8 +8,8 @@ tags: short Después de mucho tiempo de estar luchando con querer volver a usar este pex (maldita *d* word y demás), ya me volví a acomodar el setup para agregar nuevas entradas. -Entre las cosas que tuve que hacer fue actualizar el [pyssg](https://github.com/luevano/pyssg) porque no lo podía usar de una como estaba; y de pasado le agregue una que otra feature nueva. Luego quiero agregarle más funcionalidad para poder *buildear* la página completa; por ahora se hace en segmentos: todo lo de [luevano.xyz](https://luevano.xyz) está hecho manual, mientras que [blog](https://blog.luevano.xyz) y [art](https://art.luevano.xyz) usan [pyssg](https://github.com/luevano/pyssghttps://github.com/luevano/pyssg). +Entre las cosas que tuve que hacer fue actualizar el [`pyssg`](${PYSSG_URL}) porque no lo podía usar de una como estaba; y de pasado le agregue una que otra feature nueva. Luego quiero agregarle más funcionalidad para poder *buildear* la página completa; por ahora se hace en segmentos: todo lo de [luevano.xyz](https://luevano.xyz) está hecho manual, mientras que [blog](https://blog.luevano.xyz) y [art](https://art.luevano.xyz) usan [pyssg](${PYSSG_URL}). Otra cosa es que quizá me devuelva a editar alguans entradas nada más para homogeneizar las entradas específicas a *Create a...* (tiene más sentido que sean *Setup x...* o algo similar). -En otras noticias, estoy muy agusto en el jale que tengo actualmente aunque lleve alrededor de 3 semanas de un infierno por problemas debidos a varias razones (del jale). Debo pensar en si debo omitir cosas personales o del trabajo aquí, ya que quién sabe quién se pueda llegar a topar con esto *\*thinking emoji\**. +En otras noticias, estoy muy agusto en el jale que tengo actualmente aunque lleve alrededor de 3 semanas de un infierno en el jale. Debo pensar en si debo omitir cosas personales o del trabajo aquí, ya que quién sabe quién se pueda llegar a topar con esto *\*thinking emoji\**. diff --git a/src/blog/a/vpn_server_with_openvpn.md b/src/blog/a/vpn_server_with_openvpn.md index 7346264..f36d845 100644 --- a/src/blog/a/vpn_server_with_openvpn.md +++ b/src/blog/a/vpn_server_with_openvpn.md @@ -4,6 +4,7 @@ lang: en summary: How to create a VPN server using OpenVPN on a server running Nginx. Only for IPv4. tags: server tools + code tutorial english @@ -11,16 +12,20 @@ I've been wanting to do this entry, but had no time to do it since I also have t Like with any other of my entries I based my setup on the [Arch Wiki](https://wiki.archlinux.org/title/OpenVPN), [this install script](https://github.com/Nyr/openvpn-install) and [this profile generator script](https://github.com/graysky2/ovpngen). -This will be installed and working alongside the other stuff I've wrote about on other posts (see the [server](https://blog.luevano.xyz/tag/@server.html) tag). All commands here are executes as root unless specified otherwise. Also, this is intended only for IPv4 (it's not that hard to include IPv6, but meh). +This will be installed and working alongside the other stuff I've wrote about on other posts (see the [server](https://blog.luevano.xyz/tag/@server.html) tag). All commands here are executes as root unless specified otherwise. Also, this is intended only for IPv4 (it's not that hard to include IPv6, but meh). As always, all commands are executed as root unless stated otherwise. -## Prerequisites +# Table of contents + +[TOC] + +# Prerequisites Pretty simple: -- Working server with root access, and with Ufw as the firewall. -- Depending on what port you want to run the VPN on, the default `1194`, or as a fallback on `443` (click [here](https://openvpn.net/vpn-server-resources/advanced-option-settings-on-the-command-line/) for more). I will do mine on port `1194` but it's just a matter of changing 2 lines of configuration and one Ufw rule. +- Working server with root access, and with `ufw` as the firewall. +- Depending on what port you want to run the VPN on, the default `1194`, or as a fallback on `443` (click [here](https://openvpn.net/vpn-server-resources/advanced-option-settings-on-the-command-line/) for more). I will do mine on port `1194` but it's just a matter of changing 2 lines of configuration and one `ufw` rule. -## Create PKI from scratch +# Create PKI from scratch PKI stands for *Public Key Infrastructure* and basically it's required for certificates, private keys and more. This is supposed to work between two servers and one client: a server in charge of creating, signing and verifying the certificates, a server with the OpenVPN service running and the client making the request. @@ -92,9 +97,9 @@ openvpn --genkey secret ta.key That's it for the PKI stuff and general certificate configuration. -## OpenVPN +# OpenVPN -[OpenVPN](https://wiki.archlinux.org/title/OpenVPN) is a robust and highly flexible VPN daemon, that's pretty complete feature wise. +[OpenVPN](https://wiki.archlinux.org/title/OpenVPN) is a robust and highly flexible VPN daemon, that's pretty complete feature-wise. Install the `openvpn` package: @@ -204,6 +209,8 @@ explicit-exit-notify 1 `#` and `;` are comments. Read each and every line, you might want to change some stuff (like the logging), specially the first line which is your server public IP. +### Enable forwarding + Now, we need to enable *packet forwarding* (so we can access the web while connected to the VPN), which can be enabled on the interface level or globally (you can check the different options with `sysctl -a | grep forward`). I'll do it globally, run: ```sh @@ -272,7 +279,7 @@ systemctl enable openvpn-server@server.service Where the `server` after `@` is the name of your configuration, `server.conf` without the `.conf` in my case. -### Create client configurations +## Create client configurations You might notice that I didn't specify how to actually connect to our server. For that we need to do a few more steps. We actually need a configuration file similar to the `server.conf` file that we created. @@ -357,6 +364,6 @@ chmod o+r pki/crl.pem cd $CPWD ``` -And the way to use is to run `vpn_script new/rev client_name` as sudo (when revoking, it doesn't actually deletes the `.ovpn` file in `~/ovpn`). Again, this is a little script that I put together, so you should check it out, it may need tweaks (depending on your directory structure for `easy-rsa`) and it could have errors. +And the way to use is to run `vpn_script new/rev client_name` as sudo (when revoking, it doesn't actually delete the `.ovpn` file in `~/ovpn`). Again, this is a little script that I put together, so you should check it out, it may need tweaks (depending on your directory structure for `easy-rsa`). Now, just get the `.ovpn` file generated, import it to OpenVPN in your client of preference and you should have a working VPN service. diff --git a/src/blog/a/website_with_nginx.md b/src/blog/a/website_with_nginx.md index 7e4624a..11d4406 100644 --- a/src/blog/a/website_with_nginx.md +++ b/src/blog/a/website_with_nginx.md @@ -4,25 +4,30 @@ lang: en summary: How to create website that runs on Nginx and uses Certbot for SSL certificates. This is a base for future blog posts about similar topics. tags: server tools + code tutorial english These are general notes on how to setup a Nginx web server plus Certbot for SSL certificates, initially learned from [Luke's video](https://www.youtube.com/watch?v=OWAqilIVNgE) and after some use and research I added more stuff to the mix. And, actually at the time of writing this entry, I'm configuring the web server again on a new VPS instance, so this is going to be fresh. -As a side note, (((i use arch btw))) so everything here es aimed at an Arch Linux distro, and I'm doing everything on a VPS. Also note that most if not all commands here are executed with root privileges. +As a side note, ==i use arch btw== so everything here es aimed at an Arch Linux distro, and I'm doing everything on a VPS. Also note that most if not all commands here are executed with root privileges. -## Prerequisites +# Table of contents + +[TOC] + +# Prerequisites You will need two things: - A domain name (duh!). I got mine on [Epik](https://www.epik.com/?affid=da5ne9ru4) (affiliate link, btw). - - With the corresponding **A** and **AAA** records pointing to the VPS' IPs ("A" record points to the ipv4 address and "AAA" to the ipv6, basically). I have three records for each type: empty one, "www" and "\*" for a wildcard, that way "domain.name", "www.domain.name", "anythingelse.domain.name" point to the same VPS (meaning that you can have several VPS for different sub-domains). -- A VPS or somewhere else to host it. I'm using [Vultr](https://www.vultr.com/?ref=8732849) (also an affiliate link). + - With the corresponding **A** and **AAA** records pointing to the VPS' IPs. I have three records for each type: empty string, "www" and "\*" for a wildcard, that way "domain.name", "www.domain.name", "anythingelse.domain.name" point to the same VPS (meaning that you can have several VPS for different sub-domains). These depend on the VPS provider. +- A VPS or somewhere else to host it. I'm using [Vultr](https://www.vultr.com/?ref=8732849) (also an affiliate link, btw). - With `ssh` already configured both on the local machine and on the remote machine. - - Firewall already configured to allow ports 80 (HTTP) and 443 (HTTPS). I use `ufw` so it's just a matter of doing `ufw allow 80,443/tcp` as root and you're golden. - - `cron` installed if you follow along (you could use `systemd` timers, or some other method you prefer to automate running commands every X time). + - Firewall already configured to allow ports `80` (HTTP) and `443` (HTTPS). I use `ufw` so it's just a matter of doing `ufw allow 80,443/tcp` (for example) as root and you're golden. + - `cron` installed if you follow along (you could use `systemd` timers, or some other method you prefer to automate running commands every certain time). -## Nginx +# Nginx [Nginx](https://wiki.archlinux.org/title/Nginx) is a web (HTTP) server and reverse proxy server. @@ -36,7 +41,7 @@ systemctl start nginx.service And that's it, at this point you can already look at the default initial page of Nginx if you enter the IP of your server in a web browser. You should see something like this: - + As stated in the welcome page, configuration is needed, head to the directory of Nginx: @@ -121,7 +126,7 @@ systemctl restart nginx If everything goes correctly, you can now go to your website by typing `domain.name` on a web browser. But you will see a "404 Not Found" page like the following (maybe with different Nginx version): - + That's no problem, because it means that the web server it's actually working. Just add an `index.html` file with something simple to see it in action (in the `/var/www/some_folder` that you decided upon). If you keep seeing the 404 page make sure your `root` line is correct and that the directory/index file exists. @@ -137,7 +142,7 @@ server { ... ``` -## Certbot +# Certbot [Certbot](https://wiki.archlinux.org/title/Certbot) is what provides the SSL certificates via [Let's Encrypt](https://letsencrypt.org/). @@ -161,6 +166,6 @@ Now, the certificate given by `certbot` expires every 3 months or something like crontab -e ``` -And a file will be opened where you need to add a new rule for Certbot, just append the line: `1 1 1 * * certbot renew` (renew on the first day of every month) and you're good. Alternatively use `systemd` timers as stated in the [Arch Linux Wiki](https://wiki.archlinux.org/title/Certbot#Automatic_renewal). +And a file will be opened where you need to add a new rule for Certbot, just append the line: `1 1 1 * * certbot renew --quiet --agree-tos --deploy-hook "systemctl reload nginx.service"` (renew on the first day of every month) and you're good. Alternatively use `systemd` timers as stated in the [Arch Linux Wiki](https://wiki.archlinux.org/title/Certbot#Automatic_renewal). That's it, you now have a website with SSL certificate. diff --git a/src/blog/a/xmpp_server_with_prosody.md b/src/blog/a/xmpp_server_with_prosody.md index e3ed291..bf25e9d 100644 --- a/src/blog/a/xmpp_server_with_prosody.md +++ b/src/blog/a/xmpp_server_with_prosody.md @@ -4,16 +4,23 @@ lang: en summary: How to create an XMPP server using Prosody on a server running Nginx. This server will be compatible with at least Conversations and Movim. tags: server tools + code tutorial english -Recently I set up an XMPP server (and a Matrix one, too) for my personal use and for friends if they want one; made one for ==[EL ELE EME](https://lmcj.xyz)== for example. So, here are the notes on how I set up the server that is compatible with the [Conversations](https://conversations.im/) app and the [Movim](https://movim.eu/) social network. You can see my addresses in [contact](https://luevano.xyz/contact.html) and the XMPP compliance/score of the server. +**Update**: I no longer host this XMPP server as it consumed a lot of resources and I wasn't using it that much. I'll probably re-create it in the future, though. -One of the best resources I found that helped me a lot was [Installing and Configuring Prosody XMPP Server on Debian 9](https://community.hetzner.com/tutorials/prosody-debian9), and of course the [Arch Wiki](https://wiki.archlinux.org/title/Prosody) and the [oficial documentation](https://prosody.im/). +Recently I set up an [XMPP](https://xmpp.org/) server (and a Matrix one, too) for my personal use and for friends if they want one; made one for [==EL ELE EME==](https://lmcj.xyz) for example. So, here are the notes on how I set up the server that is compatible with the [Conversations](https://conversations.im/) app and the [Movim](https://movim.eu/) social network. You can see my addresses at [contact](https://luevano.xyz/contact.html) and the XMPP compliance/score of the server. -As with my other entries, this is under a server running Arch Linux, with the Nginx web server and Certbot certificates. And all commands here are executed as root (unless specified otherwise) +One of the best resources I found that helped me a lot was [Installing and Configuring Prosody XMPP Server on Debian 9](https://community.hetzner.com/tutorials/prosody-debian9), the [Arch Wiki](https://wiki.archlinux.org/title/Prosody) and the [oficial documentation](https://prosody.im/). -## Prerequisites +As with my other entries, this is under a server running Arch Linux, with the Nginx web server and Certbot certificates. And all commands here are executed as root, unless specified otherwise. + +# Table of contents + +[TOC] + +# Prerequisites Same as with my other entries ([website](https://luevano.xyz/a/website_with_nginx.html), [mail](https://blog.luevano.xyz/a/mail_server_with_postfix.html) and [git](https://blog.luevano.xyz/a/git_server_with_cgit.html)) plus: @@ -24,14 +31,14 @@ Same as with my other entries ([website](https://luevano.xyz/a/website_with_ngin - `proxy`: a proxy in case one of the users needs it. - `vjud`: user directory. - (Optionally, but recommended) the following **SRV** DNS records; make sure it is pointing to an **A** or **AAA** record (matching the records from the last point, for example): - - `_xmpp-client._tcp.**your.domain**.` for port `5222` pointing to `xmpp.**your.domain**.` - - `_xmpp-server._tcp.**your.domain**.` for port `5269` pointing to `xmpp.**your.domain**.` - - `_xmpp-server._tcp.muc.**your.domain**.` for port `5269` pointing to `xmpp.**your.domain**.` + - `_xmpp-client._tcp.{your.domain}.` for port `5222` pointing to `xmpp.{your.domain}.` + - `_xmpp-server._tcp.{your.domain}.` for port `5269` pointing to `xmpp.{your.domain}.` + - `_xmpp-server._tcp.muc.{your.domain}.` for port `5269` pointing to `xmpp.{your.domain}.` * SSL certificates for the previous subdomains; similar that with my other entries just create the appropriate `prosody.conf` (where `server_name` will be all the subdomains defined above) file and run `certbot --nginx`. You can find the example configuration file almost at the end of this entry. - Email addresses for `admin`, `abuse`, `contact`, `security`, etc. Or use your own email for all of them, doesn't really matter much as long as you define them in the configuration and are valid, I have aliases so those emails are forwarded to me. - Allow ports `5000`, `5222`, `5269`, `5280` and `5281` for [Prosody](https://prosody.im/doc/ports) and, `3478` and `5349` for [Turnserver](https://webrtc.org/getting-started/turn-server) which are the defaults for `coturn`. -## Prosody +# Prosody [Prosody](https://wiki.archlinux.org/title/Prosody) is an implementation of the XMPP protocol that is flexible and extensible. @@ -54,11 +61,11 @@ You can see that I follow a similar approach that I used with Nginx and the serv Make symbolic links to the following modules: ``` -ln -s /var/lib/prosody/modules-available/MODULE_NAME /var/lib/prosody/modules-enabled/ +ln -s /var/lib/prosody/modules-available/{module_name} /var/lib/prosody/modules-enabled/ ... ``` -- Modules: +- Modules (`{module_name}`): - `mod_bookmarks` - `mod_cache_c2s_caps` - `mod_checkcerts` @@ -407,9 +414,9 @@ ln -s your.domain.key SUBDOMAIN.your.domain.key That's basically all the configuration that needs Prosody itself, but we still have to configure Nginx and Coturn before starting/enabling the `prosody` service. -## Nginx configuration file +# Nginx configuration file -Since this is not an ordinary configuration file I'm going to describe this too. Your `prosody.conf` file should have the following location blocks under the main server block (the one that listens to HTTPS): +Since this is not an ordinary configuration file I'm going to describe this, too. Your `prosody.conf` file should have the following location blocks under the main server block (the one that listens to HTTPS): ```nginx # HTTPS server block @@ -515,14 +522,14 @@ And `host-meta.json` file: } ``` -Remember to have your `prosody.conf` file symlinked (or discoverable by Nginx) to the `sites-enabled` directory. You can now restart your `nginx` service (and test the configuration, optionally): +Remember to have your `prosody.conf` file symlinked (or discoverable by Nginx) to the `sites-enabled` directory. You can now test and restart your `nginx` service (and test the configuration, optionally): ```sh nginx -t systemctl restart nginx.service ``` -## Coturn +# Coturn [Coturn](https://github.com/coturn/coturn) is the implementation of TURN and STUN server, which in general is for (at least in the XMPP world) voice support and external service discovery. @@ -551,7 +558,7 @@ systemctl enable turnserver.service You can test if your TURN server works at [Trickle ICE](https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/). You may need to add a user in the `turnserver.conf` to test this. -## Wrapping up +# Wrapping up At this point you should have a working XMPP server, start/enable the `prosody` service now: @@ -576,4 +583,4 @@ Additionally, you can test the security of your server in [IM Observatory](https You can now log in into your XMPP client of choice, if it asks for the server it should be `xmpp.your.domain` (or `your.domain` for some clients) and your login credentials `you@your.domain` and the password you chose (which you can change in most clients). -That's it, send me a message <a href="xmpp:david@luevano.xyz">david@luevano.xyz</a> if you were able to set up the server successfully. +That's it, send me a message at <a href="xmpp:david@luevano.xyz">david@luevano.xyz</a> if you were able to set up the server successfully. diff --git a/src/blog/g/flappybird_godot_devlog_1.md b/src/blog/g/flappybird_godot_devlog_1.md index 44a5f36..ad54393 100644 --- a/src/blog/g/flappybird_godot_devlog_1.md +++ b/src/blog/g/flappybird_godot_devlog_1.md @@ -4,9 +4,10 @@ lang: en summary: 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. tags: gamedev godot + gdscript english -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: +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: - Literally just one sprite going up and down. - Constant horizontal move of the world/player. @@ -19,203 +20,208 @@ Not going to specify all the details, only the needed parts and what could be co 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. -The source code can be found in my GitHub [here](https://github.com/luevano/flappybird_godot), 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: +The source code can be found in my GitHub [here](https://github.com/luevano/flappybird_godot), 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](https://lorentzeus.itch.io/flappybirdgodot) page I setup where it's playable in the browser: -<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> +<p style="text-align:center"><iframe src="https://itch.io/embed/1551015?dark=true" width="208" height="167" frameborder="0"><a href="https://lorentzeus.itch.io/flappybirdgodot">FlappyBirdGodot by Lorentzeus</a></iframe></p> -## Initial project setup +# Table of contents -### Directory structure +[TOC] + +# Initial setup + +## Directory structure I'm basically going with what I wrote on [Godot project structure](https://blog.luevano.xyz/g/godot_project_structure.html) recently, and probably with minor changes depending on the situation. -### Config +## Config -#### Default import settings +### Default import settings Since this is just pixel art, the importing settings for textures needs to be adjusted so the sprites don't look blurry. Go to *Project -> Project settings... -> Import defaults* and on the drop down select `Texture`, untick everything and make sure *Compress/Mode* is set to `Lossless`. - + -#### General settings +### General settings It's also a good idea to setup some config variables project-wide. To do so, go to *Project -> Project settings... -> General*, select *Application/config* and add a new property (there is a text box at the top of the project settings window) for game scale: `application/config/game_scale` for the type use `float` and then click on add; configure the new property to `3.0`; On the same window, also add `application/config/version` as a `string`, and make it `1.0.0` (or whatever number you want). - + -For my personal preferences, also disable some of the *GDScript* debug warnings that are annoying, this is done at *Project -> Project settings... -> General*, select *Debug/GDScript* and toggle off "Unused arguments", "Unused signal" and "Return value discarded", and any other that might come up too often and don't want to see. +For my personal preferences, also disable some of the *GDScript* debug warnings that are annoying, this is done at *Project -> Project settings... -> General*, select *Debug/GDScript* and toggle off `Unused arguments`, `Unused signal` and `Return value discarded`, and any other that might come up too often and don't want to see. - + -Finally, set the initial window size in *Project -> Project settings... -> General*, select *Display/Window* and set *Size/Width* and *Size/Height* to `600` and `800`, respectively. As well as the *Stretch/Mode* to "viewport", and *Stretch/Aspect* to "keep": +Finally, set the initial window size in *Project -> Project settings... -> General*, select *Display/Window* and set *Size/Width* and *Size/Height* to `600` and `800`, respectively. As well as the *Stretch/Mode* to `viewport` , and *Stretch/Aspect* to `keep`: - + -#### Keybindings +### Keybindings -I only used 3 actions (keybindings): jump, restart and toggle_debug (optional). To add custom keybindings (so that the `Input.something()` API can be used), go to *Project -> Project settings... -> Input Map* and on the text box write "jump" and click add, then it will be added to the list and it's just a matter of clicking the `+` sign to add a "Physical key", press any key you want to be used to jump and click ok. Do the same for the rest of the actions. +I only used 3 actions (keybindings): jump, restart and toggle_debug (optional). To add custom keybindings (so that the `Input.something()` API can be used), go to *Project -> Project settings... -> Input Map* and on the text box write `jump` and click add, then it will be added to the list and it's just a matter of clicking the `+` sign to add a *Physical key*, press any key you want to be used to jump and click ok. Do the same for the rest of the actions. - + -#### Layers +### Layers -Finally, rename the physics layers so we don't lose track of which layer is which. Go to *Project -> Layer Names -> 2d Physics* and change the first 5 layer names to (in order): "player", "ground", "pipe", "ceiling" and "score". +Finally, rename the physics layers so we don't lose track of which layer is which. Go to *Project -> Layer Names -> 2d Physics* and change the first 5 layer names to (in order): `player`, `ground`, `pipe`, `ceiling` and `score`. - + -## Assets +# Assets For the assets I found out about a pack that contains just what I need: [flappy-bird-assets](https://megacrash.itch.io/flappy-bird-assets) by [MegaCrash](https://megacrash.itch.io/); I just did some minor modifications on the naming of the files. For the font I used [Silver](https://poppyworks.itch.io/silver), and for the sound the resources from [FlappyBird-N64](https://github.com/meeq/FlappyBird-N64) (which seems to be taken from [101soundboards.com](https://www.101soundboards.com/boards/10178-flappy-bird-sounds) which the orignal copyright holder is [.Gears](https://dotgears.com/) anyways). -### Importing +## Importing -Create the necessary directories to hold the respective assets and it's just a matter of dragging and dropping, I used directories: `res://entities/actors/player/sprites/`, `res://fonts/`, `res://levels/world/background/sprites/`, `res://levels/world/ground/sprites/`, `res://levels/world/pipe/sprites/`, `res://sfx/`. For the player sprites, the "FileSystem" window looks like this (`entities/actor` directories are really not necessary): +Create the necessary directories to hold the respective assets and it's just a matter of dragging and dropping, I used directories: `res://entities/actors/player/sprites/`, `res://fonts/`, `res://levels/world/background/sprites/`, `res://levels/world/ground/sprites/`, `res://levels/world/pipe/sprites/`, `res://sfx/`. For the player sprites, the +*FileSystem* window looks like this (`entities/actor` directories are really not necessary): - + It should look similar for other directories, except maybe for the file extensions. For example, for the sfx: - + -## Scenes +# Scenes Now it's time to actually create the game, by creating the basic scenes that will make up the game. The hardest part and the most confusing is going to be the *TileMaps*, so that goes first. -### TileMaps +## TileMaps -I'm using a scene called "WorldTiles" with a *Node2D* node as root called the same. With 2 different *TileMap* nodes as children named "GroundTileMap" and "PipeTileMap" (these are their own scene); yes 2 different *TileMaps* because we need 2 different physics colliders (In Godot 4.0 you can have a single *TileMap* with different physics colliders in it). Each node has its own script. It should look something like this: +I'm using a scene called `WorldTiles` with a *Node2D* node as root called the same. With 2 different *TileMap* nodes as children named `GroundTileMap` and `PipeTileMap` (these are their own scene); yes 2 different *TileMaps* because we need 2 different physics colliders (in *Godot 4.0* you can have a single *TileMap* with different physics colliders in it). Each node has its own script. It should look something like this: - + I used the following directory structure: - + -To configure the GroundTileMap, select the node and click on "(empty)" on the *TileMap/Tile set* property and then click on "New TileSet", then click where the "(empty)" used to be, a new window should open on the bottom: +To configure the `GroundTileMap`, select the node and click on `(empty)` on the *TileMap/Tile set* property and then click on `New TileSet`, then click where the `(empty)` used to be, a new window should open on the bottom: - + -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: +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: - + -We need to do this because for some reason we can't change the snap options before selecting a tile. After selecting a random tile, set up the *Snap Options/Step* (in the *Inspector*) and set it to 16x16 (or if using a different tile set, to it's tile size): +We need to do this because for some reason we can't change the snap options before selecting a tile. After selecting a random tile, set up the *Snap Options/Step* (in the *Inspector*) and set it to `16x16` (or if using a different tile set, to it's tile size): - + -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: +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: - + Do the same for the other 3 tiles. If you select the *TileMap* itself again, it should look like this on the right (on default layout it's on the left of the *Inspector*): - + The ordering is important only for the "underground tile", which is the filler ground, it should be at the end (index 3); if this is not the case, repeat the process (it's possible to rearrange them but it's hard to explain as it's pretty weird). -At this point the tilemap doesn't have any physics and the cell size is wrong. Select the "GroundTileMap", set the *TileMap/Cell/Size* to 16x16, the *TileMap/Collision/Layer* set to `bit 2` only (ground layer) and disable any *TileMap/Collision/Mask* bits. Should look something like this: +At this point the tilemap doesn't have any physics and the cell size is wrong. Select the `GroundTileMap`, set the *TileMap/Cell/Size* to `16x16`, the *TileMap/Collision/Layer* set to `bit 2` only (ground layer) and disable any *TileMap/Collision/Mask* bits. Should look something like this: - + -Now it's just a matter of repeating the same for the pipes ("PipeTileMap"), only difference is that when selecting the tiles you need to select 2 tiles, as the pipe is 2 tiles wide, or just set the *Snap Options/Step* to 32x16, for example, just keep the cell size to 16x16. +Now it's just a matter of repeating the same for the pipes (`PipeTileMap`), only difference is that when selecting the tiles you need to select 2 tiles, as the pipe is 2 tiles wide, or just set the *Snap Options/Step* to `32x16`, for example, just keep the cell size to `16x16`. -#### Default ground tiles +### Default ground tiles -I added few default ground tiles to the scene, just for testing purposes but I left them there. These could be place programatically, but I was too lazy to change things. On the "WorldTiles" scene, while selecting the "GroundTileMap", you can select the tiles you want to paint with, and left click in the grid to paint with the selected tile. Need to place tiles from `(-8, 7)` to `(10, 7)` as well as the tile below with the filler ground (the tile position/coordinates show at the bottom left, refer to the image below): +I added few default ground tiles to the scene, just for testing purposes but I left them there. These could be place programatically, but I was too lazy to change things. On the `WorldTiles` scene, while selecting the `GroundTileMap`, you can select the tiles you want to paint with, and left click in the grid to paint with the selected tile. Need to place tiles from `(-8, 7)` to `(10, 7)` as well as the tile below with the filler ground (the tile position/coordinates show at the bottom left, refer to the image below): - + -### Player +## Player -On a new scene called "Player" with a *KinematicBody2D* node named "Player" as the root of the scene, then for the children: *AnimatedSprite* as "Sprite", *CollisionShape2D* as "Collision" (with a circle shape) and 3 *AudioStreamPlayers* for "JumpSound", "DeadSound" and "HitSound". Not sure if it's a good practice to have the audio here, since I did that at the end, pretty lazy. Then, attach a script to the "Player" node and then it should look like this: +On a new scene called `Player` with a *KinematicBody2D* node named `Player` as the root of the scene, then for the children: *AnimatedSprite* as `Sprite`, *CollisionShape2D* as `Collision` (with a circle shape) and 3 *AudioStreamPlayers* for `JumpSound`, `DeadSound` and `HitSound`. Not sure if it's a good practice to have the audio here, since I did that at the end, pretty lazy. Then, attach a script to the `Player` node and then it should look like this: - + -Select the "Player" node and set the *CollisionShape2D/Collision/Layer* to 1 and the *CollisionObject2D/Collision/Mask* to 2 and 3 (ground and pipe). +Select the `Player` node and set the *CollisionShape2D/Collision/Layer* to `1` and the *CollisionObject2D/Collision/Mask* to `2` and `3` (ground and pipe). -For the "Sprite" node, when selecting it click on the "(empty)" for the *AnimatedSprite/Frames* property and click "New SpriteFrames", click again where the "(empty)" used to be and ane window should open on the bottom: +For the `Sprite` node, when selecting it click on the `(empty)` for the *AnimatedSprite/Frames* property and click `New SpriteFrames`, click again where the `(empty)` used to be and ane window should open on the bottom: - + -Right off the bat, set the "Speed" to `10 FPS` (bottom left) and rename "default" to "bird_1". With the "bird_1" selected, click on the "Add frames from a Sprite Sheet", which is the second button under "Animation Frames:" which looks has an icon of a small grid (next to the folder icon), a new window will popup where you need to select the respective sprite sheet to use and configure it for importing. On the "Select Frames" window, change the "Vertical" to 1, and then select all 4 frames (*Ctrl + Scroll* wheel to zoom in): +Right off the bat, set the `Speed` to `10 FPS` (bottom left) and rename `default` to `bird_1`. With the `bird_1` selected, click on the `Add frames from a Sprite Sheet`, which is the second button under `Animation Frames:` which looks has an icon of a small grid (next to the folder icon), a new window will popup where you need to select the respective sprite sheet to use and configure it for importing. On the `Select Frames` window, change the `Vertical` to `1`, and then select all 4 frames (*Ctrl + Scroll* wheel to zoom in): - + After that, the *SpriteFrames* window should look like this: - + -Finally, make sure the "Sprite" node has the *AnimatedSprite/Animation* 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 *AudioStreamPlayer* (into the *AudioStreamPlayer/Stream* property). +Finally, make sure the `Sprite` node has the *AnimatedSprite/Animation* 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 *AudioStreamPlayer* (into the *AudioStreamPlayer/Stream* property). -### Other +## Other These are really simple scenes that don't require much setup: -- "CeilingDetector": just an *Area2D* node with a *CollisionShape2D* in the form of a rectangle (*CollisionShape2D/Shape/extents* to `(120, 10)`), stretched horizontally so it fits the whole screen. *CollisionObject2D/Collision/Layer* set to `bit 4` (ceiling) and *CollisionObject2D/Collision/Mask* set to bit 1 (player). -- "ScoreDetector": similar to the "CeilingDetector", but vertical (*CollisionShape2D/Shape/extents* to `(2.5, 128)`) and *CollisionObject2D/Collision/Layer* set to `bit 1` (player). -- "WorldDetector": *Node2D* with a script attached, and 3 *RayCast2D* as children: - - "NewTile": *Raycast2D/Enabled* to true (checked), *Raycast2D/Cast To* `(0, 400)`, *Raycast2D/Collision Mask* to `bit 2` (ground) and *Node2D/Transform/Position* to `(152, -200)` - - "OldTile": same as "NewTile", except for the *Node2D/Transform/Position*, set it to `(-152, -200)`. - - "OldPipe": same as "OldTile", except for the *Raycast2D/Collision Mask*, set it to `bit 3` (pipe). +- `CeilingDetector`: just an *Area2D* node with a *CollisionShape2D* in the form of a rectangle (*CollisionShape2D/Shape/extents* to `(120, 10)`), stretched horizontally so it fits the whole screen. *CollisionObject2D/Collision/Layer* set to `bit 4` (ceiling) and *CollisionObject2D/Collision/Mask* set to `bit 1` (player). +- `ScoreDetector`: similar to the `CeilingDetector`, but vertical (*CollisionShape2D/Shape/extents* to `(2.5, 128)`) and *CollisionObject2D/Collision/Layer* set to `bit 1` (player). +- `WorldDetector`: *Node2D* with a script attached, and 3 *RayCast2D* as children: + - `NewTile`: *Raycast2D/Enabled* to true (checked), *Raycast2D/Cast To* `(0, 400)`, *Raycast2D/Collision Mask* to `bit 2` (ground) and *Node2D/Transform/Position* to `(152, -200)` + - `OldTile`: same as "NewTile", except for the *Node2D/Transform/Position*, set it to `(-152, -200)`. + - `OldPipe`: same as "OldTile", except for the *Raycast2D/Collision Mask*, set it to `bit 3` (pipe). -### Game +## Game -This is the actual "Game" scene that holds all the playable stuff, here we will drop in all the previous scenes; the root node is a *Node2D* and also has an attached script. Also need to add 2 additional *AudioStreamPlayers* for the "start" and "score" sounds, as well as a *Sprite* for the background (*Sprite/Offset/Offset* set to `(0, 10)`) and a *Camera2D* (*Camera2D/Current* set to true (checked)). It should look something like this: +This is the actual `Game` scene that holds all the playable stuff, here we will drop in all the previous scenes; the root node is a *Node2D* and also has an attached script. Also need to add 2 additional *AudioStreamPlayers* for the "start" and "score" sounds, as well as a *Sprite* for the background (*Sprite/Offset/Offset* set to `(0, 10)`) and a *Camera2D* (*Camera2D/Current* set to true (checked)). It should look something like this: - + The scene viewport should look something like the following: - + -### UI +## UI -#### Fonts +### Fonts -We need some font "Resources" to style the *Label* fonts. Under the *FileSystem* window, right click on the fonts directory (create one if needed) and click on "New Resource..." and select *DynamicFontData*, save it in the "fonts" directory as "SilverDynamicFontData.tres" ("Silver" as it is the font I'm using) then double click the just created resource and set the *DynamicFontData/Font Path* to the actual "Silver.ttf" font (or whatever you want). +We need some font `Resources` to style the *Label* fonts. Under the *FileSystem* window, right click on the fonts directory (create one if needed) and click on `New Resource...` and select *DynamicFontData*, save it in the "fonts" directory as `SilverDynamicFontData.tres` (`Silver` as it is the font I'm using) then double click the just created resource and set the *DynamicFontData/Font Path* to the actual `Silver.ttf` font (or whatever you want). -Then create a new resource and this time select *DynamicFont*, name it "SilverDynamicFont.tres", then double click to edit and add the "SilverDynamicFontData.tres" to the *DynamicFont/Font/Font Data* property (and I personally toggled off the *DynamicFont/Font/Antialiased* property), now just set the *DynamicFont/Settings/(Size, Outline Size, Outline Color)* to 32, 1 and black, respectively (or any other values you want). It should look something like this: +Then create a new resource and this time select *DynamicFont*, name it `SilverDynamicFont.tres`, then double click to edit and add the `SilverDynamicFontData.tres` to the *DynamicFont/Font/Font Data* property (and I personally toggled off the *DynamicFont/Font/Antialiased* property), now just set the *DynamicFont/Settings/(Size, Outline Size, Outline Color)* to `32`, `1` and `black`, respectively (or any other values you want). It should look something like this: - + -Do the same for another *DynamicFont* which will be used for the score label, named "SilverScoreDynamicFont.tres". Only changes are *Dynamic/Settings/(Size, Outline Size)* which are set to 128 and 2, respectively. The final files for the fonts should look something like this: +Do the same for another *DynamicFont* which will be used for the score label, named `SilverScoreDynamicFont.tres`. Only changes are *Dynamic/Settings/(Size, Outline Size)* which are set to `128` and `2`, respectively. The final files for the fonts should look something like this: - + -#### Scene setup +### Scene setup -This has a bunch of nested nodes, so I'll try to be concise here. The root node is a *CanvasLayer* named "UI" with its own script attached, and for the children: +This has a bunch of nested nodes, so I'll try to be concise here. The root node is a *CanvasLayer* named `UI` with its own script attached, and for the children: -- "MarginContainer": *MarginContainer* with *Control/Margin/(Left, Top)* set to `10` and *Control/Margin/(Right, Bottom)* set to `-10`. - - "InfoContainer": *VBoxContainer* with *Control/Theme Overrides/Constants/Separation* set to `250`. - - "ScoreContainer": *VBoxContainer*. - - "Score": *Label* with *Label/Align* set to "Center", *Control/Theme Overrides/Fonts/Font* to the "SilverScoreDynamicFont.tres", if needed adjust the *DynamicFont* settings. - - "HighScore: same as "Score", escept for the *Control/Theme Overrides/Fonts/Font* which is set to "SilverDynamicFont.tres". - - "StartGame": Same as "HighScore". - - "DebugContainer": *VBoxContainer*. - - "FPS": *Label*. - - "VersionContainer": *VBoxContainer* with *BoxContainer/Alignment* set to "Begin". - - "Version": *Label* with *Label/Align* set to "Right". +- `MarginContainer`: *MarginContainer* with *Control/Margin/(Left, Top)* set to `10` and *Control/Margin/(Right, Bottom)* set to `-10`. + - `InfoContainer`: *VBoxContainer* with *Control/Theme Overrides/Constants/Separation* set to `250`. + - `ScoreContainer`: *VBoxContainer*. + - `Score`: *Label* with *Label/Align* set to `Center`, *Control/Theme Overrides/Fonts/Font* to the `SilverScoreDynamicFont.tres`, if needed adjust the *DynamicFont* settings. + - `HighScore`: same as `Score`, escept for the *Control/Theme Overrides/Fonts/Font* which is set to `SilverDynamicFont.tres`. + - `StartGame`: Same as `HighScore`. + - `DebugContainer`: *VBoxContainer*. + - `FPS`: *Label*. + - `VersionContainer`: *VBoxContainer* with *BoxContainer/Alignment* set to `Begin`. + - `Version`: *Label* with *Label/Align* set to `Right`. The scene ends up looking like this: - + -### Main +## Main -This is the final scene where we connect the Game and the UI. It's made of a *Node2D* with it's own script attached and an instance of "Game" and "UI" as it's children. +This is the final scene where we connect the `Game` and the `UI`. It's made of a *Node2D* with it's own script attached and an instance of `Game` and `UI` as it's children. -This is a good time to set the default scene when we run the game by going to *Project -> Project settings... -> General* and in *Application/Run* set the *Main Scene* to the "Main.tscn" scene. +This is a good time to set the default scene when we run the game by going to *Project -> Project settings... -> General* and in *Application/Run* set the *Main Scene* to the `Main.tscn` scene. -## Scripting +# Scripting 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 [source code](https://github.com/luevano/flappybird_godot). 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. -### Player +## Player -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 (`y` coordinate is reversed in godot...), we also check the velocity sign of the `y` coordinate to decide if the animation is playing or not. +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 (`y` coordinate is reversed in godot...), we also check the velocity sign of the `y` coordinate to decide if the animation is playing or not. ```gdscript class_name Player @@ -275,7 +281,7 @@ func _emit_player_died() -> void: 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. -### WorldDetector +## WorldDetector 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: @@ -299,9 +305,9 @@ func _now_colliding(detector: RayCast2D, flag: bool, signal_name: String) -> boo We need to keep track of 3 "flags": `ground_was_colliding`, `ground_now_colliding` and `pipe_now_colliding` (and their respective signals), which are going to be used to do the checks inside `_physics_process`. For example for checking for new ground: `ground_now_colliding = _now_colliding(old_ground, ground_now_colliding, "ground_started_colliding")`. -### WorldTiles +## WorldTiles -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 *TileMaps* and just tracking how many pipes have been placed: +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 *TileMaps* and just tracking how many pipes have been placed: ```gdscript export(int, 2, 20, 2) var PIPE_SEP: int = 6 @@ -325,7 +331,7 @@ func _on_WorldDetector_pipe_started_colliding() -> void: emit_signal("remove_pipe") ``` -#### GroundTileMap +### GroundTileMap 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 `enum`s so I used them to define the possible `Ground` tiles: @@ -364,11 +370,11 @@ func _remove_first_ground() -> void: Where you might notice that the `_initial_new_tile_x` is `11`, instead of `10`, refer to [Default ground tiles](#default-ground-tiles) where we placed tiles from `-8` to `10`, so the next empty one is `11`. These `_place_new_ground` and `_remove_first_ground` functions are called upon receiving the signal. -#### PipeTileMap +### PipeTileMap -This is really similar to the "GroundTileMap" code, instead of defining an `enum` for the ground tiles, we define it for the pipe patterns (because each pipe is composed of multiple pipe tiles). If your pipe tile set looks like this (notice the index): +This is really similar to the `GroundTileMap` code, instead of defining an `enum` for the ground tiles, we define it for the pipe patterns (because each pipe is composed of multiple pipe tiles). If your pipe tile set looks like this (notice the index): - + Then you can use the following "pipe patterns": @@ -383,7 +389,7 @@ var pipe: Dictionary = { } ``` -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: +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: ```gdscript onready var _pipe_sep: int = get_parent().PIPE_SEP @@ -402,7 +408,7 @@ var detector_offset: Vector2 = Vector2(16.0, -(_pipe_size / 2.0) * 16.0) var detector_stack: Array ``` -The `detector_offset` 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" (`detector_scene`) 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: +The `detector_offset` 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` (`detector_scene`) 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: ```gdscript func _place_new_pipe() -> void: @@ -439,9 +445,9 @@ func _remove_old_pipe() -> void: These functions are called when receiving the signal to place/remove pipes. -### Saved data +## Saved data -Before proceeding, we require a way to save/load data (for the high scores). We're going to use the *ConfigFile* node that uses a custom version of the "ini" file format. Need to define where to save the data: +Before proceeding, we require a way to save/load data (for the high scores). We're going to use the *ConfigFile* node that uses a custom version of the `ini` file format. Need to define where to save the data: ```gdscript const DATA_PATH: String = "user://data.cfg" @@ -496,11 +502,11 @@ func _ready() -> void: save_data() ``` -Now, this script in particular will need to be a [Singleton (AutoLoad)](https://docs.godotengine.org/en/stable/tutorials/scripting/singletons_autoload.html), which means that there will be only one instance and will be available across all scripts. To do so, go to *Project -> Project settings... -> AutoLoad* and select this script in the "Path:" and add a "Node Name:" (I used "SavedData", if you use something else, be careful while following this devlog) which will be the name we'll use to access the singleton. Toggle on "Enable" if needed, it should look like this: +Now, this script in particular will need to be a [Singleton (AutoLoad)](https://docs.godotengine.org/en/stable/tutorials/scripting/singletons_autoload.html), which means that there will be only one instance and will be available across all scripts. To do so, go to *Project -> Project settings... -> AutoLoad* and select this script in the `Path:` and add a `Node Name:` (I used `SavedData`, if you use something else, be careful while following this devlog) which will be the name we'll use to access the singleton. Toggle on `Enable` if needed, it should look like this: - + -### Game +## Game 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 `_process` and `_physics_process` methods from the childs as needed. First, we need to define the signals and and references to all child nodes: @@ -519,7 +525,7 @@ onready var start_sound: AudioStreamPlayer = $StartSound onready var score_sound: AudioStreamPlayer = $ScoreSound ``` -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 `player_speed`: +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 `player_speed`: ```gdscript var _game_scale: float = ProjectSettings.get_setting("application/config/game_scale") @@ -532,7 +538,7 @@ func _ready() -> void: player_speed = player.SPEED / _game_scale ``` -This `player_speed` will be needed as we need to move all the nodes ("Background", "Camera", etc.) in the `x` axis as the player is moving. This is done in the `_physics_process`: +This `player_speed` will be needed as we need to move all the nodes (`Background`, `Camera`, etc.) in the `x` axis as the player is moving. This is done in the `_physics_process`: ```gdscript func _physics_process(delta: float) -> void: @@ -589,9 +595,9 @@ func _on_ScoreDetector_body_entered(body: Node2D) -> void: score_sound.play() ``` -When the `player` dies, we set all processing to `false`, 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 `high_score` at the beginning by calling `SavedData.get_high_score()`. This signal we emit will be received by the UI so it updates accordingly. +When the `player` dies, we set all processing to `false`, 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 `high_score` at the beginning by calling `SavedData.get_high_score()`. This signal we emit will be received by the `UI` so it updates accordingly. -### UI +## UI First thing is to get a reference to all the child *Labels*, an initial reference to the high score as well as the version defined in the project settings: @@ -648,9 +654,9 @@ func _on_Game_new_score(score: int, high_score: int) -> void: high_score_label.set_text("High score: %s" % high_score) ``` -### Main +## Main -This is the shortest script, it just connects the signals between the "Game" and the "UI": +This is the shortest script, it just connects the signals between the `Game` and the `UI`: ```gdscript onready var game: Game = $Game @@ -665,20 +671,20 @@ func _ready() -> void: game.connect("new_score", ui, "_on_Game_new_score") ``` -## Final notes and exporting +# Final notes and exporting 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. -### Preparing the files +## Preparing the files If you followed the directory structure I used, then only thing needed is to transform the icon to a native Windows `ico` format (if exporting to Windows, else ignore this part). For this you need [ImageMagick](https://imagemagick.org/index.php) or some other program that can transform `png` (or whatever file format you used for the icon) to `ico`. I used [Chocolatey][https://chocolatey.org/] to install `imagemagick`, then to convert the icon itself used: `magick convert icon.png -define icon:auto-resize=256,128,64,48,32,16 icon.ico` as detailed in *Godot*'s [Changing application icon for Windows](https://docs.godotengine.org/en/stable/tutorials/export/changing_application_icon_for_windows.html). -### Exporting +## Exporting -You need to download the templates for exporting as detailed in *Godot*'s [Exporting projects](https://docs.godotengine.org/en/stable/tutorials/export/exporting_projects.html). Basically you go to *Editor -> Manage Export Templates...* and download the latest one specific to your *Godot* version by clicking on "Download and Install". +You need to download the templates for exporting as detailed in *Godot*'s [Exporting projects](https://docs.godotengine.org/en/stable/tutorials/export/exporting_projects.html). Basically you go to *Editor -> Manage Export Templates...* and download the latest one specific to your *Godot* version by clicking on `Download and Install`. If exporting for Windows then you also need to download `rcedit` from [here](https://github.com/electron/rcedit/releases/latest). Just place it wherever you want (I put it next to the *Godot* executable). -Then go to *Project -> Export...* 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.. +Then go to *Project -> Export...* 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.. -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. +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. diff --git a/src/blog/g/godot_project_structure.md b/src/blog/g/godot_project_structure.md index 3f013cc..b826516 100644 --- a/src/blog/g/godot_project_structure.md +++ b/src/blog/g/godot_project_structure.md @@ -3,6 +3,7 @@ author: David Luévano lang: en summary: Details on the project structure I'm using for Godot, based on preference and some research I did. tags: gamedev + godot short english diff --git a/src/blog/g/gogodot_jam3_devlog_1.md b/src/blog/g/gogodot_jam3_devlog_1.md index 9e836b1..749356b 100644 --- a/src/blog/g/gogodot_jam3_devlog_1.md +++ b/src/blog/g/gogodot_jam3_devlog_1.md @@ -4,47 +4,52 @@ lang: en summary: Details on the implementation for the game I created for the Go Godot Jam 3, which theme is Evolution. tags: gamedev godot + gdscript gamejam english -The jam's theme is Evolution and all the details are listed [here](https://itch.io/jam/go-godot-jam-3). ~~This time I'm logging as I go, so there might be some changes to the script or scenes along the way~~ ^^I couldn't actually do this, as I was running out of time.^^. Note that I'm not going to go into much details, the obvious will be ommitted. +The jam's theme is Evolution and all the details are listed [here](https://itch.io/jam/go-godot-jam-3). ~~This time I'm logging as I go, so there might be some changes to the script or scenes along the way.~~ ^^I couldn't actually do this, as I was running out of time^^. Note that I'm not going to go into much details, the obvious will be ommitted. I wanted to do a *Snake* clone, and I'm using this jam as an excuse to do it and add something to it. The features include: - Snakes will pass their stats in some form to the next snakes. - Non-grid snake movement. I just hate the grid constraint, so I wanted to make it move in any direction. -- Depending on the food you eat, you'll gain new mutations/abilities ~~and the more you eat the more that mutation develops.~~ ^^didn't have time to add this feature, sad.^^ +- Depending on the food you eat, you'll gain new mutations/abilities ~~and the more you eat the more that mutation develops~~ ^^didn't have time to add this feature, sad^^. - Procedural map creation. -I created this game using *Godot 3.5-rc3*. You can find the source code in my GitHub [here](https://github.com/luevano/gogodot_jam3) which at the time of writing this it doesn't contain any exported files, for that you can go ahead and play it in your browser at itch.io, which you can find below: +I created this game using *Godot 3.5-rc3*. You can find the source code in my GitHub [here](https://github.com/luevano/gogodot_jam3) which at the time of writing this it doesn't contain any exported files, for that you can go ahead and play it in your browser at [itch.io](https://lorentzeus.itch.io/snake-tronic), which you can find below: -<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 style="text-align:center"><iframe src="https://itch.io/embed/1562701?dark=true" width="208" height="167" frameborder="0"><a href="https://lorentzeus.itch.io/snake-tronic">Snake-tronic by Lorentzeus</a></iframe></p> You can also find the jam entry [here](https://itch.io/jam/go-godot-jam-3/rate/1562701). Similarly with the my FlappyBird clone, I plan to update this to a better state. -## Initial setup +# Table of contents -Again, similar to the [FlappyBird](https://blog.luevano.xyz/g/flappybird_godot_devlog_1.html) clone I developed, I'm using the directory structure I wrote about on [Godot project structure](https://blog.luevano.xyz/g/godot_project_structure.html) with slight modifications to test things out. Also using similar *Project settings* as those from the *FlappyBird* clone like the pixel art texture imports, keybindings, layers, etc.. +[TOC] -I've also setup [GifMaker](https://github.com/bram-dingelstad/godot-gifmaker), with slight modifications as the *AssetLib* doesn't install it correctly and contains unnecessry stuff: moved necessary files to the `res://addons` directory, deleted test scenes and files in general, and copied the license to the `res://docs` directory. Setting this up was a bit annoying because the tutorial it's bad (with all due respect). I might do a separate entry just to explain how to set it up, because I couldn't find it anywhere other than by inspecting some of the code/scenes.^^I ended up not leaving this enabled in the game as it lagged the game out, but it's an option I'll end up researching more.^^ +# Initial setup + +Again, similar to the [FlappyBird](https://blog.luevano.xyz/g/flappybird_godot_devlog_1.html) clone I created, I'm using the directory structure I wrote about on [Godot project structure](https://blog.luevano.xyz/g/godot_project_structure.html) with slight modifications to test things out. Also using similar *Project settings* as those from the *FlappyBird* clone like the pixel art texture imports, keybindings, layers, etc.. + +I've also setup [GifMaker](https://github.com/bram-dingelstad/godot-gifmaker), with slight modifications as the *AssetLib* doesn't install it correctly and contains unnecessry stuff: moved necessary files to the `res://addons` directory, deleted test scenes and files in general, and copied the license to the `res://docs` directory. Setting this up was a bit annoying because the tutorial it's bad (with all due respect). I might do a separate entry just to explain how to set it up, because I couldn't find it anywhere other than by inspecting some of the code/scenes. ^^I ended up leaving this disabled in the game as it hit the performance by a lot, but it's an option I'll end up researching more^^. This time I'm also going to be using an [Event bus](https://www.gdquest.com/docs/guidelines/best-practices/godot-gdscript/event-bus/) singleton (which I'm going to just call *Event*) as managing signals was pretty annoying on my last project; as well as a *Global* singleton for essential stuff so I don't have to do as many cross references between nodes/scenes. -## Assets +# Assets This time I'll be creating my own assets in [Aseprite](https://www.aseprite.org/), wont be that good, but enough to prototype and get things going. Other than that I used few key sprites from [vryell](https://vryell.itch.io/): [Controller & Keyboard Icons](https://vryell.itch.io/controller-keyboard-icons) and a font from [datagoblin](https://datagoblin.itch.io/): [Monogram](https://datagoblin.itch.io/monogram). -## The snake +# The snake This is the most challenging part in my opinion as making all the body parts follow the head in a user defined path it's kinda hard. I tried with like 4-5 options and the one I'm detailing here is the only one that worked as I wanted for me. This time the directory structure I'm using is the following: - + -### Basic movement +## Basic movement The most basic thing is to move the head, this is what we have control of. Create a scene called `Head.tscn` and setup the basic *KinematicBody2D* with it's own *Sprite* and *CollisionShape2D* (I used a small circle for the tip of the head), and set the *Collision Layer/Mask* accordingly, for now just `layer = bit 1`. And all we need to do, is keep moving the snake forwards and be able to rotate left or right. Created a new script called `head.gd` attached to the root (*KinematicBody2D*) and added: @@ -79,9 +84,9 @@ func _rotate_to(direction: int) -> void: After tunning all the necessary parameters you should get something like this: - + -### Setting up path following +## Setting up path following To move other snake parts by following the snake head the only solution I found was to use the *Path2D* and *PathFollow2D* nodes. *Path2D* basically just handles the curve/path that *PathFollow2D* will use to move its child node; and I say "child node" in singular... as *PathFollow2D* can only handle one damn child, all the other ones will have weird transformations and/or rotations. So, the next thing to do is to setup a way to compute (and draw so we can validate) the snake's path/curve. @@ -123,9 +128,9 @@ func _on_Head_snake_path_new_point(coordinates: Vector2) -> void: With this, we're now populating the *Path2D* curve points with the position of the snake head. You should be able to see it because of the `_draw` call. If you run it you should see something like this: - + -### Define body parts for the snake +## Define body parts for the snake At this point the only thing to do is to add the corresponding next body parts and tail of the snake. To do so, we need a *PathFollow2D* to use the live-generating *Path2D*, the only caveat is that we need one of these per body part/tail (this took me hours to figure out, *thanks documentation*). @@ -143,7 +148,7 @@ func _physics_process(delta: float) -> void: And this can be attached to the *Body*'s root node (*PathFollow2D*), no extra setup needed. Repeat the same steps for creating the `Tail.tscn` scene and when attaching the `generic_segment.gd` script just configure the `Type` parameter to `tail` in the GUI (by selecting the node with the script attached and editing in the *Inspector*). -### Adding body parts +## Adding body parts Now it's just a matter of handling when to add new body parts in the `snake.gd` script. For now I've only setup for adding body parts to fulfill the initial length of the snake (this doesn't include the head or tail). The extra code needed is the following: @@ -176,7 +181,7 @@ func _on_Head_snake_path_new_point(coordinates: Vector2) -> void: Select the *Snake* node and add the *Body* and *Tail* scene to the parameters, respectively. Then when running you should see something like this: - + Now, we need to handle adding body parts after the snake is complete and already moved for a bit, this will require a queue so we can add part by part in the case that we eat multiple pieces of food in a short period of time. For this we need to add some signals: `snake_adding_new_segment(type)`, `snake_added_new_segment(type)`, `snake_added_initial_segments` and use them when makes sense. Now we need to add the following: @@ -225,9 +230,9 @@ func _add_segment_to_queue() -> void: body_segment_queue.append(body_segment_queue.back() + Global.SNAKE_SEGMENT_SIZE) ``` -With everything implemented and connected accordingly then we can add segments on demand (for testing I'm adding with a keystroke), it should look like this: +With everything implemented and connected accordingly then we can add segments on demand (for testing I'm adding with a key press), it should look like this: - + For now, this should be enough, I'll add more stuff as needed as I go. Last thing is that after finished testing that the movement felt ok, I just added a way to stop the snake whenever it collides with itself by using the following code (and the signal `snake_segment_body_entered(body)`) in a `main.gd` script that is the entry point for the game: @@ -242,7 +247,7 @@ func _snake_disabled(on_off: bool) -> void: Which will stop the snake node and all children. -### Fix on body segments following head +## Fix on body segments following head After a while of testing and developing, I noticed that sometimes the head "detaches" from the body when a lot of rotations happen (moving the snake left or right), because of how imprecise the *Curve2D* is. To do this I just send a signal (`snake_rotated`) whenever the snake rotates and make a small correction (in `generic_segment.gd`): @@ -253,7 +258,7 @@ func _on_snake_rotated() -> void: This is completely random, I tweaked it manually after a lot of iterations. -## The food +# The food For now I just decided to setup a simple system to see everything works fine. The idea is to make some kind of generic food node/scene and a "food manager" to spawn them, for now in totally random locations. For this I added the following signals: `food_placing_new_food(type)`, `food_placed_new_food(type)` and `food_eaten(type)`. @@ -310,17 +315,17 @@ func _place_new_food() -> void: And this is used in `_process` to place new food whenever needed. For now I added a condition to add food until 10 pieces are in place, and keep adding whenever the food is is lower than 10. After setting everything up, this is the result: - + -## Za warudo! (The world) +# Za warudo! (The world) It just happend that I saw a video to create random maps by using a method called [random walks](https://www.mit.edu/~kardar/teaching/projects/chemotaxis(AndreaSchmidt)/random.htm), this video was made by [NAD LABS](https://www.youtube.com/c/NADLABS): [Nuclear Throne Like Map Generation In Godot](https://www.youtube.com/watch?v=ppP2Doq3p7s). 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): - + - + - + It started with just black and white tiles, but I ended up adding some sprites as it was really harsh to the eyes. My implementation is basically the same as *NAD LABS*' with few changes, most importantly: I separated the generation in 2 diferent tilemaps (floor and wall) to have better control as well as wrapped everything in a single scene with a "main" script with the following important functions: @@ -341,7 +346,7 @@ Where `get_cells_around` is just a function that gets the safe cells around the Some signals I used for the world gen: `world_gen_walker_started(id)`, `world_gen_walker_finished(id)`, `world_gen_walker_died(id)` and `world_gen_spawn_walker_unit(location)`. -### Food placement +## Food placement The last food algorithm doesn't check anything related to the world, and thus the food could spawn in the walls and outside the map. @@ -404,13 +409,13 @@ func _get_random_pos() -> Array: Other than that, there are some differences between placing normal and special food (specially the signal they send, and if an extra "special points" property is set). Some of the signals that I used that might be important: `food_placing_new_food(type)`, `food_placed_new_food(type, location)` and `food_eaten(type, location)`. -## Stats clas and loading/saving data +# Stats clas and loading/saving data -I got the idea of saving the current stats (points, max body segments, etc.) in a separate *Stats* class for easier load/save data. This option I went with didn't work as I would liked it to work, as it was a pain in the ass to setup and each time a new property is added you have to manually setup the load/save helper functions... so not the best option. This option I used was json but saving a Node directly could work better or using resources (saving `tres` files). +I got the idea of saving the current stats (points, max body segments, etc.) in a separate `Stats` class for easier load/save data. This option I went with didn't work as I would liked it to work, as it was a pain in the ass to setup and each time a new property is added you have to manually setup the load/save helper functions... so not the best option. This option I used was json but saving a Node directly could work better or using resources (saving `tres` files). -### Stats class +## Stats class -The *Stats* "class" is just a script that extends from *Node* called `stats.gd`. It needs to define the `class_name` as `Stats`. The main content: +The `Stats` "class" is just a script that extends from *Node* called `stats.gd`. It needs to define the `class_name` as `Stats`. The main content: ```gdscript # main @@ -479,9 +484,9 @@ func set_stats(stats: Dictionary) -> void: And this is not scalable at all, but I had to do this at the end of the jam so no way of optimizing and/or doing it correctly, sadly. -### Load/save data +## Load/save data -The load/save function is pretty standard. It's a singleton/autoload called *SavedData* with a script that extends from *Node* called `save_data.gd`: +The load/save function is pretty standard. It's a singleton/autoload called `SavedData` with a script that extends from *Node* called `save_data.gd`: ```gdscript const DATA_PATH: String = "user://data.save" @@ -526,11 +531,11 @@ func _handle_new_file() -> void: file.close() ``` -It uses json as the file format, but I might end up changing this in the future to something else more reliable and easier to use (*Stats* class related issues). +It uses json as the file format, but I might end up changing this in the future to something else more reliable and easier to use (`Stats` class related issues). -## Scoring +# Scoring -For this I created a scoring mechanisms and just called it *ScoreManager* (`score_manager.gd`) which just basically listens to `food_eaten` signal and adds points accordingly to the current *Stats* object loaded. The main function is: +For this I created a scoring mechanisms and just called it `ScoreManager` (`score_manager.gd`) which just basically listens to `food_eaten` signal and adds points accordingly to the current *Stats* object loaded. The main function is: ```gdscript func _on_food_eaten(properties: Dictionary) -> void: @@ -578,7 +583,7 @@ Which will add the necessary points to `Stats.points` and return the amount of n Last thing is taht in `_process_points` there is a check at the end, where if the food eaten is "special" then a custom variation of the last 3 functions are executed. These are really similar, just specific to each kind of food. -This *ScoreManager* also handles the calculation for the `game_over` signal, to calculte progress, set necessary *Stats* values and save the data: +This `ScoreManager` also handles the calculation for the `game_over` signal, to calculte progress, set necessary `Stats` values and save the data: ```gdscript func _on_game_over() -> void: @@ -609,9 +614,9 @@ func _get_max_stats() -> Stats: Then this sends a signal `display_stats` to activate UI elements that shows the progression. -Naturally, the saved *Stats* are loaded whenever needed. For example, for the *Snake*, we load the stats and setup any value needed from there (like a flag to know if any ability is enabled), and since we're saving the new *Stats* at the end, then on restart we load the updated one. +Naturally, the saved `Stats` are loaded whenever needed. For example, for the `Snake`, we load the stats and setup any value needed from there (like a flag to know if any ability is enabled), and since we're saving the new `Stats` at the end, then on restart we load the updated one. -## Snake redesigned with the state machine pattern +# Snake redesigned with the state machine pattern I redesigned the snake code (the head, actually) to use the state machine pattern by following [this guide](https://gdscript.com/solutions/godot-state-machine/) which is definitely a great guide, straight to the point and easy to implement. @@ -638,7 +643,7 @@ func handle_slow_speeds() -> void: Event.emit_signal("game_over") ``` -And then in the *StateMachine*'s `_process`: +And then in the `StateMachine`'s `_process`: ```gdscript func _physics_process(delta: float) -> void: @@ -702,7 +707,7 @@ Where the important parts happen in the `enter` and `exit` functions. We need to For the other ones is the same. Only difference with the `jump_state.gd` is that the collision from head to body is disabled, and no rotation is allowed (by not calling the `rotate_on_input` function). -## Other minor stuff +# Other minor stuff Not as important but worth mentioning: @@ -717,8 +722,8 @@ Not as important but worth mentioning: - Refactored the nodes to make it work with `change_scene_to`, and added a main menu. - Added GUI for dead screen, showing the progress. -## Final notes +# Final notes -I actually didn't finish this game (as how I visualized it), but I got it in a playable state which is good. My big learning during this jam is the time management that it requires to plan and design a game. I lost a lot of time trying to implement some mechanics because I was facing many issues, because of my lack of practice (which was expected) as well as trying to blog and create the necessary sprites myself. Next time I should just get an asset pack and do something with it, as well as keeping the scope of my game shorter. +I actually didn't finish this game (as how I visualized it), but I got it in a *semi-playable* state which is good. My big learning during this jam is the time management that it requires to plan and design a game. I lost a lot of time trying to implement some mechanics because I was facing many issues, because of my lack of practice (which was expected) as well as trying to blog and create the necessary sprites myself. Next time I should just get an asset pack and do something with it, as well as keeping the scope of my game shorter. -For exporting and everything else, I went with what I did for my [FlappyBird Godot clone](https://blog.luevano.xyz/g/flappybird_godot_devlog_1#final-notes-and-exporting)
\ No newline at end of file +For exporting and everything else, I went with what I did for my [FlappyBird Godot clone: final notes and exporting](https://blog.luevano.xyz/g/flappybird_godot_devlog_1#final-notes-and-exporting) diff --git a/src/blog/g/starting_gamedev_blogging.md b/src/blog/g/starting_gamedev_blogging.md index 6fc518c..a5c7a37 100644 --- a/src/blog/g/starting_gamedev_blogging.md +++ b/src/blog/g/starting_gamedev_blogging.md @@ -3,12 +3,15 @@ author: David Luévano lang: en summary: Since I'm starting to get more into gamedev stuff, I'll start blogging about it just to keep consistent. tags: gamedev + godot update short english -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. +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 it again, and this time I'm trying to actually do stuff. So, the plan is to blog about my progress and clone some simple games just to get started. I'm thinking on sticking with [Godot](https://godotengine.org/) 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. ~~Specifically I'll start using *Godot 4* even though it's not done yet, to get used to the new features, specifically pumped for [GDScript 2.0](https://godotengine.org/article/gdscript-progress-report-feature-complete-40).~~ ^^Actually... (for the small clones/ripoffs) I'll need to use *Godot 3.X* (probably 3.5), as *Godot 4* doesn't have support to export to webassembly (HTML5) yet, and I want that to publish to [itch.io](https://itch.io/) and my website. I'll continue to use *Godot 4* 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.^^ -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 *developing* (FlappyBird L O L) shortly.
\ No newline at end of file +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 *developing* (FlappyBird L O L) shortly. + +**Update**: [Godot 4](https://godotengine.org/article/godot-4-0-sets-sail/) already released and it now has HTML5 support, so back to the original plan. |