Merge pull request #52 from refinedmods/release/1.2.0

Release v1.2.0

.github/CONTRIBUTING.md

@@ -88,7 +88,7 @@ Documentation must be kept up to date when adding or changing functionality.
 
 ### Javadoc
 
-Javadoc is available after every release on https://refinedmods.com/rangedpumps/.
+Javadoc is available after every release on https://refinedmods.com/javadoc/rangedpumps/.
 
 ### API annotations
 
@@ -196,7 +196,7 @@ The workflow takes care of the following:
 - Running a build.
 - Publishing on [GitHub packages](https://github.com/refinedmods/rangedpumps/packages) and
   CreeperHost Maven.
-- Publishing Javadoc on [GitHub pages](https://github.com/refinedmods/rangedpumps/tree/gh-pages).
+- Publishing Javadoc on [GitHub pages](https://github.com/refinedmods/javadoc).
 - Deploying on [GitHub releases](https://github.com/refinedmods/rangedpumps/releases).
 - Announcing the release on Discord and Twitter.
 - Creating a PR that merges `main` back into `develop` to get the changes to `CHANGELOG.md` and `build.gradle`

.github/workflows/build.yml

@@ -8,7 +8,7 @@ on:
     types: [ opened, synchronize, reopened ]
 jobs:
   build:
-    uses: refinedmods/refinedarchitect/.github/workflows/build.yml@v0.6.0
+    uses: refinedmods/refinedarchitect/.github/workflows/build.yml@v0.11.3
     with:
       mutation-testing: false
       sonarqube: false

.github/workflows/draft-release.yml

@@ -17,7 +17,7 @@ on:
         type: string
 jobs:
   draft:
-    uses: refinedmods/refinedarchitect/.github/workflows/draft-release.yml@v0.6.0
+    uses: refinedmods/refinedarchitect/.github/workflows/draft-release.yml@v0.11.3
     with:
       release-type: ${{ inputs.release-type }}
       version-number-override: ${{ inputs.version-number-override }}

.github/workflows/issue-for-unsupported-version.yml

@@ -4,4 +4,4 @@ on:
     types: [ labeled, unlabeled, reopened ]
 jobs:
   unsupported-labeler:
-    uses: refinedmods/refinedarchitect/.github/workflows/issue-for-unsupported-version.yml@v0.6.0
+    uses: refinedmods/refinedarchitect/.github/workflows/issue-for-unsupported-version.yml@v0.11.3

.github/workflows/publish-release.yml

@@ -7,7 +7,7 @@ on:
       - closed
 jobs:
   publish-release:
-    uses: refinedmods/refinedarchitect/.github/workflows/publish-release.yml@v0.6.0
+    uses: refinedmods/refinedarchitect/.github/workflows/publish-release.yml@v0.11.3
     secrets: inherit
     with:
       project-name: 'Ranged Pumps'

.github/workflows/resolved-issue-locking.yml

@@ -4,4 +4,4 @@ on:
     - cron: '0 0 * * *'
 jobs:
   lock:
-    uses: refinedmods/refinedarchitect/.github/workflows/resolved-issue-locking.yml@v0.6.0
+    uses: refinedmods/refinedarchitect/.github/workflows/resolved-issue-locking.yml@v0.11.3

.github/workflows/validate-branch-name.yml

@@ -2,4 +2,4 @@ name: Validate branch name
 on: [ pull_request ]
 jobs:
   validate-branch-name:
-    uses: refinedmods/refinedarchitect/.github/workflows/validate-branch-name.yml@v0.6.0
+    uses: refinedmods/refinedarchitect/.github/workflows/validate-branch-name.yml@v0.11.3

.github/workflows/validate-changelog.yml

@@ -4,4 +4,6 @@ on:
     types: [ opened, synchronize, reopened, ready_for_review, labeled, unlabeled ]
 jobs:
   validate-changelog:
-    uses: refinedmods/refinedarchitect/.github/workflows/[email protected]
+    uses: refinedmods/refinedarchitect/.github/workflows/[email protected]
+    with:
+      validation-level: 'warn'

.github/workflows/validate-commit-messages.yml

@@ -2,4 +2,4 @@ name: Validate commit messages
 on: [ pull_request ]
 jobs:
   validate-commit-messages:
-    uses: refinedmods/refinedarchitect/.github/workflows/validate-commit-messages.yml@v0.6.0
+    uses: refinedmods/refinedarchitect/.github/workflows/validate-commit-messages.yml@v0.11.3

.gitignore

@@ -7,7 +7,7 @@ eclipse/
 .nb-gradle-properties
 .project
 *.launch
-run/
+runs/
 *.iml
 *.ipr
 *.iws

CHANGELOG.md

@@ -7,6 +7,12 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [1.2.0] - 2024-01-29
+
+### Changed
+
+-   Ported to Minecraft 1.20.4.
+
 ## [1.1.0] - 2023-07-07
 
 ### Changed
@@ -65,7 +71,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 -   Port to Minecraft 1.16.
 
-## [0.7.1] - 2020-01-30
+## [0.11.3] - 2020-01-30
 
 ### Added
 
@@ -140,7 +146,9 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 -   Initial release for Minecraft 1.10.2.
 
-[Unreleased]: https://github.com/refinedmods/rangedpumps/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/refinedmods/rangedpumps/compare/v1.2.0...HEAD
+
+[1.2.0]: https://github.com/refinedmods/rangedpumps/compare/v1.1.0...v1.2.0
 
 [1.1.0]: https://github.com/refinedmods/rangedpumps/compare/v1.0.0...v1.1.0
 
@@ -156,9 +164,9 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 [0.8.1]: https://github.com/refinedmods/rangedpumps/compare/v0.8.0...v0.8.1
 
-[0.8.0]: https://github.com/refinedmods/rangedpumps/compare/v0.7.1...v0.8.0
+[0.8.0]: https://github.com/refinedmods/rangedpumps/compare/v0.11.3...v0.8.0
 
-[0.7.1]: https://github.com/refinedmods/rangedpumps/compare/v0.7.0...v0.7.1
+[0.11.3]: https://github.com/refinedmods/rangedpumps/compare/v0.7.0...v0.11.3
 
 [0.7.0]: https://github.com/refinedmods/rangedpumps/compare/v0.6.1...v0.7.0
 

LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright © 2016 - 2023 Refined Mods
+Copyright © 2016 - 2024 Refined Mods
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -1,4 +1,4 @@
-# Ranged Pumps [![Build Status](https://github.com/refinedmods/rangedpumps/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/refinedmods/rangedpumps/actions/workflows/build.yml) [![Downloads on CurseForge](http://cf.way2muchnoise.eu/full_247496_downloads.svg)](http://minecraft.curseforge.com/projects/ranged-pumps) [![Discord](https://img.shields.io/discord/342942776494653441)](https://discordapp.com/invite/VYzsydb) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.md)
+# Ranged Pumps [![Build Status](https://github.com/refinedmods/rangedpumps/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/refinedmods/rangedpumps/actions/workflows/build.yml) [![Downloads on CurseForge](http://cf.way2muchnoise.eu/full_247496_downloads.svg)](http://minecraft.curseforge.com/projects/ranged-pumps) [![Downloads on Modrinth](https://img.shields.io/modrinth/dt/ranged-pumps?logo=modrinth)](https://modrinth.com/mod/ranged-pumps) [![Discord](https://img.shields.io/discord/342942776494653441)](https://discordapp.com/invite/VYzsydb) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.md)
 
 ## About
 
@@ -14,6 +14,7 @@ Ranged Pumps is a simple mod that adds a pump that pumps liquids in a range.
 - [CurseForge](https://curseforge.com/minecraft/mc-mods/ranged-pumps)
 - [Modrinth](https://modrinth.com/mod/ranged-pumps)
 - [Wiki](https://refinedmods.com/ranged-pumps/)
+- [Javadoc](https://refinedmods.com/javadoc/rangedpumps)
 - [Discord](https://discordapp.com/invite/VYzsydb)
 - [Twitter](https://twitter.com/refinedmods)
 - [Mastodon](https://anvil.social/@refinedmods)

build.gradle

@@ -1,4 +1,4 @@
-apply from: "https://raw.githubusercontent.com/refinedmods/refinedarchitect/v0.6.0/helper.gradle"
+apply from: "https://raw.githubusercontent.com/refinedmods/refinedarchitect/v0.11.3/helper.gradle"
 
 group = 'com.refinedmods'
 

docs/nav.json

@@ -0,0 +1,14 @@
+[
+  {
+    "ref": "index.adoc"
+  },
+  {
+    "ref": "pump-in-minecraft-1.10.2.adoc",
+    "title": "Pump (Minecraft 1.10.2)"
+  },
+  {
+    "title": "What's new",
+    "ref": "whats-new.adoc",
+    "icon": "bi-lightbulb-fill"
+  }
+]

docs/pages/index.adoc

@@ -0,0 +1,58 @@
+= Pump
+:icon: pump.png
+
+Ranged Pumps is a simple mod that adds a pump that pumps liquids in a range.
+
+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.

docs/pages/pump-in-minecraft-1.10.2.adoc

@@ -0,0 +1,58 @@
+= Pump
+:icon: pump.png
+
+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.

docs/pages/whats-new.adoc

@@ -0,0 +1 @@
+= What's new