From 22c7569353bc22c3e30f0dd17b455f7ea701c10f Mon Sep 17 00:00:00 2001 From: Azgaar Date: Tue, 14 Apr 2020 22:30:27 +0300 Subject: [PATCH] Updated URL parameters (markdown) --- URL-parameters.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/URL-parameters.md b/URL-parameters.md index 169476a..972a953 100644 --- a/URL-parameters.md +++ b/URL-parameters.md @@ -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` -* `seed` -* `width` -* `height` -* `scale` -* `x` -* `y` -* `burg` -* `cell` -* `options=default` +* `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` - 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`) +* `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 +* `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` +* `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` +* `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` ## Watabou's Medieval Fantasy City Generator parameters: - -* `from=MFCG` -* `size` -* `coast` -* `port` -* `river` \ No newline at end of file +This parameters are used by MFCG and not intended to be set manually. +* `from`- if equals to `MFCG`, generator will try to show/create city representation on a map +* `size` - MFCG city size, equals to population point in FMG +* `coast` - `1` if city is on a coastline +* `port` - `1` if city is a port +* `river` - `1` if city is on a river \ No newline at end of file