Updated Quick Start Tutorial (markdown)

Azgaar 2024-07-21 22:58:19 +02:00
parent 1ea9fbacc6
commit fbbf899c12

@ -7,8 +7,6 @@ _Fantasy Map Generator_ is a tool that creates highly customizable fantasy world
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 of the screen or press <kbd>Tab</kbd>. 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://cdn.discordapp.com/attachments/587406457725779968/615924098090008577/v1_2.png)
## Moving around
The map is generated fully zoomed out. Double click on the map to zoom into the clicked area. Double click again to zoom in even more. The maximum zoom level is 20x, but it can be increased in the options. To zoom out hold <kbd>Shift</kbd> and double click. Click and drag to move around the enlarged area.
@ -17,7 +15,7 @@ The same operations can be performed using keyboard. Press <kbd>+</kbd> to zoom
## 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 _Layers_ to change the preset. _Preset_ is a set of layers to be toggled on. There are number of presets available by default: political, cultural, religions, biomes, provinces, heightmap, places of interest, and other. You can either select one of the presets or use buttons below to display or hide a particular layer.
![Map presets and layers](https://cdn.discordapp.com/attachments/587406457725779968/629674129754423307/layers.png)
![Menu button](https://cdn.discordapp.com/attachments/587406457725779968/615924098090008577/v1_2.png)
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.
@ -42,16 +40,18 @@ Some users report performance issues on map dragging and zooming. These are numb
* 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
If you like the current map you probably want to save it for a later use. There are 5 saving options:
* _Save to machine_. It is an internal file format that stores all the map data including your manual changes. The file can be directly into the Generator and is used to proceed with the map creation. It's highly recommend to save the map you are working on at least every 30 minutes.
* _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 and hence saving as svg is faster than saving as png. To just open and view a saved file it's recommended to use your browser, not a vector images editor. To edit the file you need special software the most common variants are _Inkscape_ (free) and _Illustrator_ (proprietary).
* _Save as .json_. It allows to export map data in format used in GIS software.
* _Save to storage_. Allows to save the map to the browser storage. Then it can be loaded as a fully-functional map. Press <kbd>F6</kbd> for a quick save and <kbd>F9</kbd> for a quick load.
If you like the current map you probably want to **Save** it for a later use. There are 3 saving options:
* _Save to machine_. Download `.map` file that stores all the map data including your manual changes to your machine. The file then can be directly loaded into the Generator. It's highly recommend to save the map you are working on at least every 30 minutes.
* _Save to dropbox_. Log into your Dropbox account and save the `.map` file there.
* _Save to browser_. Save the `.map` file to the browser storage. Then it can be loaded as a fully-functional map. Press <kbd>F6</kbd> for a quick save and <kbd>F9</kbd> for a quick load. Please use it only for a quick safe, browser storage can be purged from time to time and you can lose your progress. Always keep `.map` file saved on your machine.
![Saving options](https://media.discordapp.net/attachments/587406457725779968/620225213682024452/saving_options.png)
Please note file saving uses popups, so please allow browser to show popups for the site and ensure they are not blocked by your _adBlocker_, if you use one. Please dont 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).
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.
## Generation and UI settings
Lets 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.
@ -83,7 +83,8 @@ Generator settings:
There is also the _Reset to defaults_ button. The button cancels all user changes and refreshes the page.
## Climate configuration
Click on _Configure World_ to set up map position on a globe and climate. Toggle biomes, precipitation or temperature layers on to see how configuration changes affect the map.
Click on _Configure World_ to set up map position on a globe and climate. Toggle biomes, precipitation or temperature layers on to see how configuration changes affect the map.
![World Configurator](https://cdn.discordapp.com/attachments/587406457725779968/615924111243476992/v1_6.png)
The Globe on the right shows relative position of the map as a brighter area. The map position is calculated based on two inputs: _Map size_ and _Latitudes_. The North is always on the top, the West is on the left and so on. Map size defines a relative size of the map to the whole world. With 100% size the generated map will cover all the world; with 50% - half of the world and so on. If the size is not 100%, the map can be shifted towards North or South. The shift is controlled by the _Latitudes_ input. With Latitudes equal to 0 the map North edge will be at the North pole, with 100 - South edge will be on the South pole, with 50 - the world equator will lie through the center of the map.
@ -120,4 +121,4 @@ Individual map elements such as rivers, routes, relief icons, labels, markers, b
![Label Editor](https://cdn.discordapp.com/attachments/587406457725779968/615924116184104960/v1_8.png)
## Points of contact
That was a brief overview of the main Generator elements and approaches. Its not full by any meaning and just serves as a starting point. You can always find more details and help on our supportive [Discord server]( https://discordapp.com/invite/X7E84HU) and [Reddit community]( https://www.reddit.com/r/FantasyMapGenerator/).
That was a brief overview of the main Generator elements and approaches. Its not full by any meaning and just serves as a starting point. You can always find more details and help on our supportive [Discord server]( https://discordapp.com/invite/X7E84HU) and [Reddit community]( https://www.reddit.com/r/FantasyMapGenerator).