• Stars
    star
    166
  • Rank 227,748 (Top 5 %)
  • Language GDScript
  • License
    MIT License
  • Created over 3 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🦊 Tooling for Godot 4

Fox License version

🦊 Fox provides many tools to help develop with Godot Engine

Godot functions and libs

You can use elements from the /fox folder:

  • generic static libs (Wait, __.Get, __.Set...)
  • behaviours (button behaviour to use signal onPress, draggableCamera for a 2D camera to be...draggable)
  • tween animations for your objects (Animate.show, Animate.to ...)
  • handle sounds anywhere easily (Sound.play)

Few documentation links:

Example

# showing the car smoothly
Animate.show(car)

# then wait for 2 seconds
var timer = Wait.start(car, 2)
yield(timer, 'timeout')

# then moving the car to (200, 200)
Animate.to(car, {
  propertyPath = 'position',
  toValue = Vector2(200, 200),
  duration = 0.5
})

πŸ“¦ Install

clone this repo next to your game folders

git clone https://github.com/uralys/fox
└── your-gamedev
  β”œβ”€β”€ fox
  β”œβ”€β”€ your-game1
  └── your-game2

To keep same paths and res://, symlink godot elements in the /fox folder like this:

cd /path/to/your-game
ln -s ../fox/fox fox

πŸ”‹ experimental NodeJS CLI

  • to watch your files and allow to live reload your game.
  • to export your debug and production bundles.
  • to generate your release icons and screenshots.

requirements

To use the CLI you'll need NodeJS installed

prepare the executable

Install the dev dependencies:

npm install

link the fox executable:

ln -s ~/Projects/uralys/gamedev/fox/cli/cli.js /usr/local/bin/fox

You may have to reload your termilnal to have fox in your path;

You can now execute fox commands from your terminal:

fox

usage

Usage: fox <command> [options]

Commands:
  fox run:editor              open Godot Editor with your main scene

  fox run:game                start your game to debug

  fox export                  export a bundle for one of your presets

  fox generate:icons          generate icons, using a base 1200x1200 image

  fox generate:splashscreens  generate splashscreens, extending a background
                              color from a centered base image

  fox generate:screenshots    resize all images in a folder to 2560x1600, to
                              match store requirements
  • more details for exporting here