Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/RadicalCSG/Chisel.Prototype

Work in progress prototype for the Chisel Level Editor, for Unity
https://github.com/RadicalCSG/Chisel.Prototype

bsp chisel constructive-solid-geometry csg level-design level-editor leveldesign mapping prototype realtime unity

Last synced: 3 months ago
JSON representation

Work in progress prototype for the Chisel Level Editor, for Unity

Host: GitHub
URL: https://github.com/RadicalCSG/Chisel.Prototype
Owner: RadicalCSG
License: mit
Created: 2019-02-05T14:46:02.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-08-29T15:51:09.000Z (5 months ago)
Last Synced: 2024-08-29T17:38:28.739Z (5 months ago)
Topics: bsp, chisel, constructive-solid-geometry, csg, level-design, level-editor, leveldesign, mapping, prototype, realtime, unity
Language: C#
Homepage:
Size: 13.6 MB
Stars: 473
Watchers: 31
Forks: 33
Open Issues: 119
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-unity3d - Chisel.Prototype - Work in progress prototype for the Chisel Level Editor, for Unity (Open Source Repositories / Level Editor)

README

        This repository has been replaced by [com.chisel](https://github.com/RadicalCSG/com.chisel) which can be installed through the Unity package manager

# [Chisel.Prototype](https://github.com/RadicalCSG/Chisel.Prototype)

Chisel is an extension for **Unity** that allows for _rapid_, iterative, **non destructive** level editing!

![Example](Documentation/Images/chisel_example.png)

---

* [Click here for information on how to get started](GettingStarted.md)

* Want to help out? [We have some good first issues here](https://github.com/RadicalCSG/Chisel.Prototype/labels/good%20first%20issue)

* If you have questions be sure to ask in the discord! **[Click here for to join the official Discord server!](https://discord.gg/zttNkPQ)**

Notes:

- Chisel requires Unity 2022.1.0b11 or newer

- UX is still under development

- CSG algorithm is still under development

- It is *not yet* ready for production, but please feel free to try it out, or better yet, help out!

Features (incomplete)

* [Constructive Solid Geometry Algorithm](http://www.youtube.com/watch?v=Iqmg4gblreo) that generates geometry in real-time

* Add and remove geometry to your level using CSG allows for fluid, interactive, non destructive workflows

* Higher level "generators" that create more complicated geometry to perform CSG with, while retaining context of what it is you're creating (if you create stairs, these will remain stairs that you can edit and tweak)

* Hierarchical Constructive Solid Geometry, allows for generators and brushes to be act as if they're one whole (composite), to perform CSG on other objects with

* Works well with prefabs, drag and drop windows onto walls including their holes

* Draw 2D shapes (possible to turn straight lines into curves) on existing CSG surfaces and extrude them

* Precise snapping to surfaces, edges, vertices and grid lines

* Rotatable & movable grid

Planned Features (incomplete, and in random order):

* [Debug Visualizations](https://github.com/RadicalCSG/Chisel.Prototype/issues/118) to see shadow only surfaces, collider surfaces etc.  (partially implemented)

* [Double sided surfaces](https://github.com/RadicalCSG/Chisel.Prototype/issues/226)

* [Extrusion from existing surface](https://github.com/RadicalCSG/Chisel.Prototype/issues/19)

* [Subtractive Workflow](https://github.com/RadicalCSG/Chisel.Prototype/issues/14)

* [Clip Tool](https://github.com/RadicalCSG/Chisel.Prototype/issues/15)

* [Normal smoothing](https://github.com/RadicalCSG/Chisel.Prototype/issues/184)

* [Node Based Generators](https://github.com/RadicalCSG/Chisel.Prototype/issues/94) for easy procedural content generation

* [2D shape editor](https://github.com/RadicalCSG/Chisel.Prototype/issues/260)

* [Hotspot mapping](https://github.com/RadicalCSG/Chisel.Prototype/issues/173)

* [Sub-Models](https://github.com/RadicalCSG/Chisel.Prototype/issues/259)

* [Trim Decals](https://github.com/RadicalCSG/Chisel.Prototype/issues/117)

* [Grid Objects](https://github.com/RadicalCSG/Chisel.Prototype/issues/121)

Packages overview:

* `com.chisel.core` Low-level API and functionality (based on DOTS technology)

* `com.chisel.editor` Unity Scene Editor functionality and API, tools and UI

* `com.chisel.components` Unity Monobehaviour runtime API (to allow for possible ECS replacement in future)

* `com.scene.handles.extensions` Custom scene handle extensions

Extensions:

* [Source Engine 2006 Map Importer for Chisel Editor]( https://github.com/Henry00IS/Chisel.Import.Source)

  * [Decal support for importer](https://github.com/Henry00IS/Chisel.Decals)

* [Quake1 Importer](https://github.com/Quixotic7/Chisel.Import.Quake1)

Known issues:

* [There are some cases where triangulation fails](https://github.com/RadicalCSG/Chisel.Prototype/issues/187)

* There are some cases where overlapping surfaces create overlapping polygons

If you find any failure cases, if possible please provide us with a reproducible scene so we can more easily fix it!

The core technology is based on the algorithm explained in [this GDC 2020 talk](http://www.youtube.com/watch?v=Iqmg4gblreo)

[![GDC Video](http://img.youtube.com/vi/Iqmg4gblreo/0.jpg)](http://www.youtube.com/watch?v=Iqmg4gblreo "Geometry in Milliseconds: Real-Time Constructive Solid Geometry")