diff --git a/.gitignore b/.gitignore index bb706de3a..e65bea446 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ _site/ +vendor/ Thumbs.db .jekyll-metadata Gemfile.lock +.bundle/config diff --git a/_config.yml b/_config.yml index 4e68ec714..c6bdd7ad8 100644 --- a/_config.yml +++ b/_config.yml @@ -17,12 +17,16 @@ defaults: values: layout: docs +collections: + - world_examples + exclude: - README.md - /*.pdn - /*.xcf - /Thumbs.db - /.unused + - vendor plugins: - jekyll-paginate @@ -30,6 +34,8 @@ plugins: - jekyll-feed - jekyll-redirect-from +highlighter: rouge + permalink: '/posts/:year/:month/:day/:title/' paginate: 5 paginate_path: "/posts/page-:num/" diff --git a/_data/docnav.yml b/_data/docnav.yml index 6d5311927..b21429881 100644 --- a/_data/docnav.yml +++ b/_data/docnav.yml @@ -137,6 +137,8 @@ cofh-world: items: - title: Commands url: commands/ + - title: Examples + url: examples/ thermal-foundation: title: Thermal Foundation 2 diff --git a/_includes/example.md b/_includes/example.md new file mode 100644 index 000000000..d3319668b --- /dev/null +++ b/_includes/example.md @@ -0,0 +1,60 @@ +{% if include.primary %} + {% assign classes="uk-panel uk-panel-box-primary uk-panel-box" %} +{% else %} + {% assign classes="uk-panel uk-panel-box" %} +{% endif %} + +### {{ include.title }} + +
+
+
+ {{ include.content | markdownify }} + + {% if include.link.code.embed %} + + {% endif %} + + {% if include.images.size == 0 %} + {% include notice.html notice="There are no images for this example!" %} + {% endif %} + +
+ {% for image in include.images %} +
+ + + +
+ {% endfor %} +
+ +
+ {% if include.showDocs %} + + View documentation + + {% endif %} + + + + {% if include.link.code.download %} + + Download code + + {% endif %} +
+
+
+
diff --git a/_includes/examples.html b/_includes/examples.html new file mode 100644 index 000000000..2e156554b --- /dev/null +++ b/_includes/examples.html @@ -0,0 +1,38 @@ + + +{% if include.group %} + + {% assign examples = site.world_examples + | where: "group", include.group + %} + +{% else if include.type %} + + {% assign examples = site.world_examples + | where: "type", include.type + %} + +{% endif %} + +{% assign examples = examples + | where: "primary", include.primary +%} + +{% if examples.size == 0 %} + + {% include notice.html notice="There are currently no examples!" %} + +{% endif %} + +{% for example in examples %} + + {% include example.md + type=example.type + link=example.link + title=example.title + images=example.images + primary=example.primary + showDocs=include.showDocs + content=example.content %} + +{% endfor %} diff --git a/_includes/notice.html b/_includes/notice.html new file mode 100644 index 000000000..35a19c6ae --- /dev/null +++ b/_includes/notice.html @@ -0,0 +1,3 @@ +
+

{{ include.notice }}

+
\ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html index 302f52fe1..bc8ece4f5 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -33,17 +33,26 @@ + + {% for style in layout.styles %} + + {% endfor %} + + + {% for script in layout.scripts %} + + {% endfor %} - + {% if page.show_banner %}
diff --git a/_layouts/docs.html b/_layouts/docs.html index 2bafaacb9..cd620dc58 100644 --- a/_layouts/docs.html +++ b/_layouts/docs.html @@ -1,5 +1,12 @@ --- layout: default +styles: + - /assets/css/highlight/vs.css + - /assets/css/uikit/components/slidenav.min.css + - /assets/css/uikit/components/slider.min.css +scripts: + - /assets/js/uikit/components/lightbox.min.js + - /assets/js/uikit/components/slider.min.js ---
diff --git a/_world_examples/README.md b/_world_examples/README.md new file mode 100644 index 000000000..087964426 --- /dev/null +++ b/_world_examples/README.md @@ -0,0 +1,34 @@ +--- +link: + # An absolute internal link to the corresponding documentation page. + docs: /foo/bar/baz/ + # An absolute (internal or external) link to the example JSON file. + file: https://gist.github/user/f83og0247gh078h0327hgs30972th087 +# Can be either distribution or feature. +type: feature +# The group is important since we can't group things by directory/Jekyll doesn't +# support "sub-collections". The group allows us to use the groupBy Liquid filter +# on the examples collection. TL;DR: EVERY example for each INDIVIDUAL +# distribution and feature type all belong to the same group. +group: my-group +# Self-explanatory. +title: My lovely title. +# Can be either true or false. If true, this is regarded as the primary example +# which for now just means that it shows up on the big examples page. Otherwise +# it will show up on the actual documentation page for the feature/distribution type. +primary: true | false +# Self-explanatory. Note that for now the images must be in assetse/examples/ and +# external images are not supported. +images: + - + href: example1.png + title: I am the first example. + - + href: example2.png + title: I am the second title. + - + href: example3.png + title: I am the third title. +--- + +The description goes here. You can use arbitrary markdown, should you desire. diff --git a/_world_examples/common-formats/block-id/block-id.md b/_world_examples/common-formats/block-id/block-id.md new file mode 100644 index 000000000..f98cc65f3 --- /dev/null +++ b/_world_examples/common-formats/block-id/block-id.md @@ -0,0 +1,14 @@ +--- +link: + docs: docs/cofh-world/world-generator-configuration/common-formats/block-id/ + code: + embed: + download: +type: common-format +group: block-id +title: Block ID +primary: true +images: [] +--- + +This is an example for the Block ID common format. diff --git a/_world_examples/common-formats/number-provider/number-provider.md b/_world_examples/common-formats/number-provider/number-provider.md new file mode 100644 index 000000000..eaccb2a38 --- /dev/null +++ b/_world_examples/common-formats/number-provider/number-provider.md @@ -0,0 +1,14 @@ +--- +link: + docs: docs/cofh-world/world-generator-configuration/common-formats/number-provider/ + code: + embed: + download: +type: common-format +group: number-provider +title: Number Provider +primary: true +images: [] +--- + +This is an example for the Number Provider common format. diff --git a/_world_examples/common-formats/weighted-string/weighted-string.md b/_world_examples/common-formats/weighted-string/weighted-string.md new file mode 100644 index 000000000..2a867f8d3 --- /dev/null +++ b/_world_examples/common-formats/weighted-string/weighted-string.md @@ -0,0 +1,17 @@ +--- +link: + docs: docs/cofh-world/world-generator-configuration/common-formats/weighted-string +type: common-format +group: weighted-string +title: Weighted String +primary: true +images: [] +--- + +This is an example for the Weighted String common format. + +```json +{ + "enabled": true +} +``` diff --git a/_world_examples/distribution-types/cave/cave.md b/_world_examples/distribution-types/cave/cave.md new file mode 100644 index 000000000..5a3020292 --- /dev/null +++ b/_world_examples/distribution-types/cave/cave.md @@ -0,0 +1,14 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/cave/ + code: + embed: https://gist.github.com/sustained/fd95551c9e89d06c3d7678ad5240a98f.js + download: https://gist.github.com/sustained/fd95551c9e89d06c3d7678ad5240a98f/archive/f18a680038d5d89cbbe3bd048fd7cea095912af8.zip +type: distribution +group: cave +title: Cave +primary: true +images: [] +--- + +This is an example of distributing in caves. diff --git a/_world_examples/distribution-types/custom/custom.md b/_world_examples/distribution-types/custom/custom.md new file mode 100644 index 000000000..b480cbbf0 --- /dev/null +++ b/_world_examples/distribution-types/custom/custom.md @@ -0,0 +1,14 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/custom/ + code: + embed: https://gist.github.com/sustained/20c67f174a3bd1902f9f13d40cc93098.js + download: https://gist.github.com/sustained/20c67f174a3bd1902f9f13d40cc93098/archive/7bfbc131a87411c3ff81c91ccb9a5ef702526d0e.zip +type: distribution +group: custom +title: Custom +primary: true +images: [] +--- + +This is an example of distributing in a custom manner. diff --git a/_world_examples/distribution-types/fractal/fractal.md b/_world_examples/distribution-types/fractal/fractal.md new file mode 100644 index 000000000..4baeafb37 --- /dev/null +++ b/_world_examples/distribution-types/fractal/fractal.md @@ -0,0 +1,13 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/fractal/ + code: + embed: https://gist.github.com/sustained/e8d231aca94d14a68892eddfb5d94d7e.js + download: https://gist.github.com/sustained/e8d231aca94d14a68892eddfb5d94d7e/archive/5be68cc6df9135e27edab94f802c5e062b53de99.zip +type: distribution +group: fractal +title: Fractal +images: [] +--- + +This is an example of distributing fractally. diff --git a/_world_examples/distribution-types/gaussian/gaussian.md b/_world_examples/distribution-types/gaussian/gaussian.md new file mode 100644 index 000000000..b7a899d10 --- /dev/null +++ b/_world_examples/distribution-types/gaussian/gaussian.md @@ -0,0 +1,14 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/gaussian/ + code: + embed: https://gist.github.com/sustained/51e74927ca127d40b6aa6648eeb44a4b.js + download: https://gist.github.com/sustained/51e74927ca127d40b6aa6648eeb44a4b/archive/d9ceaa413c6569590db1a0f8749a81f5f1405682.zip +type: distribution +group: gaussian +title: Gaussian +primary: true +images: [] +--- + +This is an example of distributing via a gaussian method. diff --git a/_world_examples/distribution-types/sequential/sequential.md b/_world_examples/distribution-types/sequential/sequential.md new file mode 100644 index 000000000..425d9c581 --- /dev/null +++ b/_world_examples/distribution-types/sequential/sequential.md @@ -0,0 +1,14 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/sequential/ + code: + embed: https://gist.github.com/sustained/32b76d4c171e484b2e6343ed02e812c6.js + download: https://gist.github.com/sustained/32b76d4c171e484b2e6343ed02e812c6/archive/6997ab96fc5e176a7d68aa185d32eff09c2b3407.zip +type: distribution +group: sequential +title: Sequential +primary: true +images: [] +--- + +This is an example of distributing sequentially. diff --git a/_world_examples/distribution-types/surface/surface.md b/_world_examples/distribution-types/surface/surface.md new file mode 100644 index 000000000..690a79e69 --- /dev/null +++ b/_world_examples/distribution-types/surface/surface.md @@ -0,0 +1,14 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/surface/ + code: + embed: https://gist.github.com/sustained/3b00a7c9dc3743d59da6948006badc4d.js + download: https://gist.github.com/sustained/3b00a7c9dc3743d59da6948006badc4d/archive/fa185bd33ab859e498860c8323dc3c60ee8109b7.zip +type: distribution +group: surface +title: Surface +primary: true +images: [] +--- + +This is an example of distributing on the surface. diff --git a/_world_examples/distribution-types/underfluid/underfluid.md b/_world_examples/distribution-types/underfluid/underfluid.md new file mode 100644 index 000000000..6f426bd13 --- /dev/null +++ b/_world_examples/distribution-types/underfluid/underfluid.md @@ -0,0 +1,14 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/underfluid/ + code: + embed: https://gist.github.com/sustained/ed670beea25c122c37c7e75cf73c8172.js + download: https://gist.github.com/sustained/ed670beea25c122c37c7e75cf73c8172/archive/2b59874cb68979e33c55a2c029a90edad5c0088f.zip +type: distribution +group: underfluid +title: Underfluid +primary: true +images: [] +--- + +This is an example of distributing underfluid. diff --git a/_world_examples/distribution-types/underwater/underwater.md b/_world_examples/distribution-types/underwater/underwater.md new file mode 100644 index 000000000..b420a8f61 --- /dev/null +++ b/_world_examples/distribution-types/underwater/underwater.md @@ -0,0 +1,14 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/underwater/ + code: + embed: https://gist.github.com/sustained/ffcb2b9ee40925d52c06ff2ec301de05.js + download: https://gist.github.com/sustained/ffcb2b9ee40925d52c06ff2ec301de05/archive/4bc6b18052b66452e41e9a5a830ee75e98ed000c.zip +type: distribution +group: underwater +title: Underwater +primary: true +images: [] +--- + +This is an example of distributing underwater. diff --git a/_world_examples/distribution-types/uniform/uniform.md b/_world_examples/distribution-types/uniform/uniform.md new file mode 100644 index 000000000..74e72ef98 --- /dev/null +++ b/_world_examples/distribution-types/uniform/uniform.md @@ -0,0 +1,14 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/distribution-types/uniform/ + code: + embed: https://gist.github.com/sustained/35f042f862e142d271dd72256184bb78.js + download: https://gist.github.com/sustained/35f042f862e142d271dd72256184bb78/archive/652d23d977c0a72775d900ae3ba1dd9f0c75235a.zip +type: distribution +group: uniform +title: Uniform +primary: true +images: [] +--- + +This is an example of distributing uniformly. diff --git a/_world_examples/feature-types/boulder/boulder.md b/_world_examples/feature-types/boulder/boulder.md new file mode 100644 index 000000000..ba0188985 --- /dev/null +++ b/_world_examples/feature-types/boulder/boulder.md @@ -0,0 +1,28 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/boulder/ + code: + embed: https://gist.github.com/sustained/7d73ebefa0ef7f9c64be08fd05bece78.js + download: https://gist.github.com/sustained/7d73ebefa0ef7f9c64be08fd05bece78/archive/6ca1d4a6c2a8057fd4106cd205fe90882c8b08b4.zip +type: feature +group: boulder +title: "Boulder: Mossy Cobblestone Boulders" +primary: true +images: + - + href: boulder/primary/one.png + title: A close-up of an individual boulder. + - + href: boulder/primary/two.png + title: A wide shot of many boulders littered across the landscape. + - + href: boulder/primary/three.png + title: A birdseye-view of many boulders. +--- + +Let's spawn some boulders made of cobblestone and mossy cobblestone (see: `block`) upon the surface of the world. + +- Our boulders have a `diameter` of 3 and a `size-variance` of 2 (which is the default). +- One in four chunks will spawn this feature (see: `chunk-chance`). +- For each of those chunks, the generator will attempt to spawn our feature once (see: `cluster-count`). +- Each cluster is comprised of a single boulder (see: `count`). \ No newline at end of file diff --git a/_world_examples/feature-types/cluster/cluster.md b/_world_examples/feature-types/cluster/cluster.md new file mode 100644 index 000000000..36bf2b9d8 --- /dev/null +++ b/_world_examples/feature-types/cluster/cluster.md @@ -0,0 +1,28 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/cluster/ + code: + embed: https://gist.github.com/sustained/b32fe2255dc566700e93f8653aafe8cc.js + download: https://gist.github.com/sustained/b32fe2255dc566700e93f8653aafe8cc/archive/2098dee6eaa663bdc6b5132caf51e034784656fc.zip +type: feature +group: cluster +title: "Cluster: Iron Ore Clusters" +primary: true +images: + - + href: cluster/primary/one.png + title: An individual cluster of iron ore. + - + href: cluster/primary/two.png + title: A view from below of a 5x5 chunk area with everything stripped except the iron ore. + - + href: cluster/primary/three.png + title: A view from above of a 5x5 chunk area with everything stripped except the iron ore (which is highlighted). +--- + +Next we'll spawn some clusters of iron ore. + +- Our clusters have a `cluster-size` of 8 (note that this is not equivalent to number of blocks). +- They will be spawned between Y=0 and Y=64 (see: `min-height`, `max-height`). +- One in eight chunks will spawn this feature (see: `chunk-chance`). +- For each of those chunks, the generator will attempt to spawn our feature eight times (see: `cluster-count`). diff --git a/_world_examples/feature-types/consecutive/consecutive.md b/_world_examples/feature-types/consecutive/consecutive.md new file mode 100644 index 000000000..45e6163bc --- /dev/null +++ b/_world_examples/feature-types/consecutive/consecutive.md @@ -0,0 +1,35 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/consecutive/ + code: + embed: https://gist.github.com/sustained/4da2c926a9040b9bfe925f6400eae87e.js + download: https://gist.github.com/sustained/4da2c926a9040b9bfe925f6400eae87e/archive/1b54e077b442c202943191f571db7a89df54fcdb.zip +type: feature +group: consecutive +title: "Consecutive: Varied Stone Spikes" +primary: true +images: + - + href: consecutive/primary/one.png + title: A close up of a group of 4 spikes. + - + href: consecutive/primary/two.png + title: Shows several groups of spikes scattered around from up high. + - + href: consecutive/primary/three.png + title: A single group of spikes from a birds-eye view. +--- + +We'll make it so that 1 in 64 chunks have a chance of spawning a group of 4 spikes. + +The spikes will consist of andesite, diorite, granite and stone. + +The world generator will go through the `generators` **consecutively**: + +* First it will try to spawn a spike made of stone. +* Secondly it will try andesite. +* etc. + +This will happen 4 times (`cluster-count`) for each chunk chosen. + +Bear in mind that generation attempts can fail! So it's possible that a stone spike will be generated then an andesite spike will be attempted (but fail) and next a granite spike will be spawned. diff --git a/_world_examples/feature-types/decoration/decoration.md b/_world_examples/feature-types/decoration/decoration.md new file mode 100644 index 000000000..d32ddd459 --- /dev/null +++ b/_world_examples/feature-types/decoration/decoration.md @@ -0,0 +1,23 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/decoration/ + code: + embed: https://gist.github.com/sustained/9a60fd1e8ab2ff290a43cad2baaedda8.js + download: https://gist.github.com/sustained/9a60fd1e8ab2ff290a43cad2baaedda8/archive/652eda713b9feada6da51fb5e6537885837574a8.zip +type: feature +group: decoration +title: "Decoration: Dandelion Groups" +primary: true +images: + - + href: decoration/primary/one.png + title: A close-up of a cluster of dandelions. + - + href: decoration/primary/two.png + title: A wide, sweeping shot showing many clusters of dandelions. + - + href: decoration/primary/three.png + title: A handful of clusters of dandelions from above. +--- + +In this example, we'll spawn large groups of dandelions around the surface of the world. diff --git a/_world_examples/feature-types/geode/geode.md b/_world_examples/feature-types/geode/geode.md new file mode 100644 index 000000000..b8a2ee4ac --- /dev/null +++ b/_world_examples/feature-types/geode/geode.md @@ -0,0 +1,23 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/geode/ + code: + embed: https://gist.github.com/sustained/898757dad45ddfc239421084e427c954.js + download: https://gist.github.com/sustained/898757dad45ddfc239421084e427c954/archive/a8003506f607387148531c042dd14e83bb9a287b.zip +type: feature +group: geode +title: "Geode: Iron & Gold Geodes" +primary: true +images: + - + href: geode/primary/one.png + title: A close-up of a smooth andesite geode. + - + href: geode/primary/two.png + title: A smooth andesite geode with a cross-section cut away, revealing the iron and gold ore within. + - + href: geode/primary/three.png + title: A broad shot showing smooth andesite geodes dotted around the landscape. +--- + +Let's spawn some geodes consisting of a smooth andesite crust with iron and gold ore within. diff --git a/_world_examples/feature-types/lake/lake.md b/_world_examples/feature-types/lake/lake.md new file mode 100644 index 000000000..ec4ce058d --- /dev/null +++ b/_world_examples/feature-types/lake/lake.md @@ -0,0 +1,23 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/lake/ + code: + embed: https://gist.github.com/sustained/02afb74334709fcbd6524d146b3c58e1.js + download: https://gist.github.com/sustained/02afb74334709fcbd6524d146b3c58e1/archive/e4c27a6ea20aeeaa88bea598c7f033d2b879b0ff.zip +type: feature +group: lake +title: "Lake: Surface Lava Lakes" +primary: true +images: + - + href: lake/primary/one.png + title: A single lava lake viewed from an angle. + - + href: lake/primary/two.png + title: Many lava lakes spread out over the world's surface. + - + href: lake/primary/three.png + title: Three lava lakes viewed from above. +--- + +We will distribute lava lakes upon the world's surface, for this example. diff --git a/_world_examples/feature-types/large-vein/large-vein.md b/_world_examples/feature-types/large-vein/large-vein.md new file mode 100644 index 000000000..7cec7683a --- /dev/null +++ b/_world_examples/feature-types/large-vein/large-vein.md @@ -0,0 +1,29 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/large-vein/ + code: + embed: https://gist.github.com/sustained/bce1c8d264662e46c324b8b67b9acafe.js + download: https://gist.github.com/sustained/bce1c8d264662e46c324b8b67b9acafe/archive/e37480baf198bb1cb656292195e6e324b2907458.zip +type: feature +group: large-vein +title: "Large Vein: Large Veins of Bone" +primary: true +images: + - + href: large-vein/primary/one.png + title: A large vein of bone blocks protruding from the surface. + - + href: large-vein/primary/two.png + title: Several large bone block veins scattered around the world. + - + href: large-vein/primary/three.png + title: A large vein with the earth around it removed, showing how the extents of the vein go below the surface. + - + href: large-vein/primary/four.png + title: A large vein with the earth around it removed but from below. + - + href: large-vein/primary/five.png + title: A large vein with the bone blocks highlighted, even those which are below the surface. +--- + +We'll spawn large veins of bone blocks which poke out of the ground, something akin to heavily degraded dinosaur fossils. diff --git a/_world_examples/feature-types/plate/plate.md b/_world_examples/feature-types/plate/plate.md new file mode 100644 index 000000000..6f962d4a3 --- /dev/null +++ b/_world_examples/feature-types/plate/plate.md @@ -0,0 +1,23 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/plate/ + code: + embed: https://gist.github.com/sustained/83146f70072168bd7c226243db71357e.js + download: https://gist.github.com/sustained/83146f70072168bd7c226243db71357e/archive/1b4931e7c3041aac52cc24a8e386dd5d003eefbd.zip +type: feature +group: plate +title: "Plate: Cobblestone Cylinders" +primary: true +images: + - + href: plate/primary/one.png + title: A cylindrical cobblestone structure viewed from above. + - + href: plate/primary/two.png + title: A cylindrical cobblestone structure viewed from an angle. + - + href: plate/primary/three.png + title: Cobblestone cylinders sparsely distributed around the surface. +--- + +Cylindrical cobblestone structures will spawn relatively uncommonly upon the world's surface, using the code from this example. diff --git a/_world_examples/feature-types/sequential/sequential.md b/_world_examples/feature-types/sequential/sequential.md new file mode 100644 index 000000000..cb77ecc6b --- /dev/null +++ b/_world_examples/feature-types/sequential/sequential.md @@ -0,0 +1,28 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/sequential/ + code: + embed: https://gist.github.com/sustained/d6dcfc20ef1b9af102a148d4acc33e55.js + download: https://gist.github.com/sustained/d6dcfc20ef1b9af102a148d4acc33e55/archive/f1c1e24c747f54be57ad29926b6849c029eb7ac2.zip +type: feature +group: sequential +title: "Sequential: Lava Lakes with Obsidian Spikes" +primary: true +images: + - + href: sequential/primary/one.png + title: A lava lake with an obsidian spike protruding from it. + - + href: sequential/primary/two.png + title: Three lava lakes each with an obsidian spike poking out. + - + href: sequential/primary/three.png + title: Lots of lava lakes dotted about the surface each with their own obsidian spike. +--- + +We'll spawn a sequence of two items in the same position: + +* a lava lake +* a spike + +The final result is lava lakes with obsidian spikes protruding from them. diff --git a/_world_examples/feature-types/small-tree/small-tree.md b/_world_examples/feature-types/small-tree/small-tree.md new file mode 100644 index 000000000..339342883 --- /dev/null +++ b/_world_examples/feature-types/small-tree/small-tree.md @@ -0,0 +1,23 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/small-tree + code: + embed: https://gist.github.com/sustained/dd931ea678e22f3740a7b2f1f00b6a6d.js + download: https://gist.github.com/sustained/dd931ea678e22f3740a7b2f1f00b6a6d/archive/a5d0d92b55580b64130f03ad89d011414a33a36d.zip +type: feature +group: small-tree +title: "Small Tree: Strange Nether Trees" +primary: true +images: + - + href: small-tree/primary/one.png + title: A strange tree viewed from an angle. + - + href: small-tree/primary/two.png + title: Four strange trees spread out evenly. + - + href: small-tree/primary/three.png + title: A side-view of many strange trees. +--- + +If the Nether had trees, perhaps this is what they'd look like? diff --git a/_world_examples/feature-types/sparse-cluster/sparse-cluster.md b/_world_examples/feature-types/sparse-cluster/sparse-cluster.md new file mode 100644 index 000000000..e7870a824 --- /dev/null +++ b/_world_examples/feature-types/sparse-cluster/sparse-cluster.md @@ -0,0 +1,25 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/sparse-cluster/ + code: + embed: https://gist.github.com/sustained/948ddbe91c504119b6b0b678cbe29044.js + download: https://gist.github.com/sustained/948ddbe91c504119b6b0b678cbe29044/archive/341cd9fe73a9a6dd3ba25e9121142ed6374b9839.zip +type: feature +group: sparse-cluster +title: "Sparse Cluster: Small Iron Ore Clusters" +primary: true +images: + - + href: sparse-cluster/primary/one.png + title: A close-up view with everything stripped except for several sparse clusters of iron ore. + - + href: sparse-cluster/primary/two.png + title: A view from below of a 5x5 chunk area with everything stripped except the sparse clusters of iron ore. + - + href: sparse-cluster/primary/three.png + title: A view from above of a 5x5 chunk area with everything stripped except the sparse clusters of iron ore. +--- + +Clusters and Sparse Clusters are very similar, so for this example we've left every value identical to the Cluster example **except for** the only value which acts differently - `cluster-size`. + +You may [read the documentation](docs/cofh-world/world-generator-configuration/feature-types/sparse-cluster/) for Sparse Clusters to learn more. diff --git a/_world_examples/feature-types/spike/spike.md b/_world_examples/feature-types/spike/spike.md new file mode 100644 index 000000000..cea56fbbb --- /dev/null +++ b/_world_examples/feature-types/spike/spike.md @@ -0,0 +1,23 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/spike/ + code: + embed: https://gist.github.com/sustained/195ac833b59d9cd07c607025451f2422.js + download: https://gist.github.com/sustained/195ac833b59d9cd07c607025451f2422/archive/5c666ada53ae4b4aa16212966d48e3a11ee01cfe.zip +type: feature +group: spike +title: "Spike: Red Hardened Clay Spikes" +primary: true +images: + - + href: spike/primary/one.png + title: Three spikes made of red hardened clay. + - + href: spike/primary/two.png + title: Several groups of red hardened clay spikes viewed from above. + - + href: spike/primary/three.png + title: A side-view of tens of groups of red hardened clay spikes all the way to the horizon. +--- + +We'll spawn groups of 3 red hardened clay spikes for this example. diff --git a/_world_examples/feature-types/spout/sink-holes.md b/_world_examples/feature-types/spout/sink-holes.md new file mode 100644 index 000000000..be96df7d9 --- /dev/null +++ b/_world_examples/feature-types/spout/sink-holes.md @@ -0,0 +1,60 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/spout/ +type: feature +group: spout +title: Sinkholes +primary: false +images: + - + href: spout/sinkholes/one.png + title: A sinkhole extending down to a ravine, viewed from above the ground. + - + href: spout/sinkholes/two.png + title: The same sinkhole as viewed from the side in spectator mode. + - + href: spout/sinkholes/three.png + title: Several sinkholes reaching into different caves and ravines from the side in spectator mode. +--- + +This is an example of spawning sinkholes which reach down into caves/ravines and other underground open areas. + +```json +{ + "populate": { + "spout_example": { + "distribution": "cave", + "generator": { + "type": "spout", + "block": "minecraft:air", + "radius": 3, + "height": { + "value-a": { + "value-a": { + "world-data": "SURFACE_BLOCK" + }, + "value-b": { + "world-data": "CURRENT_Y" + }, + "operation": "SUBTRACT" + }, + "value-b": 20, + "operation": "ADD" + }, + "material": [ + "minecraft:dirt", + "minecraft:sand", + "minecraft:stone", + "minecraft:sandstone", + "minecraft:gravel", + "minecraft:grass", + "minecraft:log", + "minecraft:leaves" + ] + }, + "cluster-count": 1, + "chunk-chance": 8 + } + } +} +``` diff --git a/_world_examples/feature-types/spout/spout.md b/_world_examples/feature-types/spout/spout.md new file mode 100644 index 000000000..c2ae123ac --- /dev/null +++ b/_world_examples/feature-types/spout/spout.md @@ -0,0 +1,25 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/spout/ + code: + embed: https://gist.github.com/sustained/84b67791b1ac04bcc0b6dbb7582c2eca.js + download: https://gist.github.com/sustained/84b67791b1ac04bcc0b6dbb7582c2eca/archive/4286f402e7cfd68621e3912ba5adc93a2572630a.zip +type: feature +group: spout +title: "Spout: Cobblestone Pillars" +primary: true +images: + - + href: spout/primary/one.png + title: A 1x1 cobblestone pillar reaching up into the sky. + - + href: spout/primary/two.png + title: Many 1x1 cobblestone pillars of varying heights dotted across the landscape. + - + href: spout/primary/three.png + title: Many 1x1 cobblestone pillars of varying heights dotted across the landscape. +--- + +It looks like someone has been pillaring up into the sky for some reason and forgot to clean up after themselves! + +At least, that's how we are going to make it appear with this example. diff --git a/_world_examples/feature-types/stalactite/stalactite.md b/_world_examples/feature-types/stalactite/stalactite.md new file mode 100644 index 000000000..05313054f --- /dev/null +++ b/_world_examples/feature-types/stalactite/stalactite.md @@ -0,0 +1,23 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/stalactite/ + code: + embed: https://gist.github.com/sustained/7c932bcf15a5f3596e33dd56d8854cd8.js + download: https://gist.github.com/sustained/7c932bcf15a5f3596e33dd56d8854cd8/archive/2e53ff310aab0921367590f9c23675eec1ca9b06.zip +type: feature +group: stalactite +title: "Stalactite: Large Mossy Cobblestone Stalactites" +primary: true +images: + - + href: stalactite/primary/one.png + title: A close-up of several large stalactites. + - + href: stalactite/primary/two.png + title: Several stalactites in the foreground with hundreds more visible in the background. + - + href: stalactite/primary/three.png + title: A 5x5 chunk area of the ceiling cut away, with the stalactites still intact. +--- + +This is an example of spawning large stalactites made of mossy cobblestone. diff --git a/_world_examples/feature-types/stalagmite/stalagmite.md b/_world_examples/feature-types/stalagmite/stalagmite.md new file mode 100644 index 000000000..7235ea152 --- /dev/null +++ b/_world_examples/feature-types/stalagmite/stalagmite.md @@ -0,0 +1,23 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/stalagmite/ + code: + embed: https://gist.github.com/sustained/56a68d50ade2cb207597bd7df28ecf46.js + download: https://gist.github.com/sustained/56a68d50ade2cb207597bd7df28ecf46/archive/b7158797acd407d5e8caeb82d007bb4649a7e107.zip +type: feature +group: stalagmite +title: "Stagmite: Large Mossy Cobblestone Stalagmites" +primary: true +images: + - + href: stalagmite/primary/one.png + title: A close shot of a single mossy cobblestone stalagmite. + - + href: stalagmite/primary/two.png + title: Stalagmites made of mossy cobblestone as far as the eye can see. + - + href: stalagmite/primary/three.png + title: A cluster of mossy cobblestone stalagmites as viewed from above. +--- + +This is an example of spawning large stalagmites made of mossy cobblestone. diff --git a/_world_examples/feature-types/structure/structure.md b/_world_examples/feature-types/structure/structure.md new file mode 100644 index 000000000..ebfec71a3 --- /dev/null +++ b/_world_examples/feature-types/structure/structure.md @@ -0,0 +1,27 @@ +--- +link: + docs: /docs/cofh-world/world-generator-configuration/feature-types/structure/ + code: + embed: https://gist.github.com/sustained/950d9b48e3621e284668f362529e2a74.js + download: https://gist.github.com/sustained/950d9b48e3621e284668f362529e2a74/archive/4c39c60e0d125224d2b3b99dee5b9ce8a75adc31.zip +type: feature +group: structure +title: "Structure: Spawning 9x9 Buildings" +primary: true +images: + - + href: structure/primary/one.png + title: A close view of the structure from a 45 degree angle. + - + href: structure/primary/two.png + title: How the structure looks from the inside. + - + href: structure/primary/three.png + title: The structure as seen from far above. +--- + +This is an example of spawning structures. + +Do note that you'll need the example structure NBT file, or to create your own using structure blocks and to call it `example_structure.nbt` (see `structure` in the JSON). + +{% include notice.html notice="The NBT file will need to be placed in the same directory as the JSON file." %} diff --git a/assets/css/cofh.css b/assets/css/cofh.css index c1fc2b577..223c5d3b1 100644 --- a/assets/css/cofh.css +++ b/assets/css/cofh.css @@ -307,3 +307,11 @@ a.cofh-navbox-link:hover > span { .cofh-page-image { height: 128px; } + +.cofh-no-js .cofh-js-required { + display: none; +} + +#cofh-docs-content a.uk-button { + color: white !important; +} diff --git a/assets/css/highlight/vs.css b/assets/css/highlight/vs.css new file mode 100644 index 000000000..af4b2a094 --- /dev/null +++ b/assets/css/highlight/vs.css @@ -0,0 +1,38 @@ +.highlight .hll { background-color: #ffffcc } +.highlight { background: #ffffff; } +.highlight .c { color: #008000 } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #0000ff } /* Keyword */ +.highlight .ch { color: #008000 } /* Comment.Hashbang */ +.highlight .cm { color: #008000 } /* Comment.Multiline */ +.highlight .cp { color: #0000ff } /* Comment.Preproc */ +.highlight .cpf { color: #008000 } /* Comment.PreprocFile */ +.highlight .c1 { color: #008000 } /* Comment.Single */ +.highlight .cs { color: #008000 } /* Comment.Special */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gh { font-weight: bold } /* Generic.Heading */ +.highlight .gp { font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { font-weight: bold } /* Generic.Subheading */ +.highlight .kc { color: #0000ff } /* Keyword.Constant */ +.highlight .kd { color: #0000ff } /* Keyword.Declaration */ +.highlight .kn { color: #0000ff } /* Keyword.Namespace */ +.highlight .kp { color: #0000ff } /* Keyword.Pseudo */ +.highlight .kr { color: #0000ff } /* Keyword.Reserved */ +.highlight .kt { color: #2b91af } /* Keyword.Type */ +.highlight .s { color: #a31515 } /* Literal.String */ +.highlight .nc { color: #2b91af } /* Name.Class */ +.highlight .ow { color: #0000ff } /* Operator.Word */ +.highlight .sa { color: #a31515 } /* Literal.String.Affix */ +.highlight .sb { color: #a31515 } /* Literal.String.Backtick */ +.highlight .sc { color: #a31515 } /* Literal.String.Char */ +.highlight .dl { color: #a31515 } /* Literal.String.Delimiter */ +.highlight .sd { color: #a31515 } /* Literal.String.Doc */ +.highlight .s2 { color: #a31515 } /* Literal.String.Double */ +.highlight .se { color: #a31515 } /* Literal.String.Escape */ +.highlight .sh { color: #a31515 } /* Literal.String.Heredoc */ +.highlight .si { color: #a31515 } /* Literal.String.Interpol */ +.highlight .sx { color: #a31515 } /* Literal.String.Other */ +.highlight .sr { color: #a31515 } /* Literal.String.Regex */ +.highlight .s1 { color: #a31515 } /* Literal.String.Single */ +.highlight .ss { color: #a31515 } /* Literal.String.Symbol */ \ No newline at end of file diff --git a/assets/css/uikit/components/.unused/slidenav.min.css b/assets/css/uikit/components/slidenav.min.css similarity index 100% rename from assets/css/uikit/components/.unused/slidenav.min.css rename to assets/css/uikit/components/slidenav.min.css diff --git a/assets/css/uikit/components/.unused/slider.min.css b/assets/css/uikit/components/slider.min.css similarity index 100% rename from assets/css/uikit/components/.unused/slider.min.css rename to assets/css/uikit/components/slider.min.css diff --git a/assets/images/examples/boulder/primary/one.png b/assets/images/examples/boulder/primary/one.png new file mode 100644 index 000000000..80413403e Binary files /dev/null and b/assets/images/examples/boulder/primary/one.png differ diff --git a/assets/images/examples/boulder/primary/three.png b/assets/images/examples/boulder/primary/three.png new file mode 100644 index 000000000..96f87a3df Binary files /dev/null and b/assets/images/examples/boulder/primary/three.png differ diff --git a/assets/images/examples/boulder/primary/two.png b/assets/images/examples/boulder/primary/two.png new file mode 100644 index 000000000..c0bc4529c Binary files /dev/null and b/assets/images/examples/boulder/primary/two.png differ diff --git a/assets/images/examples/cluster/primary/one.png b/assets/images/examples/cluster/primary/one.png new file mode 100644 index 000000000..4b3fe31c0 Binary files /dev/null and b/assets/images/examples/cluster/primary/one.png differ diff --git a/assets/images/examples/cluster/primary/three.png b/assets/images/examples/cluster/primary/three.png new file mode 100644 index 000000000..8f2b87aa2 Binary files /dev/null and b/assets/images/examples/cluster/primary/three.png differ diff --git a/assets/images/examples/cluster/primary/two.png b/assets/images/examples/cluster/primary/two.png new file mode 100644 index 000000000..3c3fbfa3d Binary files /dev/null and b/assets/images/examples/cluster/primary/two.png differ diff --git a/assets/images/examples/consecutive/primary/one.png b/assets/images/examples/consecutive/primary/one.png new file mode 100644 index 000000000..2341d6f5c Binary files /dev/null and b/assets/images/examples/consecutive/primary/one.png differ diff --git a/assets/images/examples/consecutive/primary/three.png b/assets/images/examples/consecutive/primary/three.png new file mode 100644 index 000000000..624c7c594 Binary files /dev/null and b/assets/images/examples/consecutive/primary/three.png differ diff --git a/assets/images/examples/consecutive/primary/two.png b/assets/images/examples/consecutive/primary/two.png new file mode 100644 index 000000000..5260a8aca Binary files /dev/null and b/assets/images/examples/consecutive/primary/two.png differ diff --git a/assets/images/examples/decoration/primary/one.png b/assets/images/examples/decoration/primary/one.png new file mode 100644 index 000000000..869ab92ea Binary files /dev/null and b/assets/images/examples/decoration/primary/one.png differ diff --git a/assets/images/examples/decoration/primary/three.png b/assets/images/examples/decoration/primary/three.png new file mode 100644 index 000000000..0e69cc8b2 Binary files /dev/null and b/assets/images/examples/decoration/primary/three.png differ diff --git a/assets/images/examples/decoration/primary/two.png b/assets/images/examples/decoration/primary/two.png new file mode 100644 index 000000000..264aaaa4d Binary files /dev/null and b/assets/images/examples/decoration/primary/two.png differ diff --git a/assets/images/examples/geode/primary/one.png b/assets/images/examples/geode/primary/one.png new file mode 100644 index 000000000..516e09649 Binary files /dev/null and b/assets/images/examples/geode/primary/one.png differ diff --git a/assets/images/examples/geode/primary/three.png b/assets/images/examples/geode/primary/three.png new file mode 100644 index 000000000..7494ed8d4 Binary files /dev/null and b/assets/images/examples/geode/primary/three.png differ diff --git a/assets/images/examples/geode/primary/two.png b/assets/images/examples/geode/primary/two.png new file mode 100644 index 000000000..53ec2c91b Binary files /dev/null and b/assets/images/examples/geode/primary/two.png differ diff --git a/assets/images/examples/lake/primary/one.png b/assets/images/examples/lake/primary/one.png new file mode 100644 index 000000000..4f633d927 Binary files /dev/null and b/assets/images/examples/lake/primary/one.png differ diff --git a/assets/images/examples/lake/primary/three.png b/assets/images/examples/lake/primary/three.png new file mode 100644 index 000000000..0c8522c9e Binary files /dev/null and b/assets/images/examples/lake/primary/three.png differ diff --git a/assets/images/examples/lake/primary/two.png b/assets/images/examples/lake/primary/two.png new file mode 100644 index 000000000..18aeec35a Binary files /dev/null and b/assets/images/examples/lake/primary/two.png differ diff --git a/assets/images/examples/large-vein/primary/five.png b/assets/images/examples/large-vein/primary/five.png new file mode 100644 index 000000000..a58fdbbec Binary files /dev/null and b/assets/images/examples/large-vein/primary/five.png differ diff --git a/assets/images/examples/large-vein/primary/four.png b/assets/images/examples/large-vein/primary/four.png new file mode 100644 index 000000000..61eeb701a Binary files /dev/null and b/assets/images/examples/large-vein/primary/four.png differ diff --git a/assets/images/examples/large-vein/primary/one.png b/assets/images/examples/large-vein/primary/one.png new file mode 100644 index 000000000..8167526ad Binary files /dev/null and b/assets/images/examples/large-vein/primary/one.png differ diff --git a/assets/images/examples/large-vein/primary/three.png b/assets/images/examples/large-vein/primary/three.png new file mode 100644 index 000000000..22ebdbd33 Binary files /dev/null and b/assets/images/examples/large-vein/primary/three.png differ diff --git a/assets/images/examples/large-vein/primary/two.png b/assets/images/examples/large-vein/primary/two.png new file mode 100644 index 000000000..764fe5ae7 Binary files /dev/null and b/assets/images/examples/large-vein/primary/two.png differ diff --git a/assets/images/examples/plate/primary/one.png b/assets/images/examples/plate/primary/one.png new file mode 100644 index 000000000..0d2ea02ad Binary files /dev/null and b/assets/images/examples/plate/primary/one.png differ diff --git a/assets/images/examples/plate/primary/three.png b/assets/images/examples/plate/primary/three.png new file mode 100644 index 000000000..8a92bd75a Binary files /dev/null and b/assets/images/examples/plate/primary/three.png differ diff --git a/assets/images/examples/plate/primary/two.png b/assets/images/examples/plate/primary/two.png new file mode 100644 index 000000000..9245ef300 Binary files /dev/null and b/assets/images/examples/plate/primary/two.png differ diff --git a/assets/images/examples/sequential/primary/one.png b/assets/images/examples/sequential/primary/one.png new file mode 100644 index 000000000..c3c0fc4c4 Binary files /dev/null and b/assets/images/examples/sequential/primary/one.png differ diff --git a/assets/images/examples/sequential/primary/three.png b/assets/images/examples/sequential/primary/three.png new file mode 100644 index 000000000..d4e6e1119 Binary files /dev/null and b/assets/images/examples/sequential/primary/three.png differ diff --git a/assets/images/examples/sequential/primary/two.png b/assets/images/examples/sequential/primary/two.png new file mode 100644 index 000000000..76e00cd15 Binary files /dev/null and b/assets/images/examples/sequential/primary/two.png differ diff --git a/assets/images/examples/small-tree/primary/one.png b/assets/images/examples/small-tree/primary/one.png new file mode 100644 index 000000000..3d9688b60 Binary files /dev/null and b/assets/images/examples/small-tree/primary/one.png differ diff --git a/assets/images/examples/small-tree/primary/three.png b/assets/images/examples/small-tree/primary/three.png new file mode 100644 index 000000000..5eed2c9af Binary files /dev/null and b/assets/images/examples/small-tree/primary/three.png differ diff --git a/assets/images/examples/small-tree/primary/two.png b/assets/images/examples/small-tree/primary/two.png new file mode 100644 index 000000000..6cde6cd4c Binary files /dev/null and b/assets/images/examples/small-tree/primary/two.png differ diff --git a/assets/images/examples/sparse-cluster/primary/one.png b/assets/images/examples/sparse-cluster/primary/one.png new file mode 100644 index 000000000..8630b0284 Binary files /dev/null and b/assets/images/examples/sparse-cluster/primary/one.png differ diff --git a/assets/images/examples/sparse-cluster/primary/three.png b/assets/images/examples/sparse-cluster/primary/three.png new file mode 100644 index 000000000..481177213 Binary files /dev/null and b/assets/images/examples/sparse-cluster/primary/three.png differ diff --git a/assets/images/examples/sparse-cluster/primary/two.png b/assets/images/examples/sparse-cluster/primary/two.png new file mode 100644 index 000000000..f80f9da12 Binary files /dev/null and b/assets/images/examples/sparse-cluster/primary/two.png differ diff --git a/assets/images/examples/spike/primary/one.png b/assets/images/examples/spike/primary/one.png new file mode 100644 index 000000000..0ed4ecaca Binary files /dev/null and b/assets/images/examples/spike/primary/one.png differ diff --git a/assets/images/examples/spike/primary/three.png b/assets/images/examples/spike/primary/three.png new file mode 100644 index 000000000..dcbfb9be8 Binary files /dev/null and b/assets/images/examples/spike/primary/three.png differ diff --git a/assets/images/examples/spike/primary/two.png b/assets/images/examples/spike/primary/two.png new file mode 100644 index 000000000..7ccdbfa87 Binary files /dev/null and b/assets/images/examples/spike/primary/two.png differ diff --git a/assets/images/examples/spout/primary/one.png b/assets/images/examples/spout/primary/one.png new file mode 100644 index 000000000..a7464843e Binary files /dev/null and b/assets/images/examples/spout/primary/one.png differ diff --git a/assets/images/examples/spout/primary/three.png b/assets/images/examples/spout/primary/three.png new file mode 100644 index 000000000..12fb62737 Binary files /dev/null and b/assets/images/examples/spout/primary/three.png differ diff --git a/assets/images/examples/spout/primary/two.png b/assets/images/examples/spout/primary/two.png new file mode 100644 index 000000000..f32e177d1 Binary files /dev/null and b/assets/images/examples/spout/primary/two.png differ diff --git a/assets/images/examples/spout/sinkholes/one.png b/assets/images/examples/spout/sinkholes/one.png new file mode 100644 index 000000000..b5a1ac577 Binary files /dev/null and b/assets/images/examples/spout/sinkholes/one.png differ diff --git a/assets/images/examples/spout/sinkholes/three.png b/assets/images/examples/spout/sinkholes/three.png new file mode 100644 index 000000000..0e1321c46 Binary files /dev/null and b/assets/images/examples/spout/sinkholes/three.png differ diff --git a/assets/images/examples/spout/sinkholes/two.png b/assets/images/examples/spout/sinkholes/two.png new file mode 100644 index 000000000..a1042bb90 Binary files /dev/null and b/assets/images/examples/spout/sinkholes/two.png differ diff --git a/assets/images/examples/stalactite/primary/one.png b/assets/images/examples/stalactite/primary/one.png new file mode 100644 index 000000000..849e13019 Binary files /dev/null and b/assets/images/examples/stalactite/primary/one.png differ diff --git a/assets/images/examples/stalactite/primary/three.png b/assets/images/examples/stalactite/primary/three.png new file mode 100644 index 000000000..4ad7416d4 Binary files /dev/null and b/assets/images/examples/stalactite/primary/three.png differ diff --git a/assets/images/examples/stalactite/primary/two.png b/assets/images/examples/stalactite/primary/two.png new file mode 100644 index 000000000..429646375 Binary files /dev/null and b/assets/images/examples/stalactite/primary/two.png differ diff --git a/assets/images/examples/stalagmite/primary/one.png b/assets/images/examples/stalagmite/primary/one.png new file mode 100644 index 000000000..b8229a0fb Binary files /dev/null and b/assets/images/examples/stalagmite/primary/one.png differ diff --git a/assets/images/examples/stalagmite/primary/three.png b/assets/images/examples/stalagmite/primary/three.png new file mode 100644 index 000000000..f4dca80a1 Binary files /dev/null and b/assets/images/examples/stalagmite/primary/three.png differ diff --git a/assets/images/examples/stalagmite/primary/two.png b/assets/images/examples/stalagmite/primary/two.png new file mode 100644 index 000000000..34ab303ee Binary files /dev/null and b/assets/images/examples/stalagmite/primary/two.png differ diff --git a/assets/images/examples/structure/primary/one.png b/assets/images/examples/structure/primary/one.png new file mode 100644 index 000000000..1bf87d043 Binary files /dev/null and b/assets/images/examples/structure/primary/one.png differ diff --git a/assets/images/examples/structure/primary/three.png b/assets/images/examples/structure/primary/three.png new file mode 100644 index 000000000..aaa6829f6 Binary files /dev/null and b/assets/images/examples/structure/primary/three.png differ diff --git a/assets/images/examples/structure/primary/two.png b/assets/images/examples/structure/primary/two.png new file mode 100644 index 000000000..0184a2e35 Binary files /dev/null and b/assets/images/examples/structure/primary/two.png differ diff --git a/assets/js/cofh.js b/assets/js/cofh.js index 8af61e18d..2e3e198e8 100644 --- a/assets/js/cofh.js +++ b/assets/js/cofh.js @@ -22,6 +22,8 @@ $(window).on('hashchange load', function() { }); $(function() { + $("body").removeClass("cofh-no-js"); + var $banner = $('.cofh-banner'); if ($banner.length > 0) { var bannerImage = '/assets/images/banners/banner' + Math.floor(Math.random() * 7 + 1) + '.jpg'; diff --git a/assets/js/uikit/components/.unused/lightbox.min.js b/assets/js/uikit/components/lightbox.min.js similarity index 100% rename from assets/js/uikit/components/.unused/lightbox.min.js rename to assets/js/uikit/components/lightbox.min.js diff --git a/assets/js/uikit/components/.unused/slider.min.js b/assets/js/uikit/components/slider.min.js similarity index 100% rename from assets/js/uikit/components/.unused/slider.min.js rename to assets/js/uikit/components/slider.min.js diff --git a/assets/other/example_structure.nbt b/assets/other/example_structure.nbt new file mode 100644 index 000000000..be48e882a Binary files /dev/null and b/assets/other/example_structure.nbt differ diff --git a/docs/cofh-world/examples/index.md b/docs/cofh-world/examples/index.md new file mode 100644 index 000000000..0f56c21d2 --- /dev/null +++ b/docs/cofh-world/examples/index.md @@ -0,0 +1,38 @@ +--- +title: Examples (CoFH World) +nav: cofh-world +--- + +{% include notice.html notice="This page is a work-in-progress. Hard hats are recommended." %} + +Here you will find one simple example for each [feature type](world-generator-configuration/feature-types/), [distribution type](world-generator-configuration/distribution-types/) and common format. + +Every example includes: + +- a brief description +- a link to the documentation +- a link to an example JSON file +- a gallery of images + +The actual feature/distribution type and common format pages themselves, however, include many many more examples; this page is intended only to provide you with an overview. + + +## Feature Type Examples + +{% include examples.html type="feature" primary=true showDocs=true %} + +-------- + +## Distribution Type Examples + +{% include examples.html type="distribution" primary=true showDocs=true %} + +-------- + +## Common Format Examples + +{% include examples.html type="common-format" primary=true showDocs=true %} + +## Contributing Examples + +If you feel that you have examples of generation which aren't covered by this guide which you'd like to contribute then please [open an issue](#). diff --git a/docs/cofh-world/index.md b/docs/cofh-world/index.md index 5332e44dc..d1a529572 100644 --- a/docs/cofh-world/index.md +++ b/docs/cofh-world/index.md @@ -13,6 +13,10 @@ to define new types of features to generate in worlds. [Thermal Foundation](/docs/thermal-foundation/) uses this mod for its world generation by default. +The NEW [Examples](/docs/cofh-world/examples/) page provides +a great high-level overview of the mod and its capabilities, otherwise for a much more in-depth +explanation check out the [Files](/docs/cofh-world/world-generator-configuration/files/) and [Feature Format](/docs/cofh-world/world-generator-configuration/feature-format/) sections. +
Download diff --git a/docs/cofh-world/world-generator-configuration/common-formats/block-id/index.md b/docs/cofh-world/world-generator-configuration/common-formats/block-id/index.md index 663434e8f..ba5f90a54 100644 --- a/docs/cofh-world/world-generator-configuration/common-formats/block-id/index.md +++ b/docs/cofh-world/world-generator-configuration/common-formats/block-id/index.md @@ -89,4 +89,5 @@ the `name` value. Examples -------- -Coming soon... +{% include examples.html group="block-id" primary=true %} +{% include examples.html group="block-id" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/common-formats/number-provider/index.md b/docs/cofh-world/world-generator-configuration/common-formats/number-provider/index.md index df617d3dd..3d152f688 100644 --- a/docs/cofh-world/world-generator-configuration/common-formats/number-provider/index.md +++ b/docs/cofh-world/world-generator-configuration/common-formats/number-provider/index.md @@ -322,4 +322,5 @@ object with the following values. Examples -------- -Coming soon... +{% include examples.html group="number-provider" primary=true %} +{% include examples.html group="number-provider" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/common-formats/weighted-string/index.md b/docs/cofh-world/world-generator-configuration/common-formats/weighted-string/index.md index 29032e7ed..6fa48d3ab 100644 --- a/docs/cofh-world/world-generator-configuration/common-formats/weighted-string/index.md +++ b/docs/cofh-world/world-generator-configuration/common-formats/weighted-string/index.md @@ -54,4 +54,5 @@ string is given the default weight. Examples -------- -Coming soon... +{% include examples.html group="weighted-string" primary=true %} +{% include examples.html group="weighted-string" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/cave/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/cave/index.md index 960c881eb..c23132c50 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/cave/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/cave/index.md @@ -69,4 +69,5 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="cave" primary=true %} +{% include examples.html group="cave" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/custom/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/custom/index.md index 7b225ac05..0425a7856 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/custom/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/custom/index.md @@ -78,4 +78,5 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="custom" primary=true %} +{% include examples.html group="custom" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/fractal/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/fractal/index.md index 2b30c4dc4..d3e7b7279 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/fractal/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/fractal/index.md @@ -111,4 +111,5 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="fractal" primary=true %} +{% include examples.html group="fractal" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/gaussian/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/gaussian/index.md index 97325072d..cff86ec55 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/gaussian/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/gaussian/index.md @@ -84,4 +84,5 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="gaussian" primary=true %} +{% include examples.html group="gaussian" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/sequential/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/sequential/index.md index ec1920b1d..fbf4f3a06 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/sequential/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/sequential/index.md @@ -50,4 +50,5 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="sequential" primary=true %} +{% include examples.html group="sequential" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/surface/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/surface/index.md index d53677cb6..ea0967b99 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/surface/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/surface/index.md @@ -88,4 +88,5 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="surface" primary=true %} +{% include examples.html group="surface" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/underfluid/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/underfluid/index.md index e38b5e25d..b0346d1f3 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/underfluid/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/underfluid/index.md @@ -80,4 +80,5 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="underfluid" primary=true %} +{% include examples.html group="underfluid" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/underwater/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/underwater/index.md index ec72be40b..56b262857 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/underwater/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/underwater/index.md @@ -71,4 +71,5 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="underwater" primary=true %} +{% include examples.html group="underwater" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/distribution-types/uniform/index.md b/docs/cofh-world/world-generator-configuration/distribution-types/uniform/index.md index 8c6b31836..0e35572ed 100644 --- a/docs/cofh-world/world-generator-configuration/distribution-types/uniform/index.md +++ b/docs/cofh-world/world-generator-configuration/distribution-types/uniform/index.md @@ -67,4 +67,6 @@ entry](/docs/cofh-world/world-generator-configuration/feature-format/#features). Examples -------- -Coming soon... +{% include examples.html group="uniform" primary=true %} +{% include examples.html group="uniform" primary=false %} + diff --git a/docs/cofh-world/world-generator-configuration/feature-types/boulder/index.md b/docs/cofh-world/world-generator-configuration/feature-types/boulder/index.md index 17c2b3673..8d5d906b2 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/boulder/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/boulder/index.md @@ -124,4 +124,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="boulder" primary=true %} +{% include examples.html group="boulder" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/cluster/index.md b/docs/cofh-world/world-generator-configuration/feature-types/cluster/index.md index 73a8d2630..f93dbf1aa 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/cluster/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/cluster/index.md @@ -59,4 +59,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="cluster" primary=true %} +{% include examples.html group="cluster" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/consecutive/index.md b/docs/cofh-world/world-generator-configuration/feature-types/consecutive/index.md index 928aa490d..c8cc00208 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/consecutive/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/consecutive/index.md @@ -54,4 +54,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="consecutive" primary=true %} +{% include examples.html group="consecutive" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/decoration/index.md b/docs/cofh-world/world-generator-configuration/feature-types/decoration/index.md index 4626c6797..f9db4f76b 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/decoration/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/decoration/index.md @@ -138,4 +138,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="decoration" primary=true %} +{% include examples.html group="decoration" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/geode/index.md b/docs/cofh-world/world-generator-configuration/feature-types/geode/index.md index bfe7a792c..721f913fa 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/geode/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/geode/index.md @@ -86,4 +86,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="geode" primary=true %} +{% include examples.html group="geode" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/lake/index.md b/docs/cofh-world/world-generator-configuration/feature-types/lake/index.md index 33012444e..5922f3045 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/lake/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/lake/index.md @@ -112,4 +112,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="lake" primary=true %} +{% include examples.html group="lake" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/large-vein/index.md b/docs/cofh-world/world-generator-configuration/feature-types/large-vein/index.md index 766cc94f2..29775723e 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/large-vein/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/large-vein/index.md @@ -93,4 +93,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="large-vein" primary=true %} +{% include examples.html group="large-vein" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/plate/index.md b/docs/cofh-world/world-generator-configuration/feature-types/plate/index.md index bdc6b92c4..c88e49f12 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/plate/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/plate/index.md @@ -92,4 +92,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="plate" primary=true %} +{% include examples.html group="plate" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/sequential/index.md b/docs/cofh-world/world-generator-configuration/feature-types/sequential/index.md index 48110368f..a77fd9c2d 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/sequential/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/sequential/index.md @@ -52,4 +52,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="sequential" primary=true %} +{% include examples.html group="sequential" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/small-tree/index.md b/docs/cofh-world/world-generator-configuration/feature-types/small-tree/index.md index 6582b1bfd..65f776e3e 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/small-tree/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/small-tree/index.md @@ -122,4 +122,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="small-tree" primary=true %} +{% include examples.html group="small-tree" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/sparse-cluster/index.md b/docs/cofh-world/world-generator-configuration/feature-types/sparse-cluster/index.md index e528d1028..a3457f1eb 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/sparse-cluster/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/sparse-cluster/index.md @@ -63,4 +63,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="sparse-cluster" primary=true %} +{% include examples.html group="sparse-cluster" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/spike/index.md b/docs/cofh-world/world-generator-configuration/feature-types/spike/index.md index 4abf5dd27..6d3a9cc8c 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/spike/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/spike/index.md @@ -133,4 +133,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="spike" primary=true %} +{% include examples.html group="spike" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/spout/index.md b/docs/cofh-world/world-generator-configuration/feature-types/spout/index.md index ca291a8c0..4cf8c9486 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/spout/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/spout/index.md @@ -83,4 +83,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="spout" primary=true %} +{% include examples.html group="spout" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/stalactite/index.md b/docs/cofh-world/world-generator-configuration/feature-types/stalactite/index.md index 1cd93fa05..ec16f7878 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/stalactite/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/stalactite/index.md @@ -142,4 +142,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="stalactite" primary=true %} +{% include examples.html group="stalactite" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/stalagmite/index.md b/docs/cofh-world/world-generator-configuration/feature-types/stalagmite/index.md index 0f6572a13..52162d6c0 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/stalagmite/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/stalagmite/index.md @@ -144,4 +144,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="stalagmite" primary=true %} +{% include examples.html group="stalagmite" primary=false %} diff --git a/docs/cofh-world/world-generator-configuration/feature-types/structure/index.md b/docs/cofh-world/world-generator-configuration/feature-types/structure/index.md index c8f42dd66..a53c72054 100644 --- a/docs/cofh-world/world-generator-configuration/feature-types/structure/index.md +++ b/docs/cofh-world/world-generator-configuration/feature-types/structure/index.md @@ -117,4 +117,5 @@ configuration](/docs/cofh-world/world-generator-configuration/feature-format/#fe Examples -------- -Coming soon... +{% include examples.html group="structure" primary=true %} +{% include examples.html group="structure" primary=false %}