Updated Quick Start Tutorial (markdown)

Azgaar 2019-10-04 16:47:26 +03:00
parent 1ea9d96bea
commit 8feb36e6ae

@ -34,7 +34,7 @@ The _Toggle global filters_ section below allows to apply a color filter to the
## Performance tips ## Performance tips
Some users report performance issues on map dragging and zooming. These are number of tips that will allow you to avoid problems with performance. Some users report performance issues on map dragging and zooming. These are number of tips that will allow you to avoid problems with performance.
* Toggle off unnecessary layers. Especially take care of the _Relief Icons_ layer its the most resource-demanding one. * Toggle off layers you are not working on. Especially take care of the _Relief Icons_ layer its the most resource-demanding one.
* If you have a wide screen, open the Generator in a separate browser window, make it _much_ smaller (about 900 x 560 pixels) and re-generate the map. Then zoom in to see the map in detail. It will reduce the rending area and drastically improve the performance. * If you have a wide screen, open the Generator in a separate browser window, make it _much_ smaller (about 900 x 560 pixels) and re-generate the map. Then zoom in to see the map in detail. It will reduce the rending area and drastically improve the performance.
* Generate maps with _Points number_ = 10K. Points (cells) number highly affects performance. * Generate maps with _Points number_ = 10K. Points (cells) number highly affects performance.
* Toggle off map and element filters. * Toggle off map and element filters.
@ -61,8 +61,10 @@ Lets move to the settings overview. Open the Menu and click on the _Options_
* _Map size_: the size of the map canvas. By default the map size is the browser window's size, but it can be changed to any value. The button on the right expands the size back to the window size. Please note that there is no way to change the map size after the generation. * _Map size_: the size of the map canvas. By default the map size is the browser window's size, but it can be changed to any value. The button on the right expands the size back to the window size. Please note that there is no way to change the map size after the generation.
* _Map seed_: a number defining random values generation. If options and map size are the same, two maps generated with the same seed will be exactly the same. Obviously, the map seed cannot store users changes, so please dont use the seed number as a save function. The small button next to the seed allows to browse through generated seeds and restore previous maps. * _Map seed_: a number defining random values generation. If options and map size are the same, two maps generated with the same seed will be exactly the same. Obviously, the map seed cannot store users changes, so please dont use the seed number as a save function. The small button next to the seed allows to browse through generated seeds and restore previous maps.
* _Points number_: the number of generated points and cells. The more points are generated, the more detailed is map. Points number highly affects performance, so the only recommended value is 10K. * _Points number_: the number of generated points and cells. The more points are generated, the more detailed is map. Points number highly affects performance, so the only recommended value is 10K.
* _Map name_: the name of the map or the world. It's getting added to the names of downloaded files. Click on button with arrows to re-generate the name.
* _Map template_: the set of rules to be applied on heightmap generation. Basically a type of the landmass: high island, continents, archipelago etc. You can create your own template or change the existing in the _Template Editor_ (part of the _Heightmap Editor_ tools). * _Map template_: the set of rules to be applied on heightmap generation. Basically a type of the landmass: high island, continents, archipelago etc. You can create your own template or change the existing in the _Template Editor_ (part of the _Heightmap Editor_ tools).
* _Cultures number_: the number of cultures to be generated. Cultures can be edited via the _Cultures Editor_. * _Cultures number_: the number of cultures to be generated. Cultures can be edited via the _Cultures Editor_.
* _Cultures set_: a set of cultures to be used for map generation. Can be a list of real-world based or fantasy cultures.
* _States number_: the number of countries/states to be generated. States can be edited via the _States Editor_. * _States number_: the number of countries/states to be generated. States can be edited via the _States Editor_.
* _Provinces ratio_: the percentage of burgs that will form their own province. Provinces are sub-units of states and can be edited via the _Provinces Editor_. * _Provinces ratio_: the percentage of burgs that will form their own province. Provinces are sub-units of states and can be edited via the _Provinces Editor_.
* _Size variety_: defines how much states area should be different. The lower value, the more uniform state areas are. * _Size variety_: defines how much states area should be different. The lower value, the more uniform state areas are.
@ -72,7 +74,7 @@ Lets move to the settings overview. Open the Menu and click on the _Options_
Generator settings: Generator settings:
* _Onload behavior_: define what should be done when Generator is opened: a new map generated or a previously saved map is auto-opened. * _Onload behavior_: define what should be done when Generator is opened: a new map generated or a previously saved map is auto-opened.
* _Interface size_: size of the control panes. It the GUI size is too small, please check out browser's zoom level (<kbd>Ctrl +</kbd>, <kbd>Ctrl -</kbd>). * _Interface size_: size of the control panes. If the GUI size is too small, please also check out browser's zoom level (<kbd>Ctrl +</kbd>, <kbd>Ctrl -</kbd>).
* _Tooltip size_: size of the tooltips displayed at the bottom of the screen. * _Tooltip size_: size of the tooltips displayed at the bottom of the screen.
* _Transparency_: opacity of the control panes. * _Transparency_: opacity of the control panes.
* _PNG resolution_: relative size of the png image saved. 1 means the downloaded image will have the same resolution as map size, 2 2x the size and so on. PNG resolution highly affects saving performance. * _PNG resolution_: relative size of the png image saved. 1 means the downloaded image will have the same resolution as map size, 2 2x the size and so on. PNG resolution highly affects saving performance.