Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
59xa authored Aug 10, 2024
1 parent b377cc8 commit 7e4bc39
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,34 @@
![Reconnect Mod: Reloaded Icon](https://github.com/59xa/reconnect-mod-reloaded/blob/master/src/main/resources/assets/reconnect-mod-reloaded/icon.png?raw=true)
# Reconnect Mod: Reloaded
A simple mod that supersedes [HiWord9](https://github.com/HiWord9)'s Reconnect Button mod, updated to support 1.21!

[![Modrinth](https://img.shields.io/modrinth/dt/PjzgKfEE?label=&logo=Modrinth&labelColor=white&color=00AF5C&style=for-the-badge)](https://modrinth.com/mod/reconnect-mod-reloaded)
[![License](https://img.shields.io/github/license/59xa/reconnect-mod-reloaded?label=&logo=c&style=for-the-badge&color=A8B9CC&labelColor=455A64)](https://github.com/59xa/reconnect-mod-reloaded/blob/master/LICENSE)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/59xa/reconnect-mod-reloaded/build.yml?style=for-the-badge&label=&logo=Gradle&labelColor=388E3C)](https://github.com/59xa/reconnect-mod-reloaded/actions)

[![Minecraft Version](https://img.shields.io/badge/Minecraft-1.21.1%20|%201.21-green?style=for-the-badge&labelColor=388E3C&color=8BC34A)](https://github.com/xfl03/MCCustomSkinLoader)

A simple mod that supersedes [HiWord9](https://github.com/HiWord9)'s Reconnect Button mod, updated to support 1.21+!
- This mod adds a reconnect button on your in-game menu screen while in a Multiplayer world.

## This mod currently supports Fabric 1.21
![Reconnect Mod: Reloaded Example](https://cdn.modrinth.com/data/PjzgKfEE/images/54a7871bc46040b5214402a13cbbd4ab58b64aec.png)

## This mod currently supports Fabric 1.21+
- There are no current plans of porting this mod to other modloaders like Forge, but will be considered if there is demand.
- Potential mod backporting to old versions may be possible in the near future if there is also demand for it.

## Will this mod come to CurseForge?
- There are currently no plans of bringing this mod to Curseforge. For now this mod is available for download on [releases page](https://github.com/59xa/reconnect-mod-reloaded/releases/tag/Releases) or on [https://modrinth.com/mod/reconnect-mod-reloaded](Modrinth)

## Is this mod be usable in Realms?
- Due to how Mojang operates Realms, it is somewhat impossible to pinpoint the server address for any Realm world that you try to join.
- For the time being, using the reconnect button on Realms is not possible and has been disabled for use.

## Dependencies and Incompatibilities
- There are currently no incompatibilities seen with this mod at the moment.
- This mod requires the Fabric API to function properly.

## Known Issues
- Reconnecting on a Realms server causes a `getsockopt` exception.

-> This issue is known, and the reconnect button may not work on Realms for the time being

-> This mod is not yet tested properly in Realms, but will do when there is a chance
## Known issues
- N/A

## Building the project
- JDK 21 (required)
Expand All @@ -31,5 +44,5 @@ cd build/libs

## Credits
- HiWord9's implementation ([link](https://github.com/HiWord9/Reconnect-Button-HiWord9-fabric-1.19))
- Fabric ([link](https://fabricmc.net/))
- Fabric API ([link](https://fabricmc.net/))
- You (for giving this mod a try! 🤍)

0 comments on commit 7e4bc39

Please sign in to comment.