godot_fastnoise/README.md

24 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2023-01-09 20:44:00 +01:00
# FastNoise for Godot Engine
2016-05-02 18:42:47 +02:00
2023-01-09 20:44:00 +01:00
## Description
2016-10-15 12:43:04 +02:00
2016-05-02 18:42:47 +02:00
This is an integration of the [FastNoise C++ library](https://github.com/Auburns/FastNoise) for Godot Engine.
It uses Simplex Noise for some of its generators, which is [patented](https://www.google.com/patents/US6867776) for image generation.
2016-05-02 18:42:47 +02:00
If you want to avoid the patent, you can try OpenSimplex, for which I also made a [module](https://github.com/Zylann/godot_opensimplex).
I still prefer FastNoise because it has more features, doesn't allocates dynamic memory and works with a single class.
2016-10-15 12:43:04 +02:00
2023-01-09 20:44:00 +01:00
## Godot Version Support
This branch tries to follow godot's master branch (as much as I have time).
For different godot versions look at the other branches.
2023-01-09 20:45:31 +01:00
Status for this branch: Update for 4.0 is work in progress.
2023-01-09 20:44:00 +01:00
## Install
2016-10-15 12:43:04 +02:00
You have to get the source code of Godot to compile it with the module. Copy the contents of the repository inside a `fastnoise` directory under Godot's `modules` folder. The name is important for the module to compile properly.
2023-01-09 20:44:00 +01:00
Example git command: `git clone https://github.com/Relintai/godot_fastnoise.git fastnoise`