diff --git a/README.md b/README.md index 50375a9e..bec0a21b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,15 @@

-

Building Gadgets

+

Building Gadgets (Legacy)

+

+Update! See Building Gadgets 2 +

Sometimes, building large structures can be a little tedious, and take a lot of effort. Not all of us are great builders you know!

GitHub license - GitHub issues - GitHub stars discord - activity - GitHub Release Date - Lines of code

‌

@@ -20,30 +18,40 @@ `Dire's Building Gadgets` aims to make building a little bit easier. At this time there are `four` tools, and they are described below. Alternatively, watch the following mod spotlight for instructions! +## Important notice + +As of Minecraft `1.20.1` this version of Building Gadget (Building Gadgets 1) is officially the 'Legacy' version of Building Gadgets. I will continue to update the mod for the Minecraft versions we already support but this mod will not be ported to Minecraft `1.20.1` or higher. + +### What's next? + +I'm glad you've asked! Go and download [`Building Gadgets 2`](https://github.com/direwolf20-mc/buildinggadgets2)! It's the same mod but with a bunch of new and awesome features built on a brand-new codebase. It's just better! + +### Why is it better? + +We've been officially supporting Building Gadgets 1 since Minecraft `1.12`... That's... *(checks notes)* 6 years! 6 years of updates, bug fixes, feature requests and Minecraft updates. After such a long time, code can become overcomplicated, messy and hard to maintain. When this happens, it's best to start again. After some consideration, we opted to start a new Github Repo and start from a truly clean state. + +### Thanks to our contributors + +One final note, I would like to thank of all of our contributors to Building Gadgets 1. You've all helped the mod stay updated, feature rich and ever-growing. This mod is vastly different to how it was back in `1.12` and our contributors are to thank for that! + +--- + ## Usage + To see how to use Dire's `Building Gadgets` refer to our [Wiki](https://github.com/Direwolf20-MC/BuildingGadgets/wiki) which has been recently updated to be inline with the mod as of `1.16.5`. Please feel free to make feature requests to add more info to our wiki. We're always trying to improve. Direwolf20's Spotlights - [Spotlight Part One](https://youtu.be/D4Ib4h7aTSk) and [Spotlight Part Two](https://youtu.be/JS1Xx_kwQQ0) -### Installing the mod -**First**, grab [Forge](https://files.minecraftforge.net) and install it using the installer. **Second**, pick up [Building Gadgets](https://minecraft.curseforge.com/projects/building-gadgets) from CurseForge, **Third**, drop the hot stuff into your `mods` folder (*Psst*! It's (usually) in `C:\Users\\AppData\Roaming\.minecraft\mods` on *Windows* and `~/Library/Application\ Support/minecraft/mods` on *Mac* and `~/.minecraft` on *most Linux distros*), **Finally**, Enjoy! - -*Bonus: Find a bug and report it for a cookie.* - ### Using the Gadgets -Building gadgets has grown a lot since its initial release to the point that we have multiple tools for every occasion, Our wiki has a great set of instructions on how to use each of our Gadgets, check out the [Building Gadget](https://github.com/Direwolf20-MC/BuildingGadgets/wiki/Building-Gadget), the [Exchanger Gadget](https://github.com/Direwolf20-MC/BuildingGadgets/wiki/Exchanger-Gadget), the [Copy Paste Gadget](https://github.com/Direwolf20-MC/BuildingGadgets/wiki/Copy-Paste-Gadget), or the [Destruction Gadget](https://github.com/Direwolf20-MC/BuildingGadgets/wiki/Destruction-Gadget) -## Support -As we have grown to support multiple versions of Minecraft, we have had to create a hard stop on where we drop support for the past version's of Minecraft and of the mod. From this point on we will not support any versions of Minecraft that Forge themselves no longer support. Forge works in a `Latest & Latest minus one major` pattern that we will be adopting as well. For example, if we have a version of the mod on 1.16.3, this means that we officially support 1.16.3 as our `Latest` version and in conjunction is the version that'll receive new features and bug fixes. We will also maintain 1.15.2 for bug fixes as that'll be the `latest MC version minus one Major release`. Hopefully, that isn't too confusing! We hope this helps us focus more on growing the mod that trying to support every version of the mod. +Building gadgets has grown a lot since its initial release to the point that we have multiple tools for every occasion, Our wiki has a great set of instructions on how to use each of our Gadgets, check out the [Building Gadget](https://github.com/Direwolf20-MC/BuildingGadgets/wiki/Building-Gadget), the [Exchanger Gadget](https://github.com/Direwolf20-MC/BuildingGadgets/wiki/Exchanger-Gadget), the [Copy Paste Gadget](https://github.com/Direwolf20-MC/BuildingGadgets/wiki/Copy-Paste-Gadget), or the [Destruction Gadget](https://github.com/Direwolf20-MC/BuildingGadgets/wiki/Destruction-Gadget) ## Contributing -We welcome anyone and everyone that is willing to lend a hand and help out with maintaining and building our(Dire's) mod. If you'd like to suggest a [new feature](https://github.com/Direwolf20-MC/BuildingGadgets/issues/new?template=feature-request.md) or [report a bug](https://github.com/Direwolf20-MC/BuildingGadgets/issues/new?template=bug-report.md) then please do so with a [new issue](https://github.com/Direwolf20-MC/BuildingGadgets/issues/new) on our [issue tracker](https://github.com/Direwolf20-MC/BuildingGadgets/issues). -If instead you'd like to do some heavy lifting and get your hands dirty, check out our [Contribution Guide](https://github.com/Direwolf20-MC/BuildingGadgets/blob/master/CONTRIBUTION.md) to see how we work, our programming style and all of the do's and don'ts when submitting your [brand new Pull Request](https://github.com/Direwolf20-MC/BuildingGadgets/compare). - -We have a [Discord](https://discord.gg/qqUUtu3) server if you need some help or if you're planning any major changes that you'd like to get signed off before putting time into writing the code. +**Update**: Don't. Thanks, see [Important Notice](#important-notice) as to why. Please support the new version of Building Gadgets at https://github.com/direwolf20-mc/buildinggadgets2 if you would like to support the project! ## Credit + An especially big thanks to all of our [contributors](https://github.com/Direwolf20-MC/BuildingGadgets/graphs/contributors) for the continued support, bug reports (issues) and PR's. All of the [Forge Guys](https://github.com/orgs/MinecraftForge/people) and the creators of Minecraft (*Duh*) [License MIT](License.md)