backups/Fantasy-Map-Generator
1
0
Fork 0
mirror of https://github.com/Azgaar/Fantasy-Map-Generator.git synced 2025-12-17 17:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Quick Start Tutorial (markdown)

Azgaar 2024-07-21 23:25:16 +02:00
parent 467426e030
commit fd97cb02dc
1 changed files with 18 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

29
Quick-Start-Tutorial.md

@ -50,34 +50,41 @@ If you like the current map you probably want to **Save** it for a later use. Th
![save_options](https://github.com/user-attachments/assets/b04fb365-7169-4179-88f2-98c292a7f58d) ![save_options](https://github.com/user-attachments/assets/b04fb365-7169-4179-88f2-98c292a7f58d)
There are also a few ways how you can get a map image or map data. Click on **Export** and use one of the options there. Please note that image (png, svg, or jpeg) is not a fully-functional `.map` file and cannot be loaded back to the tool. Consider it as a screenshot. There are also a few ways how you can get the map _image_ or map _data_. Click on **Export** and use one of the options there. Please note that image (png, svg, or jpeg) is not a fully-functional `.map` file and cannot be loaded back to the tool. Consider it as a screenshot.
## Generation and UI settings ## Generation and UI settings
Let’s move to the settings overview. Open the Menu and click on the _Options_ tab. There are multiple options split into 2 categories. Map generation options require a new map to be applied. Generator settings are getting applied immediately on change. Let’s move to the settings overview. Open the Menu and click on the _Options_ tab. There are multiple options split into 2 categories. Map generation options require a new map to be applied. Generator settings are getting applied immediately on change.
![options](https://github.com/user-attachments/assets/65fefee6-cdc7-439f-83e2-374c21f9a455) ![options](https://github.com/user-attachments/assets/65fefee6-cdc7-439f-83e2-374c21f9a455)
* _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. * _Canvas size_: the size of the map in pixels. There is no way to change the map size after the map generation and it's always advised to use the default value. The button on the left resets the size back to the default.
* _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 user’s changes, so please don’t 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. The seed cannot store user’s changes, so please don’t use it as a save function. The small button on the left allows to browse through generated seeds and restore previous maps if map options where not locked.
* _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 name_: the name of the map or the world. 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). * _Year and era_: current year of the world and the era name. Used for some text generation.
* _Heightmap_: template 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. * _Cultures set_: a set of cultures to be used for map generation. Can be a list of real-world-like 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 have 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.
* _Growth rate_: defines how far states and cultures will expand into neutral lands on generation. The lower value you have, the more lands will stay politically neutral. * _Growth rate_: defines how far states and cultures will expand into neutral lands on generation. The lower value you have, the more lands will stay politically neutral.
* _Towns number_: the number of towns to be generated. Towns are non-capital settled areas (_burgs_). If there is not enough suitable space to put a requested number of towns, the Generator will place only a limited number of towns. * _Towns number_: the number of towns to be generated. Towns are non-capital settled areas (_burgs_). If there is not enough suitable space to put a requested number of towns, the Generator will place only a limited number of towns.
* _Religions number_: the number of religions to be generated. Controls only the number of organized religions cults as in any case each culture will have its own traditional (folk) religion. Religions can be edited via the _Religions Editor_. * _Religions number_: the number of religions to be generated. Controls only the number of organized religions and cults. Religions can be edited via the _Religions Editor_.
* _State labels_: defines whether the generator should render full state names or can use short variants where there is not enought space.
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.
* _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>). * _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.
* _Theme color_: main color of the control panes.
* _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. * _Autosave interval_: number of minutes the map should be auto-saved to browser memory. Set to `0` to disable the autosave.
* _Onload behavior_: define what should be done when Generator is opened: a new map generated or a previously saved map auto-opened.
* _Speaker voice_: select voice to speak burg and other names. Voice generation functionality if provided by browser.
* _Emblem shape_: defines shield shape used during emblems generation.
* _Zoom extent_: minimal and maximal zoom levels. Click on the button on the right to restore the default values. * _Zoom extent_: minimal and maximal zoom levels. Click on the button on the right to restore the default values.
* _Rendering_: set map rendering quality. Best quality can reduce the map performance.
* _Language_: load Google Translator and select a language to translate the tool. Translations can cause issues with saving.
There is also the _Reset to defaults_ button. The button cancels all user changes and refreshes the page. There is also the _Reset to defaults_ button. The button cancels all user changes and refreshes the page.