Skip to content

Commit 2e2d958

Browse files
committed
Update README.md
1 parent d6ae332 commit 2e2d958

1 file changed

Lines changed: 70 additions & 65 deletions

File tree

README.md

Lines changed: 70 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Collection of essential scripts and tools suitable for any type of Unity Project
44

55
## Features
66

7+
### Runtime
8+
79
#### New Property Attributes
810
- **ShowIf** - Only shows the property if a given condition is true
911
- **EnabledIf** - Makes the property editable only if a given condition is true
@@ -29,10 +31,59 @@ Collection of essential scripts and tools suitable for any type of Unity Project
2931
- **Scene** - Shows a scene popup for int (build index) or string (scene name)
3032
- **Separator** - Draws a separator line above the property
3133
- **ShowInInspector** - Apply to C# properties to make them visible with PropertyView structs
32-
- **PropertyView** - Specifies which group of marked C# properties to show when categorized using `ShowInInspector`.
34+
- **PropertyView** - Specifies which group of marked C# properties to show when categorized using `ShowInInspector`
3335
- **TexturePreview** - Draws a preview of the assigned texture or sprite below the property
3436

35-
#### **New Menu Items**
37+
#### New Classes and Value Types
38+
- **Nullables** - Serializable nullable values for many common value types
39+
- **Dictionaries** - Serialiable Dictionaries that are compatible with the inspector
40+
- **Collections** - Includes lists that support polymorphism and a component stack for creating a list of sub components
41+
- **Int/Float Range** - Pair of two floats representing a min and max value
42+
- **SceneReference** - Object reference to a scene asset
43+
- **ToggleableFeature** - Subclass with an `enabled` checkbox
44+
- **RepeatTimer** - Helper class for setting up a timer running at a specific (or random) interval
45+
- **PropertyView** - Utility field for displaying C# properties marked with `ShowInInspector`
46+
- **MaterialPropertyName** - Selector for a material property name
47+
- **Axis/AxisDirecton Enums** - Enums representing a specific axis or direction
48+
- **BooleanOperator** - Enum for performing boolean operations (AND/OR/XOR)
49+
- **ComparisonOperator** - Enum representing a comparison operator (such as == or >=)
50+
51+
#### Extension Methods
52+
- **Basic Math** - Get the absolute value, sign, or round to a specific number of decimals
53+
- **Colors** - Change alpha, brightness or convert to hex value
54+
- **Vectors** - Promote to other vector types, perform common math or swizzling
55+
- **Matrix4x4** - Extract position, rotation or scale information
56+
- **Rect** - Many helper methods for subdiving or transforming `Rect`s in various ways
57+
- **Texture2D / Mesh** - Get a copy that is read/write enabled
58+
- **Terrains** - Helper methods for getting correct height values or converting coordinates from/to terrain space
59+
- **Exceptions** - Add a custom message to an existing exception
60+
61+
#### Extended Update Loop
62+
New event injection points on top of unity's own update loop and ability to run static methods in any update loop using attributes or event subscriptions:
63+
- PreUpdate
64+
- PreLateUpdate
65+
- PostLateUpdate
66+
- PostFixedUpdate
67+
68+
#### Mesh Generators
69+
Scripts to simplify procedural mesh generation
70+
- Convex mesh generator (using MIConvexHull)
71+
- Mesh builder (for triangle, line and voxel meshes)
72+
- Primitive mesh generator (for generating custom primitives)
73+
- Topology converter (convert triangle meshes into lines and/or point clouds)
74+
75+
#### Coroutine Tools
76+
Helper class for managing coroutines and delayed invocation of functions, including support for static coroutines
77+
78+
#### Random Utilities
79+
Miscellaneous new random functions, including weighted distribution functions
80+
81+
#### Debug Utilities
82+
Helper functions to aid in debugging, including temporary gizmos
83+
84+
### Editor
85+
86+
#### New Menu Items
3687
- **Recompile Scripts** - Forces recompilation of scripts
3788
- **Run Build** - Lists and runs a built executable when placed in the "Builds" directory.
3889

@@ -60,69 +111,23 @@ Collection of essential scripts and tools suitable for any type of Unity Project
60111
- Convex mesh builder
61112
- Reflection probe bounds tool
62113

63-
#### Extension Methods
64-
- Basic math
65-
- Colors
66-
- Vectors (includes math and shader-like swizzling methods)
67-
- Matrix4x4
68-
- Transforms
69-
- Textures
70-
- Terrains
71-
- Exceptions (add a custom message to an already thrown exception)
72-
73-
- **Extension methods** - Extensions for many common types, including editor GUI related ones
74-
- **Property drawer utility** - Helper class for working with SerializedProperties
75-
- **Repeating Timer** - A simple object useful for timing events at a specific interval or frame rate
76-
- **Update Loop** - New event injection points on top of unity's own update loop and ability to run static methods in any update loop using attributes or event subscriptions
77-
- PreUpdate
78-
- PreLateUpdate
79-
- PostLateUpdate
80-
- PostFixedUpdate
81-
- **Coroutine Tools** - Helper class for managing coroutines and delayed invocation of functions, including support for static coroutines
82-
- **Extra Gizmos** - Various new gizmo shapes (circles, cylinders, arrows, texts and more)
83-
- **Pooling System** - Reuse the same game objects instead of spawning and destroying them
84-
- **Random Utilities** - Miscellaneous new random functions, including weighted distribution functions
85-
- **Debug Utilities** - Helper functions to aid in debugging, including temporary gizmos
86-
87-
### Runtime
88-
89-
- **Property Attributes** - A plethora of new attributes for fields in the inspector, including, but not limited to:
90-
- Show if / Enabled if (conditionally show / enable fields)
91-
- Read only
92-
- Progress bar
93-
- Buttons to call a specific method
94-
- Popups for Layers, Tags or even integers
95-
- AnimationCurve parameters (set limits and color)
96-
- Monospace text fields
97-
- **Collections** - Includes lists that support polymorphism and serializable dictionaries
98-
- **New Data Types** - Various new data types that are commonly used:
99-
- Float range (min / max value)
100-
- Material property name
101-
- Nullables for many common value types
102-
- **Mesh Generators** - Scripts to simplify procedural mesh generation
103-
- Convex mesh generator (using MIConvexHull)
104-
- Mesh builder (for triangle, line and voxel meshes)
105-
- Topology converter (convert triangle meshes into lines and/or point clouds)
106-
- **Extension Methods** - Tons of new extension methods, available for:
107-
- Basic math
108-
- Colors
109-
- Vectors (includes math and shader-like swizzling methods)
110-
- Matrix4x4
111-
- Transforms
112-
- Textures
113-
- Terrains
114-
- Exceptions (add a custom message to an already thrown exception)
115-
- **Repeating Timer** - A simple object useful for timing events at a specific interval or frame rate
116-
- **Update Loop** - New event injection points on top of unity's own update loop and ability to run static methods in any update loop using attributes or event subscriptions
117-
- PreUpdate
118-
- PreLateUpdate
119-
- PostLateUpdate
120-
- PostFixedUpdate
121-
- **Coroutine Tools** - Helper class for managing coroutines and delayed invocation of functions, including support for static coroutines
122-
- **Extra Gizmos** - Various new gizmo shapes (circles, cylinders, arrows, texts and more)
123-
- **Pooling System** - Reuse the same game objects instead of spawning and destroying them
124-
- **Random Utilities** - Miscellaneous new random functions, including weighted distribution functions
125-
- **Debug Utilities** - Helper functions to aid in debugging, including temporary gizmos
114+
#### New Gizmos
115+
- Draw combined shapes (wireframe and solid gizmos in one)
116+
- Draw colliders
117+
- Draw text labels
118+
- New shapes
119+
- Circle / Arc
120+
- Rectangle
121+
- Cylinder
122+
- Capsule
123+
- Cone
124+
- Arrow / Axes
125+
- Point / Crosshair
126+
- Radius Cube / Rectangle
127+
- Terrain projected shapes
128+
129+
#### Property drawer utility
130+
Helper class for working with SerializedProperties
126131

127132
## Installation
128133

0 commit comments

Comments
 (0)