From 0311d0106f3034866f1ad8d80c82e04289ad1c37 Mon Sep 17 00:00:00 2001
From: samsonsin <samson@emblad.com>
Date: Sat, 7 Jun 2025 06:04:17 +0200
Subject: [PATCH] readme

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..8b6b7078
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# Gregtech: New Bastards Custom Clientpack
+
+Welcome to the Gregtech: New Horizons Clientpack!
+
+## Installation Instructions
+
+### Easy Way
+The easy way is to download the latest release or the repo itself. Import the .zip file into your Prism Launcher. When updating, do the same then move modified files to the new instance.
+
+### Hard Way (Recommended)
+The recommended install method is to clone the repo using git into your `\Prism Launcher\instances\`. Then play directly on that downloaded repo. You can make your own local branch to save your local progress or just use git stash. This allows you to pull the lastest version and do a merge locally to preserve data. I recommend using a git GUI like github desktop or Visual Studio Code.
+
+#### Windows
+Run these commands. Be sure to enter in the path to your instance folder.
+
+Install git:
+```
+winget install git.git
+```
+Use git to download Clientpack
+```
+git clone https://gitea.emblad.com/samsonsin/Gregtech-New-Bastards "<PATH-TO-PRISMLAUNCHER\INSTANCES>\Gregtech-New-Bastards"
+```
+
+## 🛠 Modifications
+
+### Server Mods
+- [sharedprospecting](https://github.com/Lyfts/SharedProspecting/releases/download/2.0.3/sharedprospecting-2.0.3.jar)
+- [worldedit](https://github.com/GTNewHorizons/worldedit-gtnh/releases/download/v0.0.8/worldedit-v0.0.8.jar)
+- [Dynmap](https://github.com/GTNewHorizons/GTNH-Web-Map/releases/download/0.3.39/gtnh-web-map-0.3.39.jar)
+- [FancyDiscord](https://www.curseforge.com/minecraft/mc-mods/fancydiscord/files/all?page=1&pageSize=20&version=1.7.10)
+
+### Client Mods
+- [better-foliage](https://www.curseforge.com/minecraft/mc-mods/better-foliage)
+- [itemphysic-lite](https://www.curseforge.com/minecraft/mc-mods/itemphysic-lite)
+- [mAtmos](https://www.curseforge.com/minecraft/mc-mods/matmos)
+- [nofog](https://www.curseforge.com/minecraft/mc-mods/nofog)
+- [extreme-sound-muffler-legacy](https://www.curseforge.com/minecraft/mc-mods/extreme-sound-muffler-legacy)
+- [Sound-Physics](https://github.com/mist475/Sound-Physics)
+- [DynamicSurroundings](https://github.com/mist475/DynamicSurroundings)
+- [DEConfig-Integration](https://github.com/Drathonix/DEConfig-Integration)
+- [WorldEditCUI](https://www.curseforge.com/minecraft/mc-mods/worldeditcui-forge-edition/download/2390420)
+- [Journeymap Unlimited](https://www.curseforge.com/minecraft/mc-mods/journeymap/download/6114229)
+
+### 🎨 Resource Packs & Shaders
+- [Faithful x32](https://wiki.gtnewhorizons.com/wiki/Resource_Packs)
+- [Complementary Shaders (Sampsa's discord version)](https://wiki.gtnewhorizons.com/wiki/Shaders)
+
+---