Updated URL parameters (markdown)

Azgaar 2020-04-14 22:30:27 +03:00
parent e6760728e4
commit 22c7569353

@ -1,20 +1,18 @@
Here is a list of parameters you can add to URL in order to set generator options and/or control behavior by link. Here is a list of parameters you can add to URL in order to set generator options and/or control behavior by link. Use it like `http://azgaar.github.io/Fantasy-Map-Generator/?seed=123456789&width=1536&height=722&options=default`, which should generate the same map for everyone using this link.
* `maplink` * `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`. Due to CORS restrictions, it works only for some servers
* `seed` * `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`)
* `width` * `options` - set to `default` to allow generator to ignore options set by user. It's required for sharing the same map, see above
* `height` * `width`, `height` - map canvas size in pixels
* `scale` * `scale` - map zoom level, where `1` is 100% zoom, `2` is 200% and so on
* `x` * `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`
* `y` * `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` * `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`
* `options=default`
## 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.
* `from=MFCG` * `from`- if equals to `MFCG`, generator will try to show/create city representation on a map
* `size` * `size` - MFCG city size, equals to population point in FMG
* `coast` * `coast` - `1` if city is on a coastline
* `port` * `port` - `1` if city is a port
* `river` * `river` - `1` if city is on a river