Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.03 KB

README.md

File metadata and controls

54 lines (39 loc) · 2.03 KB

Game Base 2D for Godot 4

Check out the wiki for more info on how to use everything in this repo!

About

A base structure for 2D games using Godot 4.

It aims to include everything needed to create a polished 2D game, from movement scripts to screen postprocessing shaders, while leveraging the new features of Godot 4 and using a clean, scalable and extensible code architecture.

Install 💻

This repo uses Godot 4.1 and above!

Simply fork this repo and start working on your game! Some sample scenes are available under scenes/samples.

Itch.io Integration 🤖

This repo also contains workflows to automatically publish this game on itch.io, every time a commit is pushed to master. Check out this wiki page to learn how to set this up for your own game!

Content

Samples 🎮

  • A scene showcasing post-processing effects
  • A simple top-down scene
  • A simple platformer scene
  • A simple platformer character scene with a basin animation state machine setup

Game systems 🔧

  • A simple audio manager
  • Scene transition system with some cool effects!
  • A save system. Simply add nodes you want to save to a "Saveable" group to mark them for save!

UI 📝

  • A main menu
  • A settings menu with audio sliders
  • A pause menu
  • Save/Load game buttons
  • An dialog box for NPC and object interations
  • A shader based minimap!

Movement 🏃

  • Top-down movement
  • Side scroller movement with coyote jump and jump buffering

Shaders 🎨

  • Scene transition shaders
  • Post processing shaders, including blur, chromatic aberration, CRT effect and vignette
  • Shaders for in game effects, such as color flickering, color replace, 2D shake and outlines

Camera 🎥

  • Camera following
  • Camera 2D shake
  • Camera areas (the camera will stay in bounds while the player is inside that area)