mirror of
https://github.com/Relintai/mesh_utils.git
synced 2024-11-12 10:25:24 +01:00
Proper Readme.md.
This commit is contained in:
parent
4f69ec67b8
commit
65a802ff39
59
README.md
59
README.md
@ -1,9 +1,60 @@
|
||||
# Mesh Utils
|
||||
# Mesh Utils Module
|
||||
|
||||
My mesh merging utilities.
|
||||
This is a c++ engine module for the Godot engine, containing my mesh merging utilities.
|
||||
|
||||
Also contains A port of https://github.com/Whinarn/UnityMeshSimplifier to a GODOT engine c++ module.
|
||||
It supports both godot 3.2 and 4.0 (master). Note that since 4.0 is still in very early stages I only
|
||||
check whether it works from time to time.
|
||||
|
||||
# Pre-built binaries
|
||||
|
||||
You can grab a pre-built editor binary from the [Broken Seals](https://github.com/Relintai/broken_seals/releases)
|
||||
repo, should you want to. It contains all my modules.
|
||||
|
||||
# Optional Dependencies
|
||||
|
||||
[Mesh Data Resource](https://github.com/Relintai/mesh_data_resource): Support for merged meshes, even in gles2.
|
||||
Adds MeshMerger a few helper methods.
|
||||
|
||||
# MeshUtils Singleton
|
||||
|
||||
Contains generic algorithms that manipulate meshes.
|
||||
|
||||
# Mesh Merger
|
||||
|
||||
Works similarly to SurfaceTool, but it has more utility functions.
|
||||
|
||||
# Fast Quadratic Mesh Simplifier
|
||||
|
||||
A port of https://github.com/Whinarn/UnityMeshSimplifier .
|
||||
For future reference it's based on e8ff4e8862735197c3308cfe926eeba68e0d2edb.
|
||||
|
||||
Porting is mostly done, but it does needs some debugging (it has a crash if smart linking is enabled).
|
||||
|
||||
I might just return to using the original FQMS. As if meshes are merged together using `MeshUtils.merge_mesh_array`, or
|
||||
`bake_mesh_array_uv` the original algortithm will work fine. Still on the fence about it.
|
||||
|
||||
# Building
|
||||
|
||||
1. Get the source code for the engine.
|
||||
|
||||
If you want Godot 3.2:
|
||||
```git clone -b 3.2 https://github.com/godotengine/godot.git godot```
|
||||
|
||||
If you want Godot 4.0:
|
||||
```git clone https://github.com/godotengine/godot.git godot```
|
||||
|
||||
|
||||
2. Go into Godot's modules directory.
|
||||
|
||||
```
|
||||
cd ./godot/modules/
|
||||
```
|
||||
|
||||
3. Clone this repository
|
||||
|
||||
```
|
||||
git clone https://github.com/Relintai/mesh_utils mesh_utils
|
||||
```
|
||||
|
||||
4. Build Godot. [Tutorial](https://docs.godotengine.org/en/latest/development/compiling/index.html)
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user