Created CreateFromImage (markdown)

Jesse Boyd 2017-05-01 07:56:05 +10:00
parent 421366c12a
commit 6ee86cf88b

86
CreateFromImage.md Normal file

@ -0,0 +1,86 @@
## Overview
The CreateFromImage command is used to generate terrain from large heightmaps. Heightmaps can be generated using WorldMachine or found online.
Example:
[![CFI TEST](https://i.imgur.com/qUjm3hv.jpg)](https://www.youtube.com/watch?v=pPR-w6cRNTc)
Dependencies:
- PlotSquared (dev build) with `enabled-components.worlds` set to true
## Command Syntax
- `<arg>` - A required parameter
- `[arg]` - An optional parameter
- `<arg1|arg2>` - Multiple parameters options
- `<arg=value>` - Default or suggested value
## Starting
To begin you need to either specify a heightmap to use (imgur link), or the dimensions you want.
- Using a world: `/2 cfi <url>`
- Using a fixed size: `/2 cfi <width> <length>`
Take a look at the commands below, when you are done, run either of the following:
- /2 cfi done
- /2 cfi cancel
## Modifying the world
### The palette
- Terrain can be colored using an image.
- If you choose to use coloring, you should change the palette and other settings used beforehand.
##### `/2 cfi paletteComplexity <min=0> <max=100>`
- Filter out blocks to use based on their complexity, which is a measurement of how much color variation there is in the texture for that block.
- Using `0 50` for the min/max would use the simplest %50 of blocks for coloring.
##### `/2 cfi paletteRandomization <enabled=true>`
- Enabled by default, randomization will add some random variation in the blocks used to closer match the provided image.
- If disabled, the closest block to the color will always be used.
##### `/2 cfi paletteBlocks <block-list>`
- Allow only specific blocks to be used for coloring
##### `/2 cfi paletteBiomePriority <percent=50>`
- Increase or decrease biome priority when using `blockBiomeColor`.
- A value of 50 is the default.
### Coloring commands
##### `/2 cfi color <image-url>`
- Color the terrain using only blocks
##### `/2 cfi glass <image-url>`
- Color the terrain using glass (unique, but looks weird from an angle)
##### `/2 cfi biomeColor <image-url>`
- Color the terrain using biomes.
Note: Biome coloring does not change blocks:
- If you changed the block to something other than grass you will not see anything.
##### `/2 cfi blockBiomeColor <image-url>`
- Color the terrain using blocks and biomes.
##### `/2 cfi biome [url|mask] <biome> [white=false]`
Set the biome in specific parts of the map.
- If an image is used, the biome will have a chance to be set based on how white the pixel is (white #FFF = 100% chance)
- The whiteonly parameter determines if only white values on the image are set
- If a mask is used, the biome will be set anywhere the mask applies
### Height settings
#### `/2 cfi height <url|height>`
- Set the terrain height either based on an image heightmap, or a numeric value.
#### `/2 cfi waterHeight <height=0>`
- Change the level water is generated at.
- By default water is disabled (with a value of 0)
#### `/2 cfi waterId <number-id>`
- Use another block id instead of water. e.g Maybe you want to use lava.
### Material settings
#### `/2 cfi overlay [url|mask] <pattern> [white=false]`
- Change the block to use as the overlay (default: none)
#### `/2 cfi main [url|mask] <pattern> [white=false]`
- Change the block to use as filling (default: stone)
#### `/2 cfi floor [url|mask] <pattern> [white=false]`
- Change the block to use as the floor (default: grass)
#### `/2 cfi column [url|mask] <pattern> [white=false]`
- Change the floor and main block.
### Populators
#### `/2 cfi caves`
- Generate caves
#### `/2 cfi ore[s]`
##### `/2 cfi addores`
- Add the default minecraft ores.
##### `/2 cfi ore <mask> <pattern> <size> <frequency> <rarity> <min-Y> <max-Y>`
- Use a specific pattern and settings to generate ore.
#### `/2 cfi schem <mask> <file|folder|url> <rarity> <rotate>`
- Populate a schematic on the terrain.
- Change the mask (e.g. angle mask) to only place the schematic in specific locations.
- The rarity is a value between 0 and 100.