From 757f99f42f639bd8a1b79928b3e4f2f235f29b71 Mon Sep 17 00:00:00 2001 From: Marc Date: Sat, 15 Oct 2016 12:43:04 +0200 Subject: [PATCH] Important installation details --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index f997544..84ed447 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ FastNoise for Godot Engine ============================= +Description +------------- + 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. 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. + +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`