/PrototypeSprite3D

A Godot Engine 4 Addon for Prototyping with Sprite3D Nodes

Primary LanguageGDScriptMIT LicenseMIT

PrototypeSprite3D

PrototypeSprite3D Node in Action Screenshot: PrototypeSprite3D node generating placeholder textures in a 3D scene

A Godot Engine 4 addon that streamlines the creation of 3D sprites in world space sizes (meters). Generate placeholder textures, export art templates, and import your final artwork with the correct pixel size for your 3D scenes.

Godot License: MIT

Features

  • PrototypeSprite3D: a new node type to create 3D sprites with accurate world dimensions
  • PrototypeCanvas: customizable canvas resources for different sprite types
  • Pre-configured Canvases: Optimized for furniture, characters, props, animations, and more using GPU optimized power of 2 dimensions
  • Grid Overlays: Visual guides for precise texture creation
  • Export and Import Artwork: Easily transition from placeholder to final artwork

Quick Start

Installation

  1. Download: Clone or download this repository
  2. Copy: Move the addons/prototype_sprite_3d/ folder to your project's addons/ directory
  3. Enable: Go to Project Settings > Plugins and enable "PrototypeSprite3D"
  4. Ready: The PrototypeSprite3D node will be available in the node creation dialog

Generate Prototype Sprite

  1. Add a PrototypeSprite3D node to your scene
  2. Set world dimensions (width_meters, height_meters)
  3. Choose a PrototypeCanvas resource from the canvases folder
  4. Configure color and grid overlay settings
  5. Click "Generate" to create your prototype texture

Export Artwork Template

  1. Set the "Export Directory" path
  2. Click "Export" to generate a template file using current PrototypeCanvas
  3. Open the template in your art program and create your final artwork
  4. Save the final artwork in a supported image format (e.g., PNG, JPEG)

Import Final Artwork

  1. Set the import file path to your final artwork
  2. Click "Import" to replace the placeholder texture with your final artwork, automatically adjusting pixel size to fit world dimensions
  3. When satisfied, change the node type to a standard Sprite3D for production use

Documentation

Document Description
Plugin Documentation Complete API reference and usage guide
Canvas Templates Pre-configured canvas templates grouped into categories

Development

Prerequisites

  • Godot 4.5+
  • Basic knowledge of GDScript and Godot plugins

Project Structure

PrototypeSprite3D/
├── addons/prototype_sprite_3d/     # Main plugin
│   ├── plugin.gd                  # Plugin configuration
│   ├── prototype_sprite_3d.gd     # Core node implementation
│   ├── canvases/                  # Template resources
│   └── README.md                  # Plugin documentation
├── examples/                      # Usage examples
├── LICENSE                        # MIT License
└── README.md                      # This file

Contributing

Contributions welcome! Here's how to get started:

Workflow

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes
  4. Test thoroughly with Godot 4.5+
  5. Commit with clear messages: git commit -m 'Add amazing feature'
  6. Push to your branch: git push origin feature/amazing-feature
  7. Submit a Pull Request

Guidelines

  • Follow existing code style and conventions
  • Test your changes with multiple canvas types
  • Update documentation for new features
  • Add examples for complex functionality
  • Ensure compatibility with Godot 4.5+

Areas for Contribution

I will add issues for the adding new features, enhancements, and bug fixes. Some ideas include adding support for additional shapes beyond square and rectangular sprites to include circular or irregular shapes, additional grid types, adding text to images, and more.

License

This project is licensed under the MIT License - see the LICENSE file for details.