SabreCSG is a Unity plugin for creating and editing 3D levels directly within the Unity editor. It provides a set of tools for constructive solid geometry (CSG) operations, allowing developers to quickly prototype and build complex 3D environments using simple shapes and boolean operations.

Pros

• Intuitive and fast level design workflow within Unity
• Real-time CSG operations for quick iteration
• Supports both primitive shapes and custom brushes
• Integrates seamlessly with Unity's existing tools and workflow

Cons

• Learning curve for users unfamiliar with CSG concepts
• Performance can degrade with very complex geometry
• Limited documentation and community support compared to some alternatives
• May require additional optimization for final game builds

Code Examples

// Creating a new CSG brush
CSGBrush newBrush = CSGBrush.Create(PrimitiveBrushType.Cube);
newBrush.transform.position = Vector3.zero;
newBrush.transform.localScale = Vector3.one * 2f;

// Performing a boolean subtraction operation
CSGBrush baseBrush = CSGBrush.Create(PrimitiveBrushType.Cube);
CSGBrush cuttingBrush = CSGBrush.Create(PrimitiveBrushType.Sphere);
CSGBooleanOperationsUtility.Subtract(baseBrush, cuttingBrush);

// Applying a material to a CSG brush
CSGBrush brush = CSGBrush.Create(PrimitiveBrushType.Cylinder);
Material newMaterial = Resources.Load<Material>("MyCustomMaterial");
brush.SetMaterial(newMaterial);

Getting Started

1. Import the SabreCSG package into your Unity project.
2. In the Unity menu, go to "Window" > "SabreCSG" to open the SabreCSG toolbar.
3. Select the "Draw Brush" tool and click in the scene view to create a new brush.
4. Use the CSG tools in the toolbar to manipulate and combine brushes.
5. When finished, click "Build" in the SabreCSG toolbar to generate the final mesh.

For more detailed instructions and advanced usage, refer to the official SabreCSG documentation and examples provided in the GitHub repository.