diff --git a/readme.md b/readme.md index 4d50338..38e1ddc 100644 --- a/readme.md +++ b/readme.md @@ -1,2 +1,27 @@ # #MyServer -Connect to a configured server, front-and-center. \ No newline at end of file +Shrinks the "Multiplayer" button, and replaces it with one to connect to a configured server, front-and-center. Inspired by [Auto Connect To Multiplayer Server](https://modrinth.com/mod/auto-connect-to-multiplayer-server), but does things a bit different! + +## What? +The "Join Server" button connects directly to the configured server (configurable through [Mod Menu](https://modrinth.com/mod/modmenu), or by editing `myserver.json`). Disconnecting from this server will return to the title screen. + +Server resource packs can be configured to automatically be accepted (default) or prompt on join. This mod is designed for mod packs tied to a specific server, where its behavior is entirely known. + +To connect to a different server, the regular multi-player menu can still be accessed via the magnifying glass button. + +Additionally, for servers that intend only for players to connect to a server, the "Singleplayer" button can be disabled temporarily through the configuration file. + +## How? +This is a two-mixin mod that reduces the width and positioning of the "Multiplayer" button, then creates a new one in its place. Simple as that! + +## Why? +For mod packs that are designed for use with a specific server in mind, access to the entire multi-player menu might not be desirable. Similarly, shipping a brittle `servers.dat` file can easily cause issues, either user-facing (servers list getting overwritten every update) or developer-facing (server not getting added to the list). + +This mod provides a separate way to configure a server without finangling with the server list itself. Overwriting the config file is safe, as no player should be modifying it themselves. + +## FAQ + +### Will this be ported to more mod loaders? +In the future, probably. + +### Will this be ported to more Minecraft versions? +In the future, probably. diff --git a/rumdl.toml b/rumdl.toml index c3f3826..fa8f17f 100644 --- a/rumdl.toml +++ b/rumdl.toml @@ -24,4 +24,4 @@ allowed-elements = ["img", "details", "summary"] [MD063] style = "sentence-case" -ignore-words = ["#MyServer"] +ignore-words = ["#MyServer", "Minecraft"]