Important installation details

This commit is contained in:
Marc 2016-10-15 12:43:04 +02:00 committed by GitHub
parent b1e9f39fad
commit 757f99f42f

View File

@ -1,8 +1,18 @@
FastNoise for Godot Engine FastNoise for Godot Engine
============================= =============================
Description
-------------
This is an integration of the [FastNoise C++ library](https://github.com/Auburns/FastNoise) for Godot Engine. 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. It uses Simplex Noise for some of its generators, which is [patented](https://www.google.com/patents/US6867776) for image generation.
If you want to avoid the patent, you can try OpenSimplex, for which I also made a [module](https://github.com/Zylann/godot_opensimplex). 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. I still prefer FastNoise because it has more features, doesn't allocates dynamic memory and works with a single class.
Install
--------
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.
Example git command: `git clone https://github.com/Zylann/godot_opensimplex.git opensimplex`