Updated Quick Start Tutorial (markdown)

Azgaar 2019-06-10 15:02:08 +03:00
parent c7a103ea64
commit 4411154603

@ -1,10 +1,12 @@
# Quick Start Tutorial # Quick Start Tutorial
![FMG Loading Screen](https://azgaar.files.wordpress.com/2019/06/1.-fmg-loading-screen.png) ![FMG Loading Screen](https://azgaar.files.wordpress.com/2019/06/1.-fmg-loading-screen.png)
## Introduction ## Introduction
_Fantasy Map Generator_ is a tool that creates highly customizable fantasy worlds for you. It runs in a browser and does not require any software installation. Its free and you can use created maps for any purposes including commercial. You can even download the Generator and then run in a browser without Internet connection available. _Fantasy Map Generator_ is a tool that creates highly customizable fantasy worlds for you. It runs in a browser and does not require any software installation. Its free and you can use created maps for any purposes including commercial. You can even download the Generator and then run in a browser without Internet connection available.
The tool generates a new fantasy map on opening. The map is auto-generated, but it doesnt mean that you cannot control the generation. To open the controls click on the arrow button at the top left corner on the screen or press Tab. You can either change the generation parameters and generate a new map, or edit the current map. You can also create a new map from scratch using paint brushes. The tool generates a new fantasy map on opening. The map is auto-generated, but it doesnt mean that you cannot control the generation. To open the controls click on the arrow button at the top left corner on the screen or press Tab. You can either change the generation parameters and generate a new map, or edit the current map. You can also create a new map from scratch using paint brushes.
![Menu button](https://azgaar.files.wordpress.com/2019/06/2.-menu-button.png) ![Menu button](https://azgaar.files.wordpress.com/2019/06/2.-menu-button.png)
## Moving around ## Moving around
@ -13,7 +15,8 @@ The map is getting generated in a default zoom so that all the map area is displ
The same operations can be performed using keyboard. Press <kbd>+</kbd> to zoom in, <kbd>-</kbd> to zoom out. Use <kbd>1</kbd>-<kbd>9</kbd> number keys to set an exact zoom level. Press <kbd>0</kbd> to reset zoom to default. Use arrows keys to move around. The same operations can be performed using keyboard. Press <kbd>+</kbd> to zoom in, <kbd>-</kbd> to zoom out. Use <kbd>1</kbd>-<kbd>9</kbd> number keys to set an exact zoom level. Press <kbd>0</kbd> to reset zoom to default. Use arrows keys to move around.
## Map layers ## Map layers
By default the map shows the worlds political situation, but its not the only available preset. Open the first tab of the menu _Style_ to change the preset. _Preset_ is a set of different map layers being toggled on. There are 5 presets available for selection: political map, cultural map, heightmap, biomes map and the pure landmass view. You can either select one of the presets or use buttons below to display or hide a particular label. By default the map shows the worlds political situation, but its not the only available preset. Open the first tab of the menu _Style_ to change the preset. _Preset_ is a set of different map layers being toggled on. There are 5 presets available for selection: political map, cultural map, heightmap, biomes map and the pure landmass view. You can either select one of the presets or use buttons below to display or hide a particular label.
![Map presets and layers](https://azgaar.files.wordpress.com/2019/06/3.-map-presets-and-layers.png) ![Map presets and layers](https://azgaar.files.wordpress.com/2019/06/3.-map-presets-and-layers.png)
@ -25,6 +28,7 @@ Some layers are sort of a background and may not be visible if upper layer is to
There are cases when you may want to see multiple background layers simultaneously. The only way you can do it is to make the upper layer partially transparent. Choose the required layer from the _Select element_ drop-down list and change the opacity slider. There are cases when you may want to see multiple background layers simultaneously. The only way you can do it is to make the upper layer partially transparent. Choose the required layer from the _Select element_ drop-down list and change the opacity slider.
The same approach is used for styling all the map elements. For example if you want to change the color of state borders, select _Borders_ element and click on color box to set a new color. Here you can also change the borders stroke width, its style and apply a visual filter. Different map elements have different styling controls. The same approach is used for styling all the map elements. For example if you want to change the color of state borders, select _Borders_ element and click on color box to set a new color. Here you can also change the borders stroke width, its style and apply a visual filter. Different map elements have different styling controls.
![Styling borders](https://azgaar.files.wordpress.com/2019/06/4.-styling-borders.png) ![Styling borders](https://azgaar.files.wordpress.com/2019/06/4.-styling-borders.png)
Using the section below the styling drop-down you can apply a filter to the whole map. Using the section below the styling drop-down you can apply a filter to the whole map.
@ -44,12 +48,14 @@ If you like the current map you will probably want to save it for a later use. T
* _Save as .map_. It is an internal file format that stores all the map data including your manual changes. It can be them loaded directly into the Generator and used to proceed with the map creation. I highly recommend saving the map you are working on at least every 30 minutes. The generator is still in beta and critical error with data loss or even browser crash may happen. * _Save as .map_. It is an internal file format that stores all the map data including your manual changes. It can be them loaded directly into the Generator and used to proceed with the map creation. I highly recommend saving the map you are working on at least every 30 minutes. The generator is still in beta and critical error with data loss or even browser crash may happen.
* _Save as .png_. It makes a screenshot of the currently displayed map fragment. Just an image and nothing more. The png resolution can be set in the _Options_ tab. By default it is 5x of the map size. Saved file can be opened and edited in any image editor. * _Save as .png_. It makes a screenshot of the currently displayed map fragment. Just an image and nothing more. The png resolution can be set in the _Options_ tab. By default it is 5x of the map size. Saved file can be opened and edited in any image editor.
* _Save as .svg_. It is a vector image that can be rescaled to any size without quality loss. The Generator naturally renders maps in svg, so there is no conversion and hence saving as svg is better than saving as png. To just open and view a saved file I recommend using your browser, not a vector images editor. To edit the file you need special software the most common are _Inkscape_ (free) and _Illustrator_ (proprietary). * _Save as .svg_. It is a vector image that can be rescaled to any size without quality loss. The Generator naturally renders maps in svg, so there is no conversion and hence saving as svg is better than saving as png. To just open and view a saved file I recommend using your browser, not a vector images editor. To edit the file you need special software the most common are _Inkscape_ (free) and _Illustrator_ (proprietary).
![Saving options](https://azgaar.files.wordpress.com/2019/06/5.-saving-options.png) ![Saving options](https://azgaar.files.wordpress.com/2019/06/5.-saving-options.png)
Please note all these 3 options use popups for saving. So please allow browser to show popups for the site and ensure they are not blocked by _adBlocker_. Please dont worry, there is no ad on the site. Please note all these 3 options use popups for saving. So please allow browser to show popups for the site and ensure they are not blocked by _adBlocker_. Please dont worry, there is no ad on the site.
## Generation and UI settings ## Generation and UI settings
Lets move to the settings overview. Open the menu and open the _Options_ tab. There are multiple options split into 2 categories: map generation and user interface. Map generation options require a new map generation to be applied. UI options are getting applied immediately on change. Lets move to the settings overview. Open the menu and open the _Options_ tab. There are multiple options split into 2 categories: map generation and user interface. Map generation options require a new map generation to be applied. UI options are getting applied immediately on change.
![Options](https://azgaar.files.wordpress.com/2019/06/6.-options.png) ![Options](https://azgaar.files.wordpress.com/2019/06/6.-options.png)
* _Map size_: the size of the map canvas. By default the map size is a browser window 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 size the map was generated with cannot be changed later * _Map size_: the size of the map canvas. By default the map size is a browser window 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 size the map was generated with cannot be changed later
@ -82,6 +88,7 @@ The _precipitation_ value defines how much vapor can clouds bring and spread acr
## Heightmap editing ## Heightmap editing
If you dont like the heightmap generated automatically, you may edit it or even create a new one from the scratch. Open the _Tools_ tab in the menu and click on _Heightmap_. Now you need to select an edit mode. All secondary data like rivers, burgs and state depend on the height values, so changing the height manually will break the default generation logic. So the best practice here is to use the _Erase_ mode, create the heightmap you want and let the system to re-generate the secondary data based on a current heightmap. It will remove all the changes made for burgs rivers and so on, but it will guarantee the smooth generation. If you dont like the heightmap generated automatically, you may edit it or even create a new one from the scratch. Open the _Tools_ tab in the menu and click on _Heightmap_. Now you need to select an edit mode. All secondary data like rivers, burgs and state depend on the height values, so changing the height manually will break the default generation logic. So the best practice here is to use the _Erase_ mode, create the heightmap you want and let the system to re-generate the secondary data based on a current heightmap. It will remove all the changes made for burgs rivers and so on, but it will guarantee the smooth generation.
![Heightmap Editor](https://azgaar.files.wordpress.com/2019/06/8.-heightmap-editor.png) ![Heightmap Editor](https://azgaar.files.wordpress.com/2019/06/8.-heightmap-editor.png)
If you want to perform just a minor change, you need to select the _Keep_ mode. You wont be able to change the coastline, but all the data, including manually placed relief icons and rivers, will be kept as is. So its more like a visual change without changing the basic data. This mode is also safe. If you want to perform just a minor change, you need to select the _Keep_ mode. You wont be able to change the coastline, but all the data, including manually placed relief icons and rivers, will be kept as is. So its more like a visual change without changing the basic data. This mode is also safe.
@ -89,6 +96,7 @@ If you want to perform just a minor change, you need to select the _Keep_ mode.
If you have manually edited data and still need to change the coastline, you may use the _Risk_ mode. As the title says, its not safe and can cause some issues. So please use this mode only if you really need. If you have manually edited data and still need to change the coastline, you may use the _Risk_ mode. As the title says, its not safe and can cause some issues. So please use this mode only if you really need.
Heightmap editing process has multiple build-in tools. These tools wont be covered in this tutorial, just note that they allow you to use brushes to “paint” the map, to edit and apply heightmap template and to convert any image into a heightmap. Heightmap editing process has multiple build-in tools. These tools wont be covered in this tutorial, just note that they allow you to use brushes to “paint” the map, to edit and apply heightmap template and to convert any image into a heightmap.
![Paint Brushes](https://azgaar.files.wordpress.com/2019/06/9.-paint-brushes.png) ![Paint Brushes](https://azgaar.files.wordpress.com/2019/06/9.-paint-brushes.png)
## Customization tools ## Customization tools
@ -101,7 +109,8 @@ The next _Tools_ section allows adding elements like burgs, labels, rivers, rout
The last section, which in collapsed by default, provides some info about the hovered map cell. The last section, which in collapsed by default, provides some info about the hovered map cell.
## Editing map elements (labels, rivers, roads etc.) ## Editing map elements (labels, rivers, roads etc.)
Individual map elements such as rivers, routes, relief icons, labels, burgs and labels can be edited on mouse click. The editor screen that is getting opened is different for each element and its also out of this tutorial coverage. Individual map elements such as rivers, routes, relief icons, labels, burgs and labels can be edited on mouse click. The editor screen that is getting opened is different for each element and its also out of this tutorial coverage.
![Label Editor](https://azgaar.files.wordpress.com/2019/06/10.-label-editor.png) ![Label Editor](https://azgaar.files.wordpress.com/2019/06/10.-label-editor.png)
## Points of contact ## Points of contact