Code Monkey home page Code Monkey logo

godot_skeleton's Introduction

Godot Skeleton

Godot Skeleton logo with skull icon above

Godot Skeleton logo with skull icon above

๐ŸŽฎ Check it out in your browser ๐Ÿ“บ Watch the demo

Template repository for getting started with a new Godot game quickly. Godot Skeleton handles the boring stuff like main menu, pause menu, settings that persist and load from disk, and structuring your project.

Godot versions supported: 4.0+

Bugs/Features

  • Main Menu, Settings, Gameplay, and Pause scenes
  • Mouse, keyboard, and controller support by default
  • Sensible defaults
  • Convention over configuration
  • Easy to change
  • Ship quickly, ship often
  • Developed with all platforms in mind
  • Minimal yet stylish
  • Each scene has its own folder
  • Preconfigured exports for Web, Linux, macOS, and Windows
  • OS-aware menu options & settings
  • Build script for exports (requires Ruby and untested on Windows)
  • Automatically upload to itch.io if butler is installed

Use It

Set Your Game Up

  1. Add a title to your game and change the credits
  2. Configure exports
    • Change the bundle identifier for the MacOS export
    • Add or modify based on your game's needs
  3. Set up the [itch] section in export.cfg for your game on itch.io

Notes

  • Don't worry about keeping your game up to date with Godot Skeleton. It's intended to just be a starting point. When you use it again, it may have some improvements!
  • Gameplay defaults to a 2D scene, but you can easily change that for your game's needs.
  • Keyboard controls:
    • Config I:
      • Directional input: WASD
      • Confirm: J
      • Cancel: K
      • Pause: P
    • Config II:
      • Directional input: Arrows
      • Confirm: Z
      • Cancel: X
      • Pause: Esc
  • Joypad controls: Xbox config where bottom button is confirm
  • Settings config gets written to the userspace, see the docs for details on the per-OS location

More to come as I make more games with Godot!

Contribute

You're welcome to contribute fixes and improvements to Godot Skeleton. If you find your needs differ widely, fork it and maintain your own template! That way you'll have it for your own future projects.

Template License

Godot Skeleton is dedicated to the public domain. Use it for your own projects with no need for credit or attribution or anything. View the Unlicense for more details.


Delete above and fill out your own README!

Your Game

[describe your game]

Developing

  1. Install Godot 4
  2. Clone the repository
  3. Open up project.gdot

Build Exports

The export script uses Ruby for now (sorry). Run it with:

./export

godot must be present in your environment as an executable for the script to work.

If you configure [itch] in export.cfg with user (your handle) and game (your game slug) and have butler installed, your builds will automatically get pushed to itch.io.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.