https://github.com/peter-kish/vision2d

A Godot plugin (version 4.x) for rendering 2d fields of vision.
https://github.com/peter-kish/vision2d

Last synced: 9 months ago
JSON representation

A Godot plugin (version 4.x) for rendering 2d fields of vision.

• Host: GitHub
• URL: https://github.com/peter-kish/vision2d
• Owner: peter-kish
• License: mit
• Created: 2025-09-05T20:01:48.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2025-09-13T10:26:54.000Z (9 months ago)
• Last Synced: 2025-09-13T10:39:24.250Z (9 months ago)
• Language: GDScript
• Homepage:
• Size: 54.7 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Vision2D



  



A Godot plugin (version 4.x) for rendering 2d fields of vision, inspired by [Teleglitch](https://store.steampowered.com/app/234390/Teleglitch_Die_More_Edition/).

![](images/screenshot.png "Vision2D")

The plugin renders a number of polygons covering up parts of the screen that are outside the observer's field of vision.

![](images/screenshot_polygon.png "Vision2D")

The field of vision can be blocked with a `VisionOccluderLine` node or a `VisionOccluderPolygon` node:

* ![](addons/vision2d/icons/vision2d_vision_occluder_line.svg "VisionOccluderLine icon") `VisionOccluderLine` - Represents a line that blocks the field of vision. Extends [Line2D](https://docs.godotengine.org/en/4.4/classes/class_line2d.html).

* ![](addons/vision2d/icons/vision2d_vision_occluder_polygon.svg "VisionOccluderPolygon icon") `VisionOccluderPolygon` - Represents a polygon that blocks the field of vision. Extends [Polygon2D](https://docs.godotengine.org/en/4.4/classes/class_polygon2d.html).

Both nodes have the following properties:

* `observer: Node2D` - A `Node2D` representing the position of the observer.

* `shadow_color: Color` - Color of the shadow that covers up the screen.

* `size: float` - Size of the shade that covers up the screen.

* `penetration: float` - Determines how deep the vision can penetrate this occluder.

* `max_segment_size: float` - Max. size of the segment that casts the shadow (smaller segments -> more detail).

## Installation

1. Create an `addons` directory inside your project directory.

2. Get the plugin from the AssetLib or from GitHub

    * From the AssetLib: Open the AssetLib from the Godot editor and search for "Vision2D". Click download to install the plugin.

    * From GitHub: Run `git clone https://github.com/peter-kish/vision2d.git` and copy the contents of the `addons` directory to your projects `addons` directory.

4. Enable the plugin in `Project Settings > Plugins`.