https://github.com/ninetailsrabbit/pixel-space-background-generator

Port to Godot 4 for the pixel space background generator by deep-fold
https://github.com/ninetailsrabbit/pixel-space-background-generator

2d background gamedev generator godot pixel plugin procedural space

Last synced: about 1 month ago
JSON representation

Port to Godot 4 for the pixel space background generator by deep-fold

• Host: GitHub
• URL: https://github.com/ninetailsrabbit/pixel-space-background-generator
• Owner: ninetailsrabbit
• License: mit
• Created: 2024-12-09T12:48:08.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-12T19:19:50.000Z (about 1 month ago)
• Last Synced: 2024-12-12T20:28:56.629Z (about 1 month ago)
• Topics: 2d, background, gamedev, generator, godot, pixel, plugin, procedural, space
• Language: GDScript
• Homepage: https://deep-fold.itch.io/space-background-generator
• Size: 244 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


	


Pixel space background generator


  


   Port to Godot 4 for the pixel space background generator by deep-fold

	


	·

	Report Bug

	·

	Request Features

  









- [📦 Installation](#-installation)

- [Getting started 🚀](#getting-started-)

  - [Features 👾](#features-)

- [How to use 🪛](#how-to-use-)

  - [Export background image 🖼️](#export-background-image-️)

# 📦 Installation

1. [Download Latest Release](https://github.com/ninetailsrabbit/pixel-space-background-generator/releases/latest)

2. Unpack the `addons/pixel_space_background_generator` folder into your `/addons` folder within the Godot project

3. Enable this addon within the Godot settings: `Project > Project Settings > Plugins`

To better understand what branch to choose from for which Godot version, please refer to this table:

|Godot Version|pixel-space-background-generator Branch|pixel-space-background-generator Version|

|---|---|--|

|[![GodotEngine](https://img.shields.io/badge/Godot_4.3.x_stable-blue?logo=godotengine&logoColor=white)](https://godotengine.org/)|`main`|`1.x`|

# Getting started 🚀

This project brings the [Pixel space background generator](https://deep-fold.itch.io/space-background-generator) created by the user [Deep-Fold](https://github.com/Deep-Fold) to the Godot 4 version.

## Features 👾

- **Create backgrounds directly in your scene:** Generate unique pixel art space backgrounds at runtime using a dedicated node in your Godot scene tree.

- **Customize with ease:** Exportable parameters allow you to fine-tune the space background generation process, tailoring them to your specific needs.

- **Export to image:**: Export your generated background as `.png` to reuse as texture in your projects.

# How to use 🪛

Open the scene `pixelspace_background_generator.tscn` provided by the plugin and modify the parameters to achieve the desired background.

This scene also works on runtime and you can change the parameters to create backgrounds dinamically in your game.

## Export background image 🖼️

By default the images are exported into `res://space_backgrounds`. Feel free to change the exported variable `export path` to change the output directory

The Image export currently **only works in-game**. If you export from the editor it will use the preview window with the zoom level and grey areas will appear.