diff --git a/README.md b/README.md index 54153c1..11cbef0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -## MMS - Description +## About MMS This is a **M**odded **M**inecraft **S**erver project, mostly a modpack. (please tell me a better name than MMS, I'm open for suggestions) -The modpack is centralised around the [Create mod](https://github.com/Fabricators-of-Create/Create). Why Create? Because it's a cool mod, obviously! +MMS is centralised around the [Create mod](https://github.com/Fabricators-of-Create/Create). Why Create? Because it's a cool mod, obviously! Apart from that there are 4 goals: - Only add features and functionality to the game, keep the vanilla features and functionality untouched. Complex Redstone contraptions, for example, which are supposed to work in vanilla, should also work with the MMS modpack. - Find a middle ground between being too minimalistic and too bloated. @@ -10,11 +10,22 @@ Apart from that there are 4 goals: Based on these goals everything else is decided. That's why the mod loader is [Fabric](https://fabricmc.net/), which is lightweight and doesn't change Minecraft's vanilla behaviour. - -The 'modpack' is actually separated into two modpacks: MMS-client and MMS-server. The later is supposed to run on a server, the first is supposed to run on a client and connect to the server. +**If the Create mod and these goals appeal to you, MMS might be just the thing!** + +The 'MMS' project is separated into three modpacks: +- **MMS-full** combines MMS-client and MMS-server, providing the full MMS experience in Singleplayer as well. It may however run less smoothly than MMS-client on your computer. +- **MMS-client** is for use with MMS-server and is more lightweight than MMS-full by excluding server-only features like world generation mods. It can also be used in Singleplayer, without the full MMS experience and requires less resources than MMS-full. +- **MMS-server** is to be used on a dedicated server. It contains Mods with functionality only on servers. + Additionally, MMS-client-min is provided as information on how to make a client compatible with the server. It's only the bare minimum to achieve compatibility. It also includes optional mods, which the server provides supports for. They are `.disabled` by default. + Explicit contents: +
+MMS-full +WIP +
+
MMS-client WIP @@ -59,10 +70,14 @@ WIP - This project is *mostly* licensed under the [AGPL-3.0-or-later](./LICENSE). - The "client" and "server" modpacks are based on [Simply Optimized](https://modrinth.com/modpack/sop) by "HyperSoop", which has it's own license at . - **Excluded** from the [AGPL-3.0-or-later](./LICENSE) are - - all "mods" (jar binaries), as each has their own open-source license (Except for Xaero's World Map, which is closed-source). You can find them in the "mods" folders: + - all "mods" (jar binaries), as each has their own license (most of which are open-source). You can find them in the "mods" folders: - [./client/mods](./client/mods) - [./client-min/mods](./client-min/mods) - [./server/server/mods](./server/server/mods) + - These mods are licensed All Rights Reserved: + - Xaero's World Map, closed-source + - What Are They Up To (Watut), [source available](https://github.com/Corosauce/WATUT) + - dependency CoroUtil, [source available](https://github.com/Corosauce/CoroUtil) - all resourcepacks in [./client/resourcepacks](./client/resourcepacks) as I (anonoe) do not own them. I distribute them with the permission granted by Vanilla Tweaks [here](https://vanillatweaks.net/terms/). - all datapacks in [./server/server/world/datapacks](./server/server/world/datapacks) as I (anonoe) do not own them. I distribute them with the permission granted by Vanilla Tweaks [here](https://vanillatweaks.net/terms/) and by Stardust Labs [here](https://github.com/Stardust-Labs-MC/Structory/blob/v1.3.5/license.txt) and [here](https://github.com/Stardust-Labs-MC/Structory-Towers/blob/v1.0.7/license.txt). - the fabric-server-mc...loader...launcher...jar file(s) located at [./server/server](./server/server) by FabricMC licensed under the [Apache-2.0 License](https://github.com/FabricMC/fabric-installer/?tab=Apache-2.0-1-ov-file#readme)