Updated URL parameters (markdown)

Azgaar 2020-04-14 22:36:06 +03:00
parent a89fed757e
commit c52aab2f5d

@ -1,14 +1,14 @@
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. 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: ## 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?dl=1`](https://azgaar.github.io/Fantasy-Map-Generator/?maplink=https://dl.dropboxusercontent.com/s/xgs3y1awlokio7x/Atlas%20046.map?dl=1). 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 CORS restrictions, it works only for some servers
* `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`. 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`) * `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 * `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 * `width`, `height` - map canvas size in pixels
* `scale` - map zoom level, where `1` is 100% zoom, `2` is 200% and so on * `scale` - map zoom level, where `1` is 100% zoom, `2` is 200% and so on
* `x`, `y` - point coordinates that should be focused. Obviously works only if `scale` is greater than 1. Try `http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&x=768&y=361` * `x`, `y` - point coordinates that should be focused. Obviously works only if `scale` is greater than 1. Try [`http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&x=768&y=361`](http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&x=768&y=361)
* `burg` - burg id to focus on, works only if `scale` is greater than 1. Try `http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&burg=2` * `burg` - burg id to focus on, works only if `scale` is greater than 1. Try [`http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&burg=2`](`http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&burg=2)
* `cell` - cell if to focus on, Try `http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&cell=1000` * `cell` - cell if to focus on, Try [`http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&cell=1000`](http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default&scale=8&cell=1000)
## Watabou's Medieval Fantasy City Generator parameters: ## Watabou's Medieval Fantasy City Generator parameters:
This parameters are used by MFCG and not intended to be set manually. This parameters are used by MFCG and not intended to be set manually.