diff --git a/README.md b/README.md index a5d6f58..3e0eff7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Heck -.. is a Minecraft modpack for version 1.18.2 and the Forge modloader. It features a little bit of everything: Technology, magic, exploration and building / decoration mods. The primary use case for this pack is for a private server we're running for friends, fellow VTubers, and their friends. +.. is a Minecraft 1.18.2 Forge modpack. It features a little bit of everything: Technology, magic, exploration and building / decoration mods. The primary use case for this pack is for a private server we're running for friends, fellow VTubers, and their friends. *Heck* comes with a modest amount of configuration changes and [KubeJS](https://kubejs.com/) scripts that aim to make our mods work together well, fix minor issues, improve balance, change and add recipes, and most importantly unify most items and materials in the pack which would otherwise exist in multiple formats. We also have a couple of texture and localization changes to make things fit together well. @@ -16,7 +16,8 @@ The modpack is currently only available as a **self-updating** PolyMC / MultiMC - Make sure you have **Java 17** (or higher) installed on your system. You can check this by going to "Settings" in your launcher and go to "Java". When you click "Auto-detect" and a version `17.x.x` appears, you can select it here. - If not, you can download the right version from [Eclipse Temurin](https://adoptium.net/temurin/releases/), and install it. + If not, you can download the right [Eclipse Temurin](https://adoptium.net/temurin/releases/) version, and install it. + These are an alternative to the "official" Oracle Java releases, though I recommend them. - To add *Heck* to the launcher, click "Add Instance", select "Import from zip", and paste this: [`https://meowface.org/copygirl/Heck.zip`](https://meowface.org/copygirl/Heck.zip) - On first launch, [packwiz] will download all mods and other modpack files. @@ -29,7 +30,7 @@ The modpack is currently only available as a **self-updating** PolyMC / MultiMC ## Server Setup -Grab the latest [packwiz bootstrapper](https://github.com/packwiz/packwiz-installer-bootstrap/releases) and [Forge installer](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.18.2.html) (recommended version can be found in the [`pack.toml`](pack.toml)) and you can install the server a little something like this: +Grab the latest [packwiz bootstrapper](https://github.com/packwiz/packwiz-installer-bootstrap/releases) and [Forge installer](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.18.2.html) - the recommended version can be found in our [`pack.toml`](pack.toml). The entire installation process on the server side will look a little something like the following, assuming you have Java 17 ready and set up as the default. Otherwise just point any of the `java` commands to the correct executable. ```sh # Download the required bootstrapper and installer. @@ -55,12 +56,11 @@ Working on the modpack requires the [packwiz] tool, so be sure to download it fi ```sh packwiz update --all # Update all mods to latest. -packwiz refresh # Run after modifying any files. -git commit -a # Now you can commit your changes.. +git commit [...] # Now you can commit your changes.. git push # ..and push them to the repository. ``` -It should be noted that packwiz will keep an `index.toml` file and update `pack.toml` to keep track of it, mirroring any changes. However, since this is more or less a build artifacts, we decided to not include it in the repository. +It should be noted that packwiz will keep an `index.toml` file and update `pack.toml` to keep track of it, mirroring any changes. However, since these changes are basically build artifacts, we decided to not include them in the repository. ```sh # Make sure git will not see any changes to pack.toml. @@ -77,5 +77,6 @@ To test changes tocally, you can run `packwiz serve` to deploy a simple webserve While the game is running, you can use `rsync` to synchronize the `kubejs/` folder after making changes. This allows you to make, for example, recipe changes and test them out in-game, without restarting, simply by running the `/reload` command. ```sh +# Just replace $PATH_TO_INSTANCE with your instance's location. rsync -r --delete kubejs $PATH_TO_INSTANCE/.minecraft ```