diff --git a/Curseforge.md b/Curseforge.md index 78172254..b9c29ed1 100644 --- a/Curseforge.md +++ b/Curseforge.md @@ -1,11 +1,17 @@ -# ItemSwapper +# Itemswapper -> This mod is still in development and may change over time. Feel free to open an issue/discussion on Github with any suggestions or bugs you find. +[![Github releases](https://cf.way2muchnoise.eu/itemswapper.svg)](https://www.curseforge.com/minecraft/mc-mods/itemswapper) +[![Github releases](https://img.shields.io/modrinth/dt/itemswapper?label=Modrinth&logo=Modrinth)](https://modrinth.com/mod/itemswapper) +[![Github releases](https://img.shields.io/github/v/release/tr7zw/ItemSwapper)](https://github.com/tr7zw/ItemSwapper/releases/latest) +[![Github releases](https://img.shields.io/github/issues/tr7zw/ItemSwapper.svg)](https://github.com/tr7zw/ItemSwapper/issues) +[![Github releases](https://img.shields.io/github/license/tr7zw/ItemSwapper.svg)](https://github.com/tr7zw/ItemSwapper/blob/1.19/LICENSE) +[![Github releases](https://img.shields.io/github/stars/tr7zw/ItemSwapper)](https://github.com/tr7zw/ItemSwapper/stargazers) +[![Github releases](https://img.shields.io/github/forks/tr7zw/ItemSwapper)](https://github.com/tr7zw/ItemSwapper/network/members) +[![Github releases](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/2wKH8yeThf) +[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O5O7ACGRH) -[![Discord](https://tr7zw.dev/curse/Discord-long.png)](https://discord.gg/2wKH8yeThf)[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O5O7ACGRH) - -Tweaks to the inventory system based on [Xisumavoid's video](https://www.youtube.com/watch?v=A6DvnFCW5FY). -Adds an item switch interface triggered by pressing a hotkey(Default: `R`). Depending on the item in the main hand, the interface will show different options(or not show up at all for unmapped items). Switch between the options by moving the mouse(or using the scroll wheel for the list). Releasing the hotkey will swap the item in the main hand with the selected item. In the item wheel, pressing the middle mouse button while having an item selected switches to related items(if available). +**Itemswapper is a free and open-source inventory tweak mod for the Minecraft +client that adds an item switch interface** ## Features @@ -16,20 +22,107 @@ Adds an item switch interface triggered by pressing a hotkey(Default: `R`). Depe - Item list for dynamic items like tools, food, potions, etc. - Fully customizable via resource packs -## Dependencies +Tweaks to the inventory system are based +on [Xisumavoid's video](https://www.youtube.com/watch?v=A6DvnFCW5FY). -- FabricAPI +## Usage -## Credits +**⚠️ This mod is still in development and may change over time. Feel free to open an +[issue](https://github.com/tr7zw/ItemSwapper/issues)/[discussion](https://github.com/tr7zw/ItemSwapper/discussions) +on Github with any suggestions or bugs you find.** -- [Xisumavoid](https://www.youtube.com/xisumavoid) for the idea/video of the concept -- [LizardOfOz](https://www.youtube.com/LizardOfOz) Designer +Itemswapper adds an interface for switching items, which is opened by pressing a hotkey (by +default: `R`). Depending on the item in the main hand, the interface displays different options. For +unlisted items, the interface is not displayed at all. + +You can switch between items by **moving the mouse** or **by scrolling** through list. Releasing +the hotkey will swap the item in the main hand with the selected item. + +Pressing the **middle mouse button** while an item is selected will switch to the related items, if +they +are available. + +Creating your own resource pack allows you to customize the existing interface or adds support for +non-vanilla items. + +## Installation + +### Manual installation + +You will need the Fabric Loader in your game in order to load Itemswapper. If you haven't installed +Fabric mods before, you can find different community guides for doing +so [here](https://fabricmc.net/wiki/install). This mod **requires** the use +of [FabricAPI](https://modrinth.com/mod/fabric-api). + +### Stable releases + +[![Modrinth page](https://img.shields.io/modrinth/dt/itemswapper?label=Modrinth&logo=Modrinth)](https://modrinth.com/mod/itemswapper) +[![Github releases](https://img.shields.io/github/v/release/tr7zw/ItemSwapper)](https://github.com/tr7zw/ItemSwapper/releases/latest) + +The latest releases of Itemswapper are published to the +projects [Modrith page](https://modrinth.com/mod/itemswapper) +and [Github release](https://github.com/tr7zw/ItemSwapper/releases/latest) +page. Releases are considered by our team to be **suitable for general use**, but they are not +guaranteed to be free of bugs or issues. If you think you found a bug/issue, please report them to +our [issue tracker](https://github.com/tr7zw/ItemSwapper/issues). + +### CurseForge
+ +[![CurseForge page](https://cf.way2muchnoise.eu/itemswapper.svg)](https://www.curseforge.com/minecraft/mc-mods/itemswapper) + +If you are using the CurseForge client, you can continue to find downloads through +the [mods project page on CurseForge](https://www.curseforge.com/minecraft/mc-mods/itemswapper). +Unless you are using the CurseForge +client, you should prefer the downloads linked on +our [Modrinth](https://modrinth.com/mod/itemswapper) +or [GitHub release](https://github.com/tr7zw/ItemSwapper/releases/latest) pages above. + +### FAQ -## Images +Frequently asked questions and our answers are listed in its own file, check the [FAQ](FAQ.md) to +navigate to it. + +### Community + +[![Discord chat](https://img.shields.io/badge/chat%20on-discord-7289DA?logo=discord&logoColor=white)](https://discord.gg/2wKH8yeThf) + +We have a [Discord community](https://discord.gg/2wKH8yeThf). By joining , you can: + +- Get installation help and technical support +- Be notified of the latest developments +- Get involved and collaborate + +### Reporting Issues + +You can report bugs and crashes by opening an issue on +our [issue tacker](https://github.com/tr7zw/ItemSwapper/issues). Before opening a new +issue, use the search tool to make sure that your issue has not already been reported and ensure +that you have completely filled out the issue template. Issues that are duplicate or do not contain +the necessary information for troubleshooting may be closed. + +Please note that while the issue tracker is open to feature requests, development is primarily +focused on finishing any unimplemented features. + +### Gallery ![Plank Types](https://raw.githubusercontent.com/tr7zw/ItemSwapper/1.19/img/planktypes.png) ![Wood Options](https://raw.githubusercontent.com/tr7zw/ItemSwapper/1.19/img/woodoptions.png) ![Dyes](https://raw.githubusercontent.com/tr7zw/ItemSwapper/1.19/img/dyes.png) ![Tools](https://raw.githubusercontent.com/tr7zw/ItemSwapper/1.19/img/tools.png) ![Potions](https://raw.githubusercontent.com/tr7zw/ItemSwapper/1.19/img/potions.png) -![Redstone](https://raw.githubusercontent.com/tr7zw/ItemSwapper/1.19/img/redstone.png) \ No newline at end of file +![Redstone](https://raw.githubusercontent.com/tr7zw/ItemSwapper/1.19/img/redstone.png) + +### Credits + +- [Xisumavoid](https://www.youtube.com/xisumavoid) for the idea/video of the concept +- [LizardOfOz](https://www.youtube.com/LizardOfOz) Designer + +### License + +Itemswapper is licensed under GNU GPLv3, a free and open-source license. For more information, +please see the +[license file](https://github.com/tr7zw/ItemSwapper/blob/1.19/LICENSE). + +### Curseforge Comments + +**Note**: The comments on CurseForge are not there to report bugs/crashes or to get help. Read this page to see where to get help! diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 00000000..ea82aaf7 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,118 @@ +# Frequently asked questions + +## Table of Content + +* [Where are the latest versions of all your mods?](#latest-version) +* [Where are the Forge versions of the mod?](forge-version) +* [Warning! No compatible resourcepack for Itemswapper is enabled. What can I do?](#no-resource-pack) +* [Why isn't the Shulkerbox support working when playing on a server?](#shulkerbox-support) +* [Where can I find the server version of Itemswapper?](#server-version) +* [Why do I get a warning when joining the server?](#server-warning) +* [What is the modpack policy?](#modpack-policy) +* [What is your version support policy?](#support-policy) +* [How can I check if the mod is loaded?](#is-mod-loaded) +* [What is Modrinth?](#modrinth) + +--- + +## Where is the latest versions of Itemswapper?
+ +The latest releases of Itemswapper are published to the +projects [Modrith page](https://modrinth.com/mod/itemswapper) +and [Github release](https://github.com/tr7zw/ItemSwapper/releases/latest) +page. If you are using the CurseForge client, check +out [CurseForge](https://www.curseforge.com/minecraft/mc-mods/itemswapper) + +--- + +## Where are the Forge versions of the mod?
+ +There are several reasons why there is no "Forge" version of the mod. The main reason is that we are +a group of volunteers who spend their free time working on this project. Maintaining another version +would require even more time. Furthermore, Forge does not make it easy for developers to work with +build-in resource packs, which is one of the main features of this mod. For more information see the +[issue](https://github.com/tr7zw/ItemSwapper/issues/25) that is dedicated to this question. + +--- + +## Warning! No compatible resourcepack for Itemswapper is enabled. What can I do?
+ +You see the following warning ``Warning! No compatible resourcepack for Itemswapper is enabled`` if +Itemswapper could not find a resource pack that defines the Items in the switch interface. To load +such a resource pack, go to your resource pack settings in your client and select the build-in +resource pack that ships with Itemswapper. + +--- + +## Why isn't the Shulkerbox support working when playing on a server?
+ +If swapping items from Shulker crates does not work on the server you are playing on, it is probably +because the server does not have the server version of Itemswapper installed. If this is your own +server, you might check out below question about where the server version can be found. + +--- + +## Where can I find the server version of Itemswapper?
+ +If you are running a Fabric server you only need to install the latest Fabric version of Itemswapper +that matches with the server version. See [here](https://modrinth.com/mod/itemswapper/versions) for +the Fabric version. + +If you are running a Bukkit/Paper/Purpur/Spigot server you need to install the appropriate version. +See [here](https://modrinth.com/mod/itemswapper/versions) for the Bukkit/Paper/Purpur/Spigot +version. + +--- + +## Why do I get a warning when joining the server?
+ +We have decided that using Itemswapper on a Vanilla server might get you an unfair advantage over +players that are not using Itemswapper. For this reason the server owner is provided with the +ability to block this mod. If the server owner does not have blocked this mod, they might see using +this mod as cheating and so can ban you. Please **use Itemswapper at your own risk** on a server +where the warning is being displayed! + +--- + +## What is the modpack policy?
+ +All of our mods are currently licensed under +the [GNU LGPLv3](https://github.com/tr7zw/ItemSwapper/blob/1.19/LICENSE), a free and open-source +license. For most intents and purposes, this means you can freely distribute them alongside your +modpack so long as you provide attribution. + +--- + +## What is your version support policy?
+ +We generally only publish releases for the latest version of Minecraft (see our mainline branch on +GitHub) as porting to older versions takes a lot of time and resources. However, a 1.18 release is +planed for the future, but it is unlikely to happen if 1.20 will be releases before our planed 1.18 +release. For a further version overview check [here](https://tr7zw.github.io/versions/). + +--- + +## How can I check if the mod is loaded?
+ +To check if Itemswapper could be loaded correctly the easiest way is to use an in-game mod menu such +as [Mod Menu](). However, you can also check the log files of your client/server. If the mod could +be loaded properly, the mod and its version will be logged as in below example. + +``` +[00:37:05] [main/INFO] (FabricLoader/GameProvider) Loading Minecraft 1.19.2 with Fabric Loader 0.14.9 +[00:37:05] [main/INFO] (FabricLoader) Loading 45 mods: + - fabric-api 0.60.0+1.19.2 + [...] + - fabricloader 0.14.9 + - itemswapper 0.3.2-mc1.19.2 + - minecraft 1.19.2 + - modmenu 4.0.6 +``` + +--- + +## What is Modrinth?
+ +Modrinth is an alternative platform for hosting Minecraft mods. It's generally easier to use and +provides better tooling for developers, but doesn't quite have widespread adoption yet. Where +possible, we recommend players use Modrinth or GitHub to check for the latest versions. diff --git a/Modrinth.md b/Modrinth.md index 297d39e7..c89685b7 100644 --- a/Modrinth.md +++ b/Modrinth.md @@ -1,11 +1,46 @@ -# ItemSwapper +

+ +
+ Itemswapper +
+

-> This mod is still in development and may change over time. Feel free to open an issue/discussion on Github with any suggestions or bugs you find. +

Itemswapper is a free and open-source inventory tweak mod for the Minecraft +client +that adds an item switch interface

-Tweaks to the inventory system based on [Xisumavoid's video](https://www.youtube.com/watch?v=A6DvnFCW5FY). -Adds an item switch interface triggered by pressing a hotkey(Default: `R`). Depending on the item in the main hand, the interface will show different options(or not show up at all for unmapped items). Switch between the options by moving the mouse(or using the scroll wheel for the list). Releasing the hotkey will swap the item in the main hand with the selected item. In the item wheel, pressing the middle mouse button while having an item selected switches to related items(if available). +

+ + + + + + + + +

-## Features +> **⚠️ This mod is still in development and may change over time. Feel free to open an +> [issue](https://github.com/tr7zw/ItemSwapper/issues)/[discussion](https://github.com/tr7zw/ItemSwapper/discussions) +> on Github with any suggestions or bugs you find.** + +## Table of contents + +* [Features](#features) +* [Installation](#installation) + * [Manual installation](#manual-installation) + * [Stable releases](#stable-releases) + * [CurseForge](#curseforge) +* [FAQ](#faq) +* [Community](#community) +* [Reporting Issues](#reporting-issues) +* [Gallery](#gallery) +* [Credits](#credits) +* [License](#license) + +--- + +## Features
- Switch between items from the inventory - Show the inventory from an empty hand @@ -14,20 +49,115 @@ Adds an item switch interface triggered by pressing a hotkey(Default: `R`). Depe - Item list for dynamic items like tools, food, potions, etc. - Fully customizable via resource packs -## Dependencies +Tweaks to the inventory system are based +on [Xisumavoid's video](https://www.youtube.com/watch?v=A6DvnFCW5FY). -- FabricAPI +--- -## Credits +## Usage -- [Xisumavoid](https://www.youtube.com/xisumavoid) for the idea/video of the concept -- [LizardOfOz](https://www.youtube.com/LizardOfOz) Designer +Itemswapper adds an interface for switching items, which is opened by pressing a hotkey (by +default: `R`). Depending on the item in the main hand, the interface displays different options. For +unlisted items, the interface is not displayed at all. + +You can switch between items by **moving the mouse** or **by scrolling** through list. Releasing +the hotkey will swap the item in the main hand with the selected item. + +Pressing the **middle mouse button** while an item is selected will switch to the related items, if +they +are available. + +Creating your own resource pack allows you to customize the existing interface or adds support for +non-vanilla items. + +--- + +## Installation
+ +### Manual installation
+ +You will need the Fabric Loader in your game in order to load Itemswapper. If you haven't installed +Fabric mods before, you can find different community guides for doing +so [here](https://fabricmc.net/wiki/install). This mod **requires** the use +of [FabricAPI](https://modrinth.com/mod/fabric-api). + +### Stable releases
+ +[![Modrinth page](https://img.shields.io/modrinth/dt/itemswapper?label=Modrinth&logo=Modrinth)](https://modrinth.com/mod/itemswapper) +[![Github releases](https://img.shields.io/github/v/release/tr7zw/ItemSwapper)](https://github.com/tr7zw/ItemSwapper/releases/latest) + +The latest releases of Itemswapper are published to the +projects [Modrith page](https://modrinth.com/mod/itemswapper) +and [Github release](https://github.com/tr7zw/ItemSwapper/releases/latest) +page. Releases are considered by our team to be **suitable for general use**, but they are not +guaranteed to be free of bugs or issues. If you think you found a bug/issue, please report them to +our [issue tracker](https://github.com/tr7zw/ItemSwapper/issues). + +### CurseForge
+ +[![CurseForge page](https://cf.way2muchnoise.eu/itemswapper.svg)](https://www.curseforge.com/minecraft/mc-mods/itemswapper) + +If you are using the CurseForge client, you can continue to find downloads through +the [mods project page on CurseForge](https://www.curseforge.com/minecraft/mc-mods/itemswapper). +Unless you are using the CurseForge +client, you should prefer the downloads linked on +our [Modrinth](https://modrinth.com/mod/itemswapper) +or [GitHub release](https://github.com/tr7zw/ItemSwapper/releases/latest) pages above. + +--- -## Images +### FAQ
+ +Frequently asked questions and our answers are listed in its own file, check the [FAQ](FAQ.md) to +navigate to it. + +--- + +### Community
+ +[![Discord chat](https://img.shields.io/badge/chat%20on-discord-7289DA?logo=discord&logoColor=white)](https://discord.gg/2wKH8yeThf) + +We have a [Discord community](https://discord.gg/2wKH8yeThf). By joining , you can: + +- Get installation help and technical support +- Be notified of the latest developments +- Get involved and collaborate + +--- + +### Reporting Issues
+ +You can report bugs and crashes by opening an issue on +our [issue tacker](https://github.com/tr7zw/ItemSwapper/issues). Before opening a new +issue, use the search tool to make sure that your issue has not already been reported and ensure +that you have completely filled out the issue template. Issues that are duplicate or do not contain +the necessary information for troubleshooting may be closed. + +Please note that while the issue tracker is open to feature requests, development is primarily +focused on finishing any unimplemented features. + +--- + +### Gallery