Skip to content

Commit 35ab3e1

Browse files
committed
improve readme
1 parent 6b3ae62 commit 35ab3e1

1 file changed

Lines changed: 32 additions & 35 deletions

File tree

README.md

Lines changed: 32 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,66 @@
1-
<h1 align="center">
2-
✨ AutoModpack ✨
3-
</h1>
4-
<p align="center">
5-
Tired of modpack update headaches? AutoModpack takes care of it!
6-
<br/>
7-
<br/>
8-
<a href="https://www.curseforge.com/minecraft/mc-mods/automodpack"><img src="http://cf.way2muchnoise.eu/639211.svg" alt="CurseForge Downloads"></a>
9-
<a href="https://github.com/Skidamek/AutoModpack/releases"><img src="https://img.shields.io/github/downloads/skidamek/automodpack/total?style=round&logo=github" alt="GitHub Total Downloads"></a>
10-
<a href="https://modrinth.com/mod/automodpack"><img src="https://img.shields.io/modrinth/dt/k68glP2e?logo=modrinth&label=&style=flat&color=242629" alt="Modrinth Downloads"></a>
11-
</p>
12-
13-
---
141

15-
## 🤯 Ditch the Update Hassle, Dive into Gameplay!
16-
17-
**AutoModpack** is the ultimate Minecraft modification designed to **revolutionize private server modpack management**. Say goodbye to the days of struggling to get everyone on the same version! This mod **automatically synchronizes** players with the server's modpack, making playing with friends incredibly smooth and hassle-free.
2+
**AutoModpack** is a Minecraft modification designed to **improve your private server modpack management**. Say goodbye to the days of
3+
struggling to get everyone on the same version! This mod **automatically synchronizes** players with the server's modpack, making playing with friends incredibly smooth and hassle-free.
184

195
<p align="center">
206
<a href="https://youtu.be/lPPzaNPn8g8" target="_blank">
217
<img src="https://img.youtube.com/vi/lPPzaNPn8g8/0.jpg" alt="AutoModpack Showcase Video (Outdated)" width="400">
228
</a>
239
<br>
24-
<i>(Heads up! This showcase video is a little outdated, but it gives you a good idea of what AutoModpack does!)</i>
10+
<i>(This showcase video above is a little outdated, but it gives you a good idea of what AutoModpack does!)</i>
11+
</p>
12+
13+
<p align="center">
14+
<a href="https://www.curseforge.com/minecraft/mc-mods/automodpack"><img src="http://cf.way2muchnoise.eu/639211.svg" alt="CurseForge Downloads"></a>
15+
<a href="https://github.com/Skidamek/AutoModpack/releases"><img src="https://img.shields.io/github/downloads/skidamek/automodpack/total?style=round&logo=github" alt="GitHub Total Downloads"></a>
16+
<a href="https://modrinth.com/mod/automodpack"><img src="https://img.shields.io/modrinth/dt/k68glP2e?logo=modrinth&label=&style=flat&color=242629" alt="Modrinth Downloads"></a>
2517
</p>
2618

27-
<br>
2819

2920
> **Disclaimer:** While AutoModpack is a powerful tool for managing modpacks, the content it downloads (mods, resource packs, etc.) is created by various talented developers. Please remember to respect their work and licenses. Don't use AutoModpack to mass-distribute content without explicit permission, especially for commercial purposes. Always check the licenses of the mods you include in your pack.
3021
3122
## 🔥 Why AutoModpack is Your New Best Friend
3223

33-
This isn't just another mod; it's a game-changer for private servers. Here's why:
34-
3524
* 🔌 **Plug-'n'-Play:** Install the mod, and you're done! Live in perfect sync with the server's modpack forever.
36-
* 🔄 **Seamless Player Updates:** Players get the latest modpack updates automatically, without manual downloads or disruptions.
37-
* 🚀 **Effortless Admin Management:** Easily manage mods, configs, resource packs, shaders, and more. Your modpack, your control.
25+
* 🗽 **Independent:** No need for special launchers or modpack approvals from any third party service.
26+
* 🚀 **Effortless Admin Management:** Easily manage mods, configs, resource packs, shaders, anything really.
3827
* ⚡️ **Direct & Respectful Downloads:** The mod pulls directly from Modrinth and CurseForge APIs, so mod authors get credit for every download.
3928
* 🔒 **Secure & Speed:** Encrypted, authorized, compressed, quick modpack downloads.
4029

4130
## 🛠️ How the Magic Happens
4231

43-
AutoModpack works by generating a modpack (**metadata file**) on the server, which contains all the files of your modpack. The server then hosts this file and the modpack files.
32+
AutoModpack works by generating a modpack (a metadata file) from your files on the server, which contains description of all the files.
33+
The server then hosts that metadata and each modpack file indexed by its hash.
4434

4535
When a client connects to the server:
4636

47-
1. Connection: AutoModpack establishes a secure connection and prompts you to [verify the server's certificate fingerprint](https://moddedmc.wiki/en/project/automodpack/docs/technicals/certificate).
48-
2. Direct links: Fetches the APIs for direct downloads of your modpack's files from Modrinth and CurseForge, where possible (mods, resource packs, shaders).
49-
3. Modpack download: All files are downloaded to the client's automodpack folder.
50-
4. Game restart: AutoModpack loads the modpack, and the client is perfectly synced and ready to play!
37+
1. AutoModpack establishes a secure connection and prompts you to [verify the server's certificate fingerprint](https://moddedmc.wiki/en/project/automodpack/docs/technicals/certificate).
38+
2. It fetches the APIs for direct downloads of your modpack's files from Modrinth and CurseForge, where possible (mods,
39+
resource packs, shaders).
40+
3. Downloads all files to the client's automodpack folder.
41+
4. After game restart AutoModpack loads the modpack, and the client is perfectly synced and ready to play!
5142

52-
On subsequent game launches, AutoModpack checks for updates. If changes are detected, it updates the modpack in the background—no additional restarts are required!
43+
On subsequent game launches, AutoModpack checks for updates. If changes are detected, it updates the modpack in the background - no
44+
additional restarts are required! (unless there's an update detected while you are already in-game, there's no way around that :/)
5345

54-
## ⚠️ Security and Trust - Read This!
46+
## ⚠️ Security and Trust!
5547

5648
> With great power comes great responsibility.
5749
58-
Be aware that this mod allows remote servers to download *arbitrary executable* files directly into your game folder. It's crucial to **only use it on servers you absolutely trust**. A malicious server (administrator) *can* include malicious/harmful files.
50+
Be aware that this mod allows remote servers to download *arbitrary executable* files directly into your computer. It's crucial to
51+
**only use it on servers you absolutely trust**. A malicious administrator or a compromised server *can* include harmful files such as
52+
malware - to protect against this, please use sandboxed launchers such as [Pandora](https://pandora.moulberry.com/) or if you are on
53+
Linux, use launchers installed via Flatpak.
5954

60-
While AutoModpack itself tries to be as secure as possible, due to the nature of the internet, the creators and contributors of AutoModpack are not responsible for any harm, damage, loss, or issues that may result from files downloaded from a server you connect to using the mod. **By using AutoModpack, you acknowledge and accept this risk.**
55+
While AutoModpack itself tries to be as secure as possible, due to the nature of the internet, the creators and contributors of AutoModpack are not responsible for any harm, damage, loss, or issues that may result from using the mod. **By using AutoModpack, you acknowledge and accept this risk.**
6156

62-
**If you have valuable security insights or concerns, please reach out!** You can contact privately on [Discord](https://discordapp.com/users/464522287618457631) or publicly on [Discord server](https://discord.gg/hS6aMyeA9P) or just open an issue on [GitHub](https://github.com/Skidamek/AutoModpack/issues).
63-
## 🚀 Getting Started is a Breeze!
57+
**If you have valuable security insights or concerns, please reach out!** You can contact privately on [Discord](https://discordapp.com/users/464522287618457631), publicly on [Discord server](https://discord.gg/hS6aMyeA9P) or just open an issue on [GitHub](https://github.com/Skidamek/AutoModpack/issues).
6458

59+
## 🚀 Getting Started is a Breeze!
6560
Installing AutoModpack is as simple as installing any other mod.
6661

62+
0. If you have anything valuable in your Minecraft installation, **make a backup** before proceeding, just in case, if you are using
63+
launcher which supports multiple instances, create a new instance for AutoModpack.
6764
1. Download the AutoModpack from the releases page on [GitHub](https://github.com/Skidamek/AutoModpack/releases), [CurseForge](https://www.curseforge.com/minecraft/mc-mods/automodpack), or [Modrinth](https://modrinth.com/mod/automodpack).
6865
2. Place the downloaded file into the `/mods/` folder of both your server and client Minecraft installations.
6966
3. Start your server and let AutoModpack generate the initial modpack metadata.
@@ -79,9 +76,9 @@ Prefer an all-in-one solution? You can also use our [modified Fabric installer](
7976

8077
AutoModpack wouldn't be where it is without the amazing community!
8178

82-
* **All the fantastic [contributors](https://github.com/Skidamek/AutoModpack/graphs/contributors)** who have helped improve the mod!
79+
* **All the [contributors](https://github.com/Skidamek/AutoModpack/graphs/contributors)** who have helped improve the mod!
8380
* **[duckymirror](https://github.com/duckymirror), Juan, cloud, [Merith](https://github.com/Merith-TK), [SettingDust](https://github.com/SettingDust), Suerion, and griffin4cats** for their invaluable help with testing, code, and ideas!
84-
* **HyperDraw** for creating the awesome mod icon!
81+
* **HyperDraw** for creating the mod icon!
8582
* **All the generous supporters on [Ko-fi](https://ko-fi.com/skidam)** - your support means the world!
8683

8784
## 💖 Contribute and Make AutoModpack Even Better!

0 commit comments

Comments
 (0)