Skip to content

Latest commit

 

History

History
137 lines (82 loc) · 9.7 KB

README.MD

File metadata and controls

137 lines (82 loc) · 9.7 KB
Raw

RootGen

image1

A procedural 3D landscape generator for Unity3D, based with permission on Jasper Flick's hex map series on Catlike Coding.

The goal of RootGen is to provide hex map generation in Unity3D that is as implementation-agnostic as possible, allowing developers to provide a set of generation parameters in whichever format that they choose, render the resulting hex map, and retrieve data about the map in whichever format they find to be the most useful (graph, matrix, list, etc).

Currently, RootGen only supports providing parameters using a scriptable object, and retrieving the map as a custom matrix class. See todo for a prioritized list of planned features.

Implementation

Climate

RootGen uses a simplified version of the holdridge life zones to interpret the climate of individual hexes from their temperature and moisture level.

Topography

RootGen creates overlapping elevation regions, using them in combination with other elevation parameters such as minimum and maximum global elevation to generate a semi-realistic simulation of tectonic shift.

Weather

RootGen uses a simplified model of atmospheric moisture propagation to determine the movement of clouds and precipitation, which determines rainfall with respect to wind direction and land elevation.

Camera

RootGen currently only implements a standard top down camera with rotation and zoom.

Installation and Usage

Installation

Use Windows Subsystem For Linux to cd to new or existing Unity project directory and initialize it with NPM, then run npm install jordanstudioroot/RootGen-UnityCSharp.

Alternatively clone this repository into the Assets folder of an existing Unity project and link the root assembly definition in your projects assembly definition.

If you don't want to use the assembly definitions, simply delete all .asmdef files in the rootgen-unitycsharp directory and all subdirectories.

Instantiating RootGen.

Once RootGen has been added to the project, instantiate an instance: RootGen rootGen = new RootGen(). This can be done in a MonoBehaviour or regular class. Multiple instances of RootGen are not currently supported, and using multiple instances may result in unexpected behavior.

Creating a RootGenConfig

Create a new RootGenConfig scriptable object by right clicking in the project pane and clicking Create -> RootGenConfig -> Default Config.

Generating A Map Using a RootGenConfig

To jump right in to playing with RootGen, load the scene ExampleScene in rootgen-unitycsharp/Runtime/Scenes. Make sure that the ExampleApp object has an assigned RootGenConfig. If not, use the default config located at rootgen-unitycsharp/Runtime/ScriptableObject/Resources. Once this is done, simply hit play to see an example of RootGen in action.

Otherwise, to implement RootGen yourself on a MonoBehaviour, declare a public RootGenConfig variable RootGenConfig rootGenConfig, drag and drop the scriptable object into the inspector field, and call rootGen.GenerateMap(rootGenConfig) in the MonoBehaviour.

To populate an instance of RootGenConfig which has been declared in something other than a MonoBehaviour, make sure the instance of the RootGenConfig scriptable object is contained in a Resources directory and populate the declaration using Resources.Load: RootGenConfig rootGenConfig = Resources.Load<RootGenConfig>([scriptable object instance file name]).

Attaching the Camera

The camera is attached automatically to the most recently generated map.

Moving The Camera

The camera can be used using standard WASD controls for longitudinal (A, D key) and latitudinal (S, W key) movement. Rotate the camera using Q (left rotation) and E (right rotation). Zoom the camera in and out using the mouse scroll wheel.

Description Of RootGenConfigParameters

  • Width: The width of the map.

  • Height: The height of the map.

  • Wrapping: Should the map wrap?

  • Use Fixed Seed: Checking this box will keep the random seed the same when regenerating maps using the same instance of RootGen. Check this if you would not like the randomized values of the map to change when it is regenerated.

  • Seed: Allows the specification of a custom random seed. Use in combination with "Use Fixed Seed" to keep the provided value from changing when regenerating the map with a single instance of RootGen.

  • Initial Climate Steps: The number of iterations that the climate generation algorithm with run through before stopping. Providing higher values results in a longer period of climate simulation.

  • Hex Size: The size of the individual hexes on the map. Providing larger values makes the individual hexes larger. Useful for scaling the map to fit the scale of assets such as characters and buildings.

  • Jitter Probability: The probability that the region generation algorithm will "jitter". A higher Jitter Probability will result in more abnormal region formations.

  • Minimum Region Density: The minimum density of a elevation region. Higher values will result in the smallest regions having more broad variations in elevation.

  • Maximum Region Density: The maximum density of an elevation region. Higher values will result in the largest regions having more broad variations in elevation.

  • Land Percentage: The percentage overall land in the map. Higher values will result in smaller bodies of water and larger landmasses.

  • Water Level: The global water level.

  • High Rise Probability: The probability that a cliff will be generated. Higher values will result in more mountainous terrain.

  • Sink Probability: The probability that terrain will "sink". Higher values will result in more valleys.

  • Elevation Min: The lowest elevation permitted in the map.

  • Elevation Max: The highest elevation permitted in the map.

  • Map Border X: The size of the longitudinal water border of the map. Larger values will result in terrain being "squeezed in" along the longitudinal axis.

  • Map Border Z: The size of the latitudinal water border of the map. Larger values will result in terrain being "squeezed in" along the latitudinal axis.

  • Region Border: The border between elevation regions. Larger values will result in larger gaps between elevation regions.

  • Num Regions: The number of elevation regions. The provided value will be clamped to an even value if odd. Larger values will result in a larger grid of regions.

  • Erosion Percentage: The percent of wind erosion to be applied to the map. Larger values will result in smoother terrain globally.

  • Evaporation Factor: The percent of evaporation to be applied to the map. Larger values will result in drier terrain and a larger incidence of desert regions.

  • Precipitation Factor: The percent of precipitation to be applied to the map. Larger values will result in more rivers and lakes.

  • Runoff Factor: The percent of runoff to be applied to the map. Larger values will result in more rivers occurring as a result of runoff calculations.

  • Seepage Factor: The percent of seepage to be applied to the map. Larger values will result in hexes obtaining more moisture from their neighbors as a result of moisture seepage from adjacent tiles with a high amount of moisture.

  • Wind Direction: The global direction of the wind. Erosion will occur in this direction, and precipitation will propagate around mountains in the opposite direction.

  • Wind Strength: The strength of the wind. Determines how far precipitation propagates and how much erosion occurs.

  • Starting Moisture: The global starting moisture for all hex tiles. The higher this value is, the "wetter" the map will be.

  • Extra Lake Probability: The probability that rivers will generate lakes.

  • Low Temperature: The minimum temperature of the map. Higher values will result in the coldest hexes being hotter.

  • High Temperature: The maximum temperature of the map. Lower values will result in the hottest hexes being colder.

  • Temperature Jitter: The amount that the temperature algorithm will "jitter". Higher values will result in more chaotic variations in climate.

  • Num Initial Rivers: The number of initial rivers.

  • Num Initial River Steps: The number of steps that the river generation algorithm will initially take to generate the rivers. Higher values will result in rivers being longer initially.

  • Hemisphere: The hemisphere of the map, either north, south, or both. North and south will simulate their corresponding hemisphere, with a cold pole on either the top of bottom of the map. Both will result in both hemispheres being simulated, with a north an south pole.

TODO

  • Tests.
  • Re-implementation of runtime map editor.
  • More robust parameter support. (JSON, struct, class, MonoBehaviour, raw arguments)
  • More robust support for retrieving map data. (JSON, graph, list, array)
  • Support for attaching GameObjects, MonoBehaviours, and simple classes as static and interactive features of the map.
  • Support for providing custom terrain textures.
  • Support for providing custom flora assets.
  • Support for empty tiles and floating landmasses.
  • Separate data generation and rendering into separate libraries or packages.
  • Replace all calls to Resources.Load with an AssetBundle implementaiton, or some other higher-performance implementation.

Criticisms, Suggestions, Pull Requests

Email: jordannelson@protonmail.com

Defects

Report on issues.