Updated the readme.

This commit is contained in:
Relintai 2023-01-09 20:44:00 +01:00
parent 68a6826ee5
commit 286fcf574b

View File

@ -1,8 +1,6 @@
FastNoise for Godot Engine # FastNoise for Godot Engine
=============================
Description ## 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.
@ -10,9 +8,14 @@ If you want to avoid the patent, you can try OpenSimplex, for which I also made
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 ## 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.
## 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. 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_fastnoise.git fastnoise` Example git command: `git clone https://github.com/Relintai/godot_fastnoise.git fastnoise`