Updated URL parameters (markdown)

Azgaar 2020-04-14 22:36:39 +03:00
parent c52aab2f5d
commit 3b12cf7907

@ -1,7 +1,7 @@
Here is a list of parameters you can add to URL in order to set generator options and/or control its behavior on load. It can be used to share exactly the same generated map without need to save it, or even to show exact place on the map.
## Azgaar's Fantasy Map Generator parameters:
* `maplink` - open .map file from the provided URL, use like [`https://azgaar.github.io/Fantasy-Map-Generator/?maplink=https://dl.dropboxusercontent.com/s/xgs3y1awlokio7x/Atlas%20046.map`](https://azgaar.github.io/Fantasy-Map-Generator/?maplink=https://dl.dropboxusercontent.com/s/xgs3y1awlokio7x/Atlas%20046.map). Due to CORS restrictions, it works only for some servers
* `maplink` - open .map file from the provided URL, use like [`https://azgaar.github.io/Fantasy-Map-Generator/?maplink=https://dl.dropboxusercontent.com/s/xgs3y1awlokio7x/Atlas%20046.map`](https://azgaar.github.io/Fantasy-Map-Generator/?maplink=https://dl.dropboxusercontent.com/s/xgs3y1awlokio7x/Atlas%20046.map). Due to browser security restrictions, it works only for servers that allow CORS
* `seed` - map seed, actual map generation depends not only on seed, but also on options and map size. So to share the same map via a link you need to use it like [`http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default`](http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default). It will work only if codebase is the same, so till the next generator update. To share exactly the same map you have to send a .map file (e.g. via `maplink`)
* `options` - set to `default` to allow generator to ignore options set by user. It's required for sharing the same map, see above
* `width`, `height` - map canvas size in pixels