Skip to content

Commit

Permalink
docs: refined sites docs
Browse files Browse the repository at this point in the history
  • Loading branch information
raoulvdberge committed Dec 25, 2023
1 parent fd27fe7 commit e6b309b
Show file tree
Hide file tree
Showing 10 changed files with 259 additions and 0 deletions.
Binary file added docs/assets/pump.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/recipe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/scanning-mc110-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/scanning-mc110-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/scanning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/nav.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[
{
"ref": "index.adoc"
},
{
"ref": "pump-110.adoc",
"title": "Pump (Minecraft 1.10.2)"
},
{
"title": "What's new",
"ref": "whats-new.adoc",
"icon": "bi-lightbulb-fill"
}
]
56 changes: 56 additions & 0 deletions docs/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
= Pump
:icon: pump.png

The {doctitle} is the only block that is added by Ranged Pumps.
It pumps liquids in a range.

image::../assets/recipe.png[The crafting recipe of the pump]

== Placement

Place the {doctitle} down, and it'll only work *without* a redstone signal.

== Redstone signal

If you give the {doctitle} a redstone signal, it will stop working until you disable the redstone signal.

== Energy requirements

By default, the {doctitle} requires Forge Energy, but can be configured to not use energy in the config.

== Internal tank

The size of the internal tank of the {doctitle} is 32 buckets (by default).
You can increase or decrease this in the config.

The {doctitle} will stop running if the internal tank is full.

== Status updates

Right-click on the {doctitle} to know what it is doing and to know if it is running.

== Scanning and range

image::../assets/scanning.png[Diagram describing the scanning direction and order]

It'll start pumping liquids in rectangular spiral shape 1 block under the {doctitle.

The default range is 64 blocks.
That'll mean it scan 64 blocks in any direction, nearest-first.

On a vertical (Y) level, it will scan liquids from the {doctitle} to bedrock.

== Liquids to stone

The {doctitle} will also replace any liquids to stone by default.
This can be turned off in the config.

== Auto-pushing liquids

The {doctitle} will auto-push liquids to neighboring tanks.
You can also get the liquids out with pipes.

== Chunkloading

The mod doesn't chunkload the {doctitle} automatically.
You'll need another mod to get this behavior.
61 changes: 61 additions & 0 deletions docs/pages/pump-110.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
= Pump
:icon: pump.png

[.alert.alert-warning]
****
This documentation page refers to the **Minecraft 1.10.2** version of Ranged Pumps.
Consult the xref:index.adoc[latest version of the documentation].
****

The {doctitle} is the only block that is added by Ranged Pumps.
It pumps liquids in a range.

image::../assets/recipe.png[The crafting recipe of the pump]

== Placement

Place the {doctitle} down, apply a redstone signal, and it'll work.

== Energy requirements

By default, the {doctitle} requires no energy, but the {doctitle} can be configured to use RF energy in the config.

== Internal tank

The size of the internal tank of the {doctitle} is by default 32 buckets, you can increase or decrease this in the config.

The {doctitle} will stop running if the internal tank is full.

== Status updates

Right-click on the {doctitle} to know what it is doing and if it is running.

== Scanning and range

It'll pump liquids in a rectangular area 1 block under the {doctitle}, the size of this rectangular area can be specified in the config.

The default range specified in the config is 128 blocks.
That means it will search 64 blocks in any direction of the {doctitle}.

image::../assets/scanning-mc110-1.png[Diagram showing the scanning range of the pump]

This is how it will scan for liquids (from the top left to the bottom right):

image::../assets/scanning-mc110-2.png[Diagram showing the scanning order of the pump]

== Liquids to stone

The {doctitle} will also replace any liquids to stone by default.
This can be turned off in the config.

== Auto-pushing liquids

The {doctitle} doesn't auto-push liquids.
You have to suck them out manually with an external mod that can do that, for example pipes.

Make sure you're not disabling the pipe with the redstone signal that you're providing to the pump!

== Chunkloading

The mod doesn't chunkload the {doctitle} automatically.
You'll need another mod to get this behavior.
1 change: 1 addition & 0 deletions docs/pages/whats-new.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
= What's new
127 changes: 127 additions & 0 deletions docs/pages/whats-new.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<!DOCTYPE html>
<html layout:decorate="~{layout.html}">
<head>
<title th:utext="${title}"></title>
</head>
<body>
<div layout:fragment="content">
<div th:if="${currentRelease != null}" class="card">
<div class="card-body">
<h2 class="card-title">
In version <span th:text="${currentRelease.release.getName()}" th:remove="tag"></span>

<span class="badge bg-primary" th:if="${currentRelease.release.type.name() == 'BETA'}">Beta</span>
<span class="badge bg-warning text-dark"
th:if="${currentRelease.release.type.name() == 'ALPHA'}">Alpha</span>
</h2>

<div class="text-muted d-flex gap-3 mb-2">
<span>
<i class="bi bi-calendar"></i>
<span
th:text="${#dates.format(currentRelease.release.createdAt, 'dd-MM-yyyy HH:mm')}"
th:remove="tag"></span>
</span>
<span>
<i class="bi bi-download"></i>
<span th:remove="tag"
th:text="${currentRelease.release.stats.totalDownloads}"></span>
</span>
</div>

<div th:utext="${currentRelease.changelogHtml}"></div>

<a th:href="${currentRelease.curseforgeUrl}" th:if="${currentRelease.curseforgeUrl != null}"
class="btn btn-primary">
<svg class="distribution-platform-logo" xmlns="http://www.w3.org/2000/svg"
viewBox="-2017 853 43 23">
<path d="M-2005.7,853l0.7,3c-3.5,0-12,0-12,0s0.2,0.9,0.3,1c0.3,0.5,0.6,1.1,1,1.5c1.9,2.2,5.2,3.1,7.9,3.6 c1.9,0.4,3.8,0.5,5.7,0.6l2.2,5.9h1.2l0.7,1.9h-1l-1.7,5.5h16.7l-1.7-5.5h-1l0.7-1.9h1.2c0,0,1-6.1,4.1-8.9c3-2.8,6.7-3.2,6.7-3.2 V853H-2005.7z M-1988.9,868.1c-0.8,0.5-1.7,0.5-2.3,0.9c-0.4,0.2-0.6,0.8-0.6,0.8c-0.4-0.9-0.9-1.2-1.5-1.4 c-0.6-0.2-1.7-0.1-3.2-1.4c-1-0.9-1.1-2.1-1-2.7v-0.1c0-0.1,0-0.1,0-0.2s0-0.2,0.1-0.3l0,0l0,0c0.2-0.6,0.7-1.2,1.7-1.6 c0,0-0.7,1,0,2c0.4,0.6,1.2,0.9,1.9,0.5c0.3-0.2,0.5-0.6,0.6-0.9c0.2-0.7,0.2-1.4-0.4-1.9c-0.9-0.8-1.1-1.9-0.5-2.6 c0,0,0.2,0.9,1.1,0.8c0.6,0,0.6-0.2,0.4-0.4c-0.1-0.3-1.4-2.2,0.5-3.6c0,0,1.2-0.8,2.6-0.7c-0.8,0.1-1.7,0.6-2,1.4c0,0,0,0,0,0.1 c-0.3,0.8-0.1,1.7,0.5,2.5c0.4,0.6,0.9,1.1,1.1,1.9c-0.3-0.1-0.5,0-0.7,0.2c-0.2,0.2-0.3,0.6-0.2,0.9c0.1,0.2,0.3,0.4,0.5,0.4 c0.1,0,0.1,0,0.2,0h0.1c0.3-0.1,0.5-0.5,0.4-0.8c0.2,0.2,0.3,0.7,0.2,1c0,0.3-0.2,0.6-0.3,0.8c-0.1,0.2-0.3,0.4-0.4,0.6 s-0.2,0.4-0.2,0.6c0,0.2,0,0.5,0.1,0.7c0.4,0.6,1.2,0,1.4-0.5c0.3-0.6,0.2-1.3-0.2-1.9c0,0,0.7,0.4,1.2,1.8 C-1987.4,866.2-1988.1,867.6-1988.9,868.1z"></path>
</svg>
Download on CurseForge
</a>
<a th:href="${currentRelease.modrinthUrl}" th:if="${currentRelease.modrinthUrl != null}"
class="btn btn-primary">
<svg class="distribution-platform-logo" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 514">
<path fill-rule="evenodd" clip-rule="evenodd"
d="M503.16 323.56C514.55 281.47 515.32 235.91 503.2 190.76C466.57 54.2299 326.04 -26.8001 189.33 9.77991C83.8101 38.0199 11.3899 128.07 0.689941 230.47H43.99C54.29 147.33 113.74 74.7298 199.75 51.7098C306.05 23.2598 415.13 80.6699 453.17 181.38L411.03 192.65C391.64 145.8 352.57 111.45 306.3 96.8198L298.56 140.66C335.09 154.13 364.72 184.5 375.56 224.91C391.36 283.8 361.94 344.14 308.56 369.17L320.09 412.16C390.25 383.21 432.4 310.3 422.43 235.14L464.41 223.91C468.91 252.62 467.35 281.16 460.55 308.07L503.16 323.56Z"/>
<path d="M321.99 504.22C185.27 540.8 44.7501 459.77 8.11011 323.24C3.84011 307.31 1.17 291.33 0 275.46H43.27C44.36 287.37 46.4699 299.35 49.6799 311.29C53.0399 323.8 57.45 335.75 62.79 347.07L101.38 323.92C98.1299 316.42 95.39 308.6 93.21 300.47C69.17 210.87 122.41 118.77 212.13 94.7601C229.13 90.2101 246.23 88.4401 262.93 89.1501L255.19 133C244.73 133.05 234.11 134.42 223.53 137.25C157.31 154.98 118.01 222.95 135.75 289.09C136.85 293.16 138.13 297.13 139.59 300.99L188.94 271.38L174.07 231.95L220.67 184.08L279.57 171.39L296.62 192.38L269.47 219.88L245.79 227.33L228.87 244.72L237.16 267.79C237.16 267.79 253.95 285.63 253.98 285.64L277.7 279.33L294.58 260.79L331.44 249.12L342.42 273.82L304.39 320.45L240.66 340.63L212.08 308.81L162.26 338.7C187.8 367.78 226.2 383.93 266.01 380.56L277.54 423.55C218.13 431.41 160.1 406.82 124.05 361.64L85.6399 384.68C136.25 451.17 223.84 484.11 309.61 461.16C371.35 444.64 419.4 402.56 445.42 349.38L488.06 364.88C457.17 431.16 398.22 483.82 321.99 504.22Z"/>
</svg>
Download on Modrinth
</a>
<a th:href="${currentRelease.githubUrl}" th:if="${currentRelease.githubUrl != null}"
class="btn btn-primary">
<i class="bi bi-github"></i>
Download on GitHub
</a>
</div>
</div>

<h3 class="mt-2 mb-2">Other releases</h3>

<div class="accordion" id="other-releases">
<div class="accordion-item" th:each="otherRelease : ${otherReleases}">
<h2 class="accordion-header">
<button class="accordion-button d-flex gap-2"
type="button"
data-bs-toggle="collapse"
th:attr="data-bs-target='#collapse-' + ${otherRelease.slug}, aria-controls='collapse-' + ${otherRelease.slug}">
<span th:text="${otherRelease.release.name}"></span>
<span class="badge bg-primary" th:if="${otherRelease.release.type.name() == 'BETA'}">Beta</span>
<span class="badge bg-warning text-dark"
th:if="${otherRelease.release.type.name() == 'ALPHA'}">Alpha</span>
</button>
</h2>
<div th:id="'collapse-' + ${otherRelease.slug}"
class="accordion-collapse collapse"
data-bs-parent="#other-releases">
<div class="accordion-body">
<h2 class="card-title">
In version <span th:text="${otherRelease.release.getName()}" th:remove="tag"></span>
</h2>

<div class="text-muted d-flex gap-3 mb-2">
<span>
<i class="bi bi-calendar"></i>
<span
th:text="${#dates.format(otherRelease.release.createdAt, 'dd-MM-yyyy HH:mm')}"
th:remove="tag"></span>
</span>
<span>
<i class="bi bi-download"></i>
<span th:remove="tag"
th:text="${otherRelease.release.stats.totalDownloads}"></span>
</span>
</div>

<div th:utext="${otherRelease.changelogHtml}"></div>

<a th:href="${otherRelease.curseforgeUrl}" th:if="${otherRelease.curseforgeUrl != null}"
class="btn btn-primary">
<svg class="distribution-platform-logo" xmlns="http://www.w3.org/2000/svg"
viewBox="-2017 853 43 23">
<path d="M-2005.7,853l0.7,3c-3.5,0-12,0-12,0s0.2,0.9,0.3,1c0.3,0.5,0.6,1.1,1,1.5c1.9,2.2,5.2,3.1,7.9,3.6 c1.9,0.4,3.8,0.5,5.7,0.6l2.2,5.9h1.2l0.7,1.9h-1l-1.7,5.5h16.7l-1.7-5.5h-1l0.7-1.9h1.2c0,0,1-6.1,4.1-8.9c3-2.8,6.7-3.2,6.7-3.2 V853H-2005.7z M-1988.9,868.1c-0.8,0.5-1.7,0.5-2.3,0.9c-0.4,0.2-0.6,0.8-0.6,0.8c-0.4-0.9-0.9-1.2-1.5-1.4 c-0.6-0.2-1.7-0.1-3.2-1.4c-1-0.9-1.1-2.1-1-2.7v-0.1c0-0.1,0-0.1,0-0.2s0-0.2,0.1-0.3l0,0l0,0c0.2-0.6,0.7-1.2,1.7-1.6 c0,0-0.7,1,0,2c0.4,0.6,1.2,0.9,1.9,0.5c0.3-0.2,0.5-0.6,0.6-0.9c0.2-0.7,0.2-1.4-0.4-1.9c-0.9-0.8-1.1-1.9-0.5-2.6 c0,0,0.2,0.9,1.1,0.8c0.6,0,0.6-0.2,0.4-0.4c-0.1-0.3-1.4-2.2,0.5-3.6c0,0,1.2-0.8,2.6-0.7c-0.8,0.1-1.7,0.6-2,1.4c0,0,0,0,0,0.1 c-0.3,0.8-0.1,1.7,0.5,2.5c0.4,0.6,0.9,1.1,1.1,1.9c-0.3-0.1-0.5,0-0.7,0.2c-0.2,0.2-0.3,0.6-0.2,0.9c0.1,0.2,0.3,0.4,0.5,0.4 c0.1,0,0.1,0,0.2,0h0.1c0.3-0.1,0.5-0.5,0.4-0.8c0.2,0.2,0.3,0.7,0.2,1c0,0.3-0.2,0.6-0.3,0.8c-0.1,0.2-0.3,0.4-0.4,0.6 s-0.2,0.4-0.2,0.6c0,0.2,0,0.5,0.1,0.7c0.4,0.6,1.2,0,1.4-0.5c0.3-0.6,0.2-1.3-0.2-1.9c0,0,0.7,0.4,1.2,1.8 C-1987.4,866.2-1988.1,867.6-1988.9,868.1z"></path>
</svg>
Download on CurseForge
</a>
<a th:href="${otherRelease.modrinthUrl}" th:if="${otherRelease.modrinthUrl != null}"
class="btn btn-primary">
<svg class="distribution-platform-logo" xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 512 514">
<path fill-rule="evenodd" clip-rule="evenodd"
d="M503.16 323.56C514.55 281.47 515.32 235.91 503.2 190.76C466.57 54.2299 326.04 -26.8001 189.33 9.77991C83.8101 38.0199 11.3899 128.07 0.689941 230.47H43.99C54.29 147.33 113.74 74.7298 199.75 51.7098C306.05 23.2598 415.13 80.6699 453.17 181.38L411.03 192.65C391.64 145.8 352.57 111.45 306.3 96.8198L298.56 140.66C335.09 154.13 364.72 184.5 375.56 224.91C391.36 283.8 361.94 344.14 308.56 369.17L320.09 412.16C390.25 383.21 432.4 310.3 422.43 235.14L464.41 223.91C468.91 252.62 467.35 281.16 460.55 308.07L503.16 323.56Z"/>
<path d="M321.99 504.22C185.27 540.8 44.7501 459.77 8.11011 323.24C3.84011 307.31 1.17 291.33 0 275.46H43.27C44.36 287.37 46.4699 299.35 49.6799 311.29C53.0399 323.8 57.45 335.75 62.79 347.07L101.38 323.92C98.1299 316.42 95.39 308.6 93.21 300.47C69.17 210.87 122.41 118.77 212.13 94.7601C229.13 90.2101 246.23 88.4401 262.93 89.1501L255.19 133C244.73 133.05 234.11 134.42 223.53 137.25C157.31 154.98 118.01 222.95 135.75 289.09C136.85 293.16 138.13 297.13 139.59 300.99L188.94 271.38L174.07 231.95L220.67 184.08L279.57 171.39L296.62 192.38L269.47 219.88L245.79 227.33L228.87 244.72L237.16 267.79C237.16 267.79 253.95 285.63 253.98 285.64L277.7 279.33L294.58 260.79L331.44 249.12L342.42 273.82L304.39 320.45L240.66 340.63L212.08 308.81L162.26 338.7C187.8 367.78 226.2 383.93 266.01 380.56L277.54 423.55C218.13 431.41 160.1 406.82 124.05 361.64L85.6399 384.68C136.25 451.17 223.84 484.11 309.61 461.16C371.35 444.64 419.4 402.56 445.42 349.38L488.06 364.88C457.17 431.16 398.22 483.82 321.99 504.22Z"/>
</svg>
Download on Modrinth
</a>
<a th:href="${otherRelease.githubUrl}" th:if="${otherRelease.githubUrl != null}"
class="btn btn-primary">
<i class="bi bi-github"></i>
Download on GitHub
</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>

0 comments on commit e6b309b

Please sign in to comment.