HLCaptain / proto-shape

Godot engine plugin for rapid prototyping.
MIT License
40 stars 2 forks source link

ProtoShape - Godot Prototyping Extension for CSG and Gizmos

ProtoShape is a Godot plugin that adds a library of dynamic shapes based on Godot's Constructive Solid Geometry (CSG) and custom gizmo utilities to create your own dynamic nodes. It is designed to be used for prototyping levels and game mechanics.

Feature Showcase

Installation

Install plugin from the AssetLib inside Godot or download the latest release from the releases page.

Enable the plugin inside Godot. Project -> Project Settings -> Plugins -> Enable ProtoShape.

Usage

Add these shapes to your scene by searching for them in the Add Child Node menu.

ProtoRamp

Ramp/staircase with adjustable height, width and length. Can adjust step count and various other parameters. Supports custom gizmos.

https://github.com/HLCaptain/proto-shape/assets/22623259/730a527c-d6ba-4eaa-93b6-dbcbbd8aba52

ProtoGizmoWrapper

Nest your custom nodes under the ProtoGizmoWrapper and start adding custom gizmo functionality with a few lines of code. Embrace the power of dragging your cursor on the screen, with all the complex 3D math handled for you with ProtoGizmoUtils.

Supports only Node3D nodes for now! Read the documentation to get to know gizmos and how to make your custom nodes compatible.

Contributing

Feel free to open an issue for any bugs or feature requests. See more in CONTRIBUTING.md.

The library is written in GDScript and (mostly) follows the GDScript style guide.

Extend the library of shapes by creating an issue or pull request! Share your idea for a shape or feature you would like to see added to the library.

If you find any bugs, feel free to create an issue.

License

MIT