From 47c7720f18243951b7f3834fcfc8bafbbaf02053 Mon Sep 17 00:00:00 2001 From: Federico Tomassetti Date: Mon, 16 Nov 2015 14:55:03 +0100 Subject: [PATCH 1/6] doc: remove options from the README --- README.md | 40 ++-------------------------------------- 1 file changed, 2 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 6b91ce3c..7bd4deec 100644 --- a/README.md +++ b/README.md @@ -110,44 +110,8 @@ Usage ``` worldengine [options] [world|plates|ancient_map|info] ``` -_Note that options were changed in version 0.5.3_ - -### General options - -| Short | Long | Description | -|-----------|------|-------------| -| -o DIR | --output-dir=DIR | generate files in DIR default = '.' | -| -n STR | --worldname=STR | set world name to STR | -| -b | --protocol-buffer | save world using protocol buffer format (smaller file) | -| -s N | --seed=N | use SEED to initialize the pseudo-random generation | -| -t STR | --step=STR | use STEP to specify how far to proceed in the world generation process. Valid values are: plates precipitations full | -| -x N | --width=N | WIDTH of the world to be generated | -| -y N | --height=N | HEIGHT of the world to be generated | -| -q N | --number-of-plates=N | number of plates | -| | --recursion-limit=N | you need that just if you encounter an error while generating very large maps | -| -v | --verbose | Enable verbose messages | -| --bw | --black-and-white | Draw maps in black and white | - -### Options valid only for generate - -| Short | Long | Description | -|-----------|------|-------------| -| -r FILE | --rivers=FILE | produce a map of rivers, after the option it expects the name of the file where to generate the map | -| --gs | --grayscale-heightmap | produce a grayscale heightmap | -| | --ocean_level=N | elevation cut off for sea level (default = 1.0) | -| | --temps #/#/#/#/#/#| Provide alternate ranges for temperatures. [default = .126/.235/.406/.561/.634/.876] | -| | --humidity #/#/#/#/#/#/# | Provide alternate ranges for humidities. [default = .059/.222/.493/.764/.927/.986/.998] | -| -gv N | --gamma-value N | N = Gamma value for temperature/precipitation gamma correction curve. [default = 1.25] | -| -go N | --gamma-offset N | N = Adjustment value for temperature/precipitation gamma correction curve. [default = .2] | -| | ---not-fade-borders | avoid fading borders | - -### Options valid only for ancient map operations - -| Short | Long | Description | -|-----------|------|-------------| -| -w FILE | --worldfile=FILE | WORLD_FILE to be loaded | -| -g FILE | --generatedfile=FILE | name of the GENERATED_FILE | -| -f N | --resize-factor=N | resize factor | + +For details about all the possible options please refer to the [manual](http://worldengine.readthedocs.org/en/latest/). For example these commands: From c50d5a9a55980de4acf87c7ac17b4f245b1a2a05 Mon Sep 17 00:00:00 2001 From: Federico Tomassetti Date: Mon, 16 Nov 2015 14:55:22 +0100 Subject: [PATCH 2/6] doc: document options in the manual --- manual/cli.rst | 98 +++++++++++++++++++++++++++++++++++++++++++++++- manual/index.rst | 4 +- 2 files changed, 99 insertions(+), 3 deletions(-) diff --git a/manual/cli.rst b/manual/cli.rst index 6c487caa..d2801e02 100644 --- a/manual/cli.rst +++ b/manual/cli.rst @@ -1,4 +1,100 @@ Command line interface ====================== -Using the command line you can issue one single command and let WorldEngine generate a world for you. \ No newline at end of file +Using the command line you can issue one single command and let WorldEngine generate a world for you. + + worldengine [options] [world|plates|ancient_map|info] + + +General options +~~~~~~~~~~~~~~~ + ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| Short | Long | Description | ++============+======================+===============================================================================================================================+ +| -o DIR | --output-dir=DIR | generate files in DIR default = '.' | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| -n STR | --worldname=STR | set world name to STR | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| | --hdf5 | save world using protocol buffer format [default: protocol buffer format ] | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| -s N | --seed=N | use SEED to initialize the pseudo-random generation | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| -t STR | --step=STR | use STEP to specify how far to proceed in the world generation process. Valid values are: plates precipitations full | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| -x N | --width=N | WIDTH of the world to be generated | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| -y N | --height=N | HEIGHT of the world to be generated | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| -q N | --number-of-plates=N | number of plates | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| | --recursion-limit=N | you need that just if you encounter an error while generating very large maps | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| -v | --verbose | Enable verbose messages | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| | --version | Display version information | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| --bw | --black-and-white | Draw maps in black and white | ++------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ + + +Options valid only for generate +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| Short | Long | Description | ++===========+============================+======================================================================================================+ +| -r FILE | --rivers=FILE | produce a map of rivers, after the option it expects the name of the file where to generate the map | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| --gs | --grayscale-heightmap | produce a grayscale heightmap | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --ocean_level=N | elevation cut off for sea level [default = 1.0] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --temps #/#/#/#/#/# | Provide alternate ranges for temperatures. [default = .126/.235/.406/.561/.634/.876] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --humidity #/#/#/#/#/#/# | Provide alternate ranges for humidities. [default = .059/.222/.493/.764/.927/.986/.998] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| -gv N | --gamma-value N | N = Gamma value for temperature/precipitation gamma correction curve. [default = 1.25] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| -go N | --gamma-offset N | N = Adjustment value for temperature/precipitation gamma correction curve. [default = .2] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | ---not-fade-borders | avoid fading borders | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --scatter | generate scatter plot | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --sat | generate satellite map | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ + +Options valid only for ancient map operations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| Short | Long | Description | ++===========+============================+======================================================================================================+ +| -w FILE | --worldfile=FILE | WORLD_FILE to be loaded | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| -g FILE | --generatedfile=FILE | name of the GENERATED_FILE | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| -f N | --resize-factor=N | resize factor | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --sea_color | help="string for color [blue|brown], [default = brown] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --not-draw-biome | Not draw biome | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --not-draw-mountains | Not draw mountains | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --not-draw-rivers | Not draw rivers | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ +| | --draw-outer-border | Draw outer land border | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------+ + +Export options +~~~~~~~~~~~~~~ + ++-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| Short | Long | Description | ++===========+============================+================================================================================================================================+ +| | --export-format | Export to a specific format such as BMP or PNG. See http://www.gdal.org/formats_list.html for possible formats [default = PNG] | ++-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| | --export-datatype | Type of stored data, e.g. uint16, int32, float32 etc. [default = uint16] | ++-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ \ No newline at end of file diff --git a/manual/index.rst b/manual/index.rst index de1990fc..553d6ae6 100644 --- a/manual/index.rst +++ b/manual/index.rst @@ -1,7 +1,7 @@ WorldEngine - the best open-source world generator ================================================== -WorldEngine is intended to be the best open-source world generator available. It is based on the simulation of several physical phenomens. +WorldEngine has the goal to be the best open-source world generator available. It is based on the simulation of several physical phenomens. Our philosophy is to build a tool very flexibile, which can be used from the command line, in a GUI or as a component inside other programs. @@ -9,7 +9,7 @@ WorldEngine can be very easy to use: you click a button and you get a nice world It can also be very complex: do you want to set specific temperature or humidity ranges for your world? Specify a strange ratio for your map? You can. -We think a great that most advanced users could want to use WorldEngine as a part of larger tool-chain: you give some draft of your world to WorldEngine, it performs some extra simulations for you, making your world more realistic, and then you feed the result from WorldEngine into another tool of yours or perhaps you refine manually your results. +We think that most advanced users could want to use WorldEngine as a part of larger tool-chain: you give some draft of your world to WorldEngine, it performs some extra simulations for you, making your world more realistic, and then you feed the result from WorldEngine into another tool of yours or perhaps you refine manually your results. So WorldEngine can be used in different ways. Let's see how. From 54401ffd48af64db960b85fe492b0a6536b70486 Mon Sep 17 00:00:00 2001 From: Federico Tomassetti Date: Mon, 16 Nov 2015 14:57:40 +0100 Subject: [PATCH 3/6] doc: remove reference to pickle and add reference to hdf5 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7bd4deec..34147067 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Interoperability (Python, Java) We would love to see WorldEngine used together with other tools. Worlds generated by WorldEngine can be loaded into python applications using WorldEngine itself as a library. Java applications can instead use [WorldEngine-Java](https://github.com/Mindwerks/worldengine-java), a java library to load WorldEngine files. -Worlds can be saved using pickle or protobuf format, for which there are libraries in several languages. We keep working on supporting more formats and always interested in ways to improve interoperability. +Worlds can be saved using the protobuf format or hdf5, for which there are libraries in several languages. We keep working on supporting more formats and always interested in ways to improve interoperability. Binary packages =============== From 32196a76956849fe14b717e6d82a7d7e66e2c37d Mon Sep 17 00:00:00 2001 From: Federico Tomassetti Date: Mon, 16 Nov 2015 15:03:50 +0100 Subject: [PATCH 4/6] README: minor --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 34147067..004a5bba 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,8 @@ The program produces a binary format with all the data of the generated world an ![](https://raw.githubusercontent.com/Mindwerks/worldengine-data/master/images/examples/world_seed_1_ocean.png) +There are several optional outputs and many options to control the result. The [manual](http://worldengine.readthedocs.org/en/latest/) is your friend! + Usage ===== @@ -288,10 +290,10 @@ If you are using WorldEngine please let us know! Contributors ============ -The merged project is maintained by [Bret Curtis](https://github.com/psi29a) and [Federico Tomassetti](https://github.com/ftomassetti). +The this project is maintained by [Bret Curtis](https://github.com/psi29a) and [Federico Tomassetti](https://github.com/ftomassetti). All contributions, questions, ideas are more than welcome! -Feel free to open an issue or write in our [google group](https://groups.google.com/forum/?hl=en#!forum/lands_worldsynth). +Feel free to open an issue or write in our [google group](https://groups.google.com/forum/?hl=en#!forum/worldengine). We would like to thank you great people who helped us while working on WorldEngine and the projects from which it was derived: From 4dda5e8f89e4252e1c2540f145c4aba9b2f70c45 Mon Sep 17 00:00:00 2001 From: Federico Tomassetti Date: Mon, 16 Nov 2015 15:41:28 +0100 Subject: [PATCH 5/6] README: remove requirements section --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 004a5bba..cb457924 100644 --- a/README.md +++ b/README.md @@ -273,11 +273,6 @@ You can write us at: * psi29a _at_ gmail _dot_ com Thank you, all the feedback is precious for us! -Requirements -============ - -Libjpeg, libtiff and zlib are required by Pillow - Projects using WorldEngine ========================== From 7145804023e7b979ab2e5cdd144312ccbc15936e Mon Sep 17 00:00:00 2001 From: Federico Tomassetti Date: Tue, 17 Nov 2015 09:00:03 +0100 Subject: [PATCH 6/6] manual: addressing several comments from tcld --- README.md | 2 +- manual/cli.rst | 52 +++++++++++++++++++++++++------------------------- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index cb457924..4e3906e5 100644 --- a/README.md +++ b/README.md @@ -285,7 +285,7 @@ If you are using WorldEngine please let us know! Contributors ============ -The this project is maintained by [Bret Curtis](https://github.com/psi29a) and [Federico Tomassetti](https://github.com/ftomassetti). +This project is maintained by [Bret Curtis](https://github.com/psi29a) and [Federico Tomassetti](https://github.com/ftomassetti). All contributions, questions, ideas are more than welcome! Feel free to open an issue or write in our [google group](https://groups.google.com/forum/?hl=en#!forum/worldengine). diff --git a/manual/cli.rst b/manual/cli.rst index d2801e02..06fbc7c6 100644 --- a/manual/cli.rst +++ b/manual/cli.rst @@ -34,36 +34,36 @@ General options +------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ | | --version | Display version information | +------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ -| --bw | --black-and-white | Draw maps in black and white | +| --bw | --black-and-white | Draw maps in black and white (currently affects only the precipitation and temperature maps) | +------------+----------------------+-------------------------------------------------------------------------------------------------------------------------------+ Options valid only for generate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| Short | Long | Description | -+===========+============================+======================================================================================================+ -| -r FILE | --rivers=FILE | produce a map of rivers, after the option it expects the name of the file where to generate the map | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| --gs | --grayscale-heightmap | produce a grayscale heightmap | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| | --ocean_level=N | elevation cut off for sea level [default = 1.0] | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| | --temps #/#/#/#/#/# | Provide alternate ranges for temperatures. [default = .126/.235/.406/.561/.634/.876] | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| | --humidity #/#/#/#/#/#/# | Provide alternate ranges for humidities. [default = .059/.222/.493/.764/.927/.986/.998] | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| -gv N | --gamma-value N | N = Gamma value for temperature/precipitation gamma correction curve. [default = 1.25] | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| -go N | --gamma-offset N | N = Adjustment value for temperature/precipitation gamma correction curve. [default = .2] | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| | ---not-fade-borders | avoid fading borders | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| | --scatter | generate scatter plot | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ -| | --sat | generate satellite map | -+-----------+----------------------------+------------------------------------------------------------------------------------------------------+ ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| Short | Long | Description | ++===========+============================+================================================================================================================================================+ +| -r FILE | --rivers=FILE | Produce a map of rivers, after the option it expects the name of the file where to generate the map | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| --gs | --grayscale-heightmap | Produce a grayscale heightmap | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| | --ocean_level=N | Elevation cut off for sea level [default = 1.0] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| | --temps #/#/#/#/#/# | Specify the quantiles used to identify the temperature levels. It should contains values in [0,1]. [default = .126/.235/.406/.561/.634/.876] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| | --humidity #/#/#/#/#/#/# | Specify the quantiles used to identify the humidity levels. It should contains values in [0,1]. [default = .059/.222/.493/.764/.927/.986/.998] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| -gv N | --gamma-value N | N = Gamma value for temperature/precipitation gamma correction curve. [default = 1.25] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| -go N | --gamma-offset N | N = Adjustment value for temperature/precipitation gamma correction curve. [default = .2] | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| | ---not-fade-borders | Avoid fading borders | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| | --scatter | Generate temperature vs. humidity scatter plot | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ +| | --sat | Generate satellite map | ++-----------+----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ Options valid only for ancient map operations ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -94,7 +94,7 @@ Export options +-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | Short | Long | Description | +===========+============================+================================================================================================================================+ -| | --export-format | Export to a specific format such as BMP or PNG. See http://www.gdal.org/formats_list.html for possible formats [default = PNG] | +| | --export-format=FORMAT | Export to a specific format such as BMP or PNG. See http://www.gdal.org/formats_list.html for possible formats [default = PNG] | +-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| | --export-datatype | Type of stored data, e.g. uint16, int32, float32 etc. [default = uint16] | +| | --export-datatype=TYPE | Type of stored data, e.g. uint16, int32, float32 etc. [default = uint16] | +-----------+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+ \ No newline at end of file