ProceduralTerrain

A quick and easy 3D procedural generation module for the Godot Game Engine.

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Compiling the Engine
   • Compiling the Templates
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

ProceduralTerrain is a simple 3D procedural generation module for Godot that offers solid functionality. It offers a wide variety of options to generate your own terrain for your games made with the Godot Engine. While it's feature set is relatively small, it offers enough to fufill many demands when it comes to procedural generation.

Please feel free to use or modify the project as desired.

(back to top)

Getting Started

To integrate the module into Godot Engine, you'll have to download and compile the engine from source. To do this follow the steps shown below.

Prerequisites

Follow the steps in the Godot Documentation to get your setup ready to compile the engine from source.

Compiling the Engine

1. Clone the repository or download the source zip file from GitHub

   git clone https://github.com/PeanutButterRat/procedural_terrain

2. Move the repository to godot/modules folder or create a separate folder to hold your custom modules and move it there. I prefer the custom modules workflow because it keeps everything separated, so I will be demonstrating that here.

   mkdir your_custom_modules_folder
   mv procedural_terrain your_custom_modules_folder

3. You are now ready to compile! Navigate your Godot source folder and run the scons command. If you simply dropped procedural_terrain in the godot/modules and don't have a separate folder for any other modules, you can omit the custom_modules flag.

   cd path_to_godot_folder
   scons platform=your_platform target=editor custom_modules=path_to_your_custom_modules_folder

4. You can find the compiled editor in the godot/bin folder.

Compiling the Templates

In order to export your game you also have to compile the export templates. Export templates are simply compliations of the engine without the editor attached to it. To do this you can follow the same steps above and just change the target flag when compiling to template_debug for the debug template or template_release for the release template.

cd path_to_godot_folder
scons platform=your_platform target=template_debug custom_modules=path_to_your_custom_modules_folder
scons platform=your_platform target=template_release custom_modules=path_to_your_custom_modules_folder

(back to top)

Usage

To generate terrain, just add a ProceduralTerrain node to your scene and play around with the parameters.

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with and present your idea there. Any input or contributions is greatly appreciated!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/YourCoolFeature)
3. Commit your Changes (git commit -m 'Add some YourCoolFeature')
4. Push to the Branch (git push origin feature/YourCoolFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Eric Brown - GitHub - [email protected]

Project Link: https://github.com/PeanutButterRat/procedural_terrain

(back to top)

Acknowledgments

Here are some awesome resources that were crucial to the development to this application.

• Sebastian Lague's Procedural Generation Series
• README Template

(back to top)