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

Updated Quick Start Tutorial (markdown)

Azgaar 2019-08-28 13:09:39 +03:00
parent 2b28b4d714
commit 92da776edc
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Quick-Start-Tutorial.md

@ -21,38 +21,38 @@ By default the map shows the world’s political situation, but it’s not the o
To make it simple each layer has a shortcut assigned. Hover the mouse over the layer button to see a tooltip showing what the button does and which key is assigned to it. Check out [the Hotkeys](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Hotkeys) wiki-page to get a full list of shortcuts. Click on the plus button next to the presets list to save the current layers as a custom preset. On Generator reload the map preset will be defaulted to the the previously selected one. To make it simple each layer has a shortcut assigned. Hover the mouse over the layer button to see a tooltip showing what the button does and which key is assigned to it. Check out [the Hotkeys](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Hotkeys) wiki-page to get a full list of shortcuts. Click on the plus button next to the presets list to save the current layers as a custom preset. On Generator reload the map preset will be defaulted to the the previously selected one.
Some layers may not be visible if a higher (top) layer is toggled on. You can drag the layer button to change the layer's order. Some layers may not be visible if a upper (top) layer is toggled on. You can drag the layer button to change the layer's order.
## Styling and filters ## Styling and filters
There are cases when you may want to see multiple full 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. Note that this may not work if clipping is enabled. There are cases when you may want to see several full map-covering 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. Note that this may not work if clipping is enabled.
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 the color box to set a new color. Here you can also change the border's stroke width, its style and apply a visual filter. Different map elements have different styling controls. The same approach is used for styling all map elements. For example if you want to change the color of state borders, select _Borders_ element, then border group (type) and click on the color box to set a new color. Here you can also change border stroke width, its style and apply a visual filter. Different map elements have different styling controls. To restore the default style to all elements click on the counter-clockwise arrow next to the elements list.
![Styling borders](https://cdn.discordapp.com/attachments/587406457725779968/615924107858673666/v1_4.png) ![Styling borders](https://cdn.discordapp.com/attachments/587406457725779968/615924107858673666/v1_4.png)
Using the section below the styling drop-down you can apply a filter to the whole layer. The _Toggle filters_ section below allows to apply a color filter to the whole map.
## 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 – it’s the most resource-demanding one. * Toggle off unnecessary layers. Especially take care of the _Relief Icons_ layer – it’s 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 improve the performance drastically. * 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 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.
* Close all irrelevant browser tabs and applications. * Close all irrelevant browser tabs and applications.
* Use the top-edge browser. As for now the best performance is observed in _Chrome_. _Firefox_ is also pretty fast, but there are some minor UI issues specific to this browser. * Use the top-edge browser. As for now the best performance is observed in _Chrome_. _Firefox_ is also pretty fast, but there are some minor UI issues specific to this browser. Other browsers may not be supported.
## Saving the map ## Saving the map
If you like the current map you will probably want to save it for later use. There are 3 saving options: If you like the current map you probably want to save it for a later use. There are 3 saving options:
* _Save as .map_. It is an internal file format that stores all the map data including your manual changes. It can later be loaded directly into the Generator and used to proceed with the map creation. It is highly recommend to save the map you are working on at least every 30 minutes. The generator is still in beta and a critical error with data loss or even a 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 later be loaded directly into the Generator and used to proceed with the map creation. It is highly recommend to save the map you are working on at least every 30 minutes. The generator is still in beta and a critical error with data loss or even a 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. The 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. The 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 faster than saving as png. To just open and view a saved file it is recommended to use 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 faster than saving as png. To just open and view a saved file it is recommended to use 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 your _adBlocker_, if you use one. Please don’t worry, there are no ads 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 your _adBlocker_, if you use one. Please don’t worry, there are no ads on the site. The file is getting saved to the browser's default Downloads folder. Press <kbd>Ctrl</kbd> + <kbd>J</kbd> to open the browser's downloads journal (in Chrome and Firefox).
## Generation and UI settings ## Generation and UI settings
Let’s 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 to be generated. UI options are 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 and user interface. Map generation options require a new map to be applied. UI options are getting applied immediately on change.
![Options](https://cdn.discordapp.com/attachments/587406457725779968/615924109318029322/v1_5.png) ![Options](https://cdn.discordapp.com/attachments/587406457725779968/615924109318029322/v1_5.png)