/Cat-aclysm-Claw-of-the-Dead

A Tower Defense game in zombie apocalypse theme. You play with cats, and you have to defend your city from the zombie invasion using towers.

Primary LanguageGDScriptGNU General Public License v3.0GPL-3.0

Cat'aclysm: Claw of the Dead

A Tower Defense game in zombie apocalypse theme. You play with cats, and you have to defend your city from the zombie invasion using towers.

Engine

The game is made with Godot Engine 4.0.2.

GitHub

Commit :

type(scope): subject

  • type: type of commit
  • scope: the scope that is affected by this commit 1 to 2 word, can contain space
  • subject: a short description of the commit, around 20 words max, can contain capitalization or not

Types :

  • ci : Change of files and scripts related to continuous integration
  • chore : Change of the build system or development tools
  • feat : New feature
  • fix : Bug fix
  • perf : Optimization of the code to improve performance
  • refactor : Modification of the code without changing functionality
  • style : Change to the code style
  • tweak : Small change to the code that doesn't change the functionality

Examples :

feat(zombies): Add new pigeon zombie.

fix(tower gui): fix tower name not being displayed correctly

refactor(animations): use animation player instead of animation tree for zombies

Project Files :

We are following the Godot conventions as presented here. Use the built-in editor from Godot to code or use any JetBrains IDE to edit godot scripts but do not use any other IDE.

Code Architecture :

/.gitignore
/project.godot
/assets/fonts/**.ttf : fonts
/assets/localization/**.po : localization files
/assets/scripts/**.gd : scripts
/assets/musics/**.mp3 : musics
/assets/sounds/**.ogg : sounds
/assets/sprites/particles/**.png : particles
/assets/sprites/towers/**.png : tower sprites
/assets/sprites/zombies/**.png : zombie sprites
/assets/themes/**.tres : themes
/scenes/main.tscn : main scene
/scenes/**.tscn : scenes

Code Style :

  • Everything is in english
  • Use snake_case for files
  • Use PascalCase for nodes
  • Use snake_case for variables, constants, functions and signals
  • Use PascalCase for classes, enums and autoloads
  • Name every node with its function on the parent node (or the object name if root)
  • Type everything unless it's obvious (e.g. var x: int = 1 is fine, but var x := 1 is simpler)
  • Have all safe lines everywhere possible without creating too many variables (ex: if you need to access a node once, don't create a variable just for that)
  • Cast every node to their types, ex : var player := $Player as Area2D;
  • Keep lines relatively short (140 characters max)
  • Use tabs for indentation
  • Use ; for every line

Exporting

The game is exported for the Windows platform on every release, other platforms may come later.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Authors