Skip to content

Latest commit

 

History

History
95 lines (58 loc) · 4.33 KB

README.md

File metadata and controls

95 lines (58 loc) · 4.33 KB
Raw

MIT License

Modrinth Curseforge

Project Overview

This mod is an implementation of a bridging assist feature commonly referred to as "Reach-Around Placement" for Forge, Fabric, & Quilt! It's very similar to the functionality found in both Minecraft: Bedrock Edition, & the Quark mod, with the current versions source being written from scratch.

The bridging assistance allows for placing blocks in gaps in-front, above, or below blocks even if the necessary surface isn't visible! To mark when the feature is available, an additional crosshair is shown to indicate the direction that a block can be placed in. When the F3 menu is visible, there's even an additional bounding box showing the exact position it's placing in.

This mod's official project pages can be found below:

📜 Credits

Previous versions of the Bridging Mod (< 2.0.0) were based on the Quark implementation of "Reach-Around Placement". You can find Quark's source here:

Translations

  • Mexican Spanish: @TheLegendofSaram

Contributing

Pull Requests and Issues are always welcome! Try to stick to templates where available but deviate if some components don't apply. Detail is important when debugging an issue or trying to implement a new system however so prioritise that!

Thanks for any help in advance! :) -- I keep an eye out for Issues and PRs fairly regularly.

📦 Building/Running the project

The project can be built with:

  • gradle cleanAll build collectJars / gradlew cleanAll build collectJars depending on your install.
  • This should build to /build/for-publishing/

If running the mod in a dev environment, runs should be created automatically. If not, consult the Fabric Loom Wiki on how to generate these through gradle.

📈 Updating Versions / Adding Dependencies

A lot of this project is streamlined to make version updates quicker by reducing the amount of redundant version strings. All mod dependencies should have their versions listed in the gradle.properties file, using variables to drop them into files such as fabric.mod.json, mods.toml & this README when needed. Minecraft & Fabric versions are handled in the exact same way for the same reasons.

For Minecraft Version Updates:

  • Check the Fabric Develop utility to get the version strings for a version
    • do NOT use yarn_mappings -- this project uses Mojmaps
  • Change the Recommended Minecraft Forge version to the corresponding loader version.
    • NeoForge support should work out of the box for now.
  • Copy the versions found into the appropriate entries found in gradle.properties
  • Run gradle updateDocTemplates / gradlew updateDocTemplates to update any documentation that lists versions

For Updating Dependencies:

  • Change the dependency version found in gradle.properties
  • Run gradle updateDocTemplates / gradlew updateDocTemplates to update any documentation that lists versions

For New Dependencies:

  • Add a new entry to gradle.properties with the dependency's version.
  • Add the dependency inside build.gradle, using a project placeholder referencing the gradle.properties property
  • Add the dependency to the fabric fabric.mod.json, using a placeholder referencing the gradle.properties property
  • Add the dependency to the forge mods.toml, using a placeholder referencing the gradle.properties property
  • Add a new badge to /template_docs/README.md, using a placeholder referencing the gradle.properties property
  • Run gradle updateDocTemplates / gradlew updateDocTemplates to update any documentation that lists versions