https://github.com/lazysquirrellabs/sphere_generator
A small Unity package for generating spheres procedurally.
https://github.com/lazysquirrellabs/sphere_generator
game-dev game-development unity unity-package unity-tool
Last synced: 33 minutes ago
JSON representation
A small Unity package for generating spheres procedurally.
- Host: GitHub
- URL: https://github.com/lazysquirrellabs/sphere_generator
- Owner: lazysquirrellabs
- License: mit
- Created: 2024-04-26T16:03:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-02T16:07:37.000Z (21 days ago)
- Last Synced: 2025-11-02T18:08:25.795Z (21 days ago)
- Topics: game-dev, game-development, unity, unity-package, unity-tool
- Language: C#
- Homepage:
- Size: 486 KB
- Stars: 19
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- anything_about_game - sphere_generator
README
# Sphere Generator
Sphere Generator is a free Unity tool for generating sphere meshes procedurally.
[](https://openupm.com/packages/com.lazysquirrellabs.spheregenerator/)
[](https://assetstore.unity.com/packages/tools/modeling/spheres-generator-311994)
## Contents
- [Features](#features)
- [Importing](#importing)
- [Import via Unity Asset Store](#import-via-unity-asset-store)
- [Import using a git URL](#import-using-a-git-url)
- [Import with OpenUPM](#import-with-openupm)
- [After importing](#after-importing)
- [Usage](#usage)
- [Example](#example)
- [Samples](#samples)
- [Compatibility and dependencies](#compatibility-and-dependencies)
- [Roadmap](#roadmap)
- [Technical aspects](#technical-aspects)
- [Contributing](#contributing)
- [Getting help](#getting-help)
- [License](#license)
## Features
- Support for different basic shapes:
- Icosphere (based on a regular icosahedron).
- Cube sphere.
- UV sphere.
- Customizable radius and level of detail (a.k.a. fragmentation depth).
## Importing
The first step is to import the library into your Unity project. There are three ways to do so:
- [Via the Asset Store](#import-via-unity-asset-store).
- Via the Package Manager:
- [Using a git URL](#import-using-a-git-url).
- [Using OpenUPM](#import-with-openupm).
### Import via Unity Asset Store
Click on the image below to visit the package's page on the Unity Asset Store. One there, follow the instructions to import it into your project.
[](https://assetstore.unity.com/packages/tools/modeling/spheres-generator-311994)
### Import using a git URL
This approach uses Unity's Package Manager to add Sphere Generator to your project using the repo's git URL. To do so, navigate to `Window > Package Manager` in Unity. Then click on the `+` and select "Add package from git URL":
Next, enter the following in the "URL" input field to install the latest version of Sphere Generator:
```
https://github.com/lazysquirrellabs/sphere_generator.git?path=Assets/Lazy Squirrel Labs/SphereGenerator
```
Finally, click on the "Add" button. The importing process should start automatically. Once it's done, Sphere Generator is ready to be used in the project.
### Import with OpenUPM
Sphere Generator is available as a package on [OpenUPM](https://openupm.com/packages/com.lazysquirrellabs.spheregenerator/). To import Sphere Generator into your project via the command line, run the following command:
```
openupm add com.lazysquirrellabs.spheregenerator
```
Once the importing process is complete, Sphere Generator is ready to be used in the project.
### After importing
After importing , check the [Usage](#usage) section on how to use it and the [Samples](#samples) section on how to import and use the package samples.
## Usage
Using Sphere Generator is straightforward. First, create a `SphereGenerator` (base class) instance by calling one of the supported sphere type constructors:
```csharp
public CubeSphereGenerator(float radius, ushort depth);
public IcosphereGenerator(float radius, ushort depth);
public UVSphereGenerator(float radius, ushort depth);
```
Where `radius` is the sphere radius and `depth` is the fragmentation depth (a.k.a. level of detail) of the to-be generated spheres. Check the documentation for valid parameter value ranges.
Once an instance of the `SphereGenerator` class is created, its `Generate` method can be called to generate a sphere mesh:
```csharp
public Mesh Generate()
```
The method returns a `Mesh` instance that represents the generated sphere. It is up to the user to control the lifetime of the `Mesh` instance.
### Example
Let's say we would like to create an icosphere with radius of 20 units, a fragmentation depth of 3, and use the generated mesh on a mesh filter that is used by a mesh renderer to display the sphere in the scene. The code below implements that inside an `Awake` method:
```csharp
[SerializeField] private MeshFilter _meshFilter;
private void Awake()
{
SphereGenerator generator = new IcosphereGenerator(20, 3);
Mesh mesh = generator.Generate();
_meshFilter.mesh = mesh;
}
```
## Samples
The package contains one sample named "Display". It displays the generational capabilities of the tool, displaying all supported sphere types with different depths. This sample is better displayed in the Scene view, with "Shading Mode" set to "Shared wireframe", so the vertices and triangles are visible. This sample was also used to generate the image at the top of this page.
To import the samples, open the Package Manager and select Sphere Generator in the packages list. Then find the Samples section on the right panel, and click on the "Import" button right next to the sample you would like to import. Once importing is finished, navigate to the `Assets/Samples/SphereGenerator` folder. Finally, open and play the scene from the sample you would like to test.
## Compatibility and dependencies
Sphere Generator requires Unity 2022.3.X or above, its target API compatibility level is .NET Standard 2.1, and depends on the following packages:
- `com.unity.collections`
## Roadmap
The following basic shapes are planned to be implemented in future versions:
- Truncated icosahedron.
- Fibonacci.
## Technical aspects
Sphere Generator's icosphere implementation has been discussed in the following blog post: [Generating an icosphere with code](https://blog.matheusamazonas.net/posts/generating_icosphere_with_code).
## Contributing
If you would like to report a bug, please create an [issue](https://github.com/lazysquirrellabs/sphere_generator/issues). If you would like to contribute with bug fixing or small improvements, please open a Pull Request. If you would like to contribute with a new feature (regardless if it's in the roadmap or not), [contact the developer](https://matheusamazonas.net/contact.html).
## Getting help
Use the [issues page](https://github.com/lazysquirrellabs/sphere_generator/issues) if there's a problem with your Sphere Generator setup, if something isn't working as expected, or if you would like to ask questions about the tool and its usage.
## License
Sphere Generator is distributed under the terms of the MIT license. For more information, check the [LICENSE](LICENSE) file in this repository.