diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b3ce792d0..68f872800 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ -## Proposed Changes/Fixes - - - - - - - +Fixes # +## Proposed Changes + - + - + - diff --git a/README.md b/README.md index 08a267a45..07a65fc68 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,22 @@ -![A laboratory in the Changed:MC mod.](https://i.imgur.com/fyxDLI4.png) ![Discord](https://raw.githubusercontent.com/Y1rd/Y1rd/main/discord-custom_vector.svg) ![Discord](https://raw.githubusercontent.com/intergrav/devins-badges/1aec26abb75544baec37249f42008b2fcc0e731f/assets/cozy/donate/patreon-singular_vector.svg) ![Discord](https://raw.githubusercontent.com/intergrav/devins-badges/1aec26abb75544baec37249f42008b2fcc0e731f/assets/cozy/available/modrinth_vector.svg) ![Discord](https://raw.githubusercontent.com/intergrav/devins-badges/1aec26abb75544baec37249f42008b2fcc0e731f/assets/cozy/available/curseforge_vector.svg) +

+ Mod Logo

+ + + + +

-This repository holds the source code for the **Changed: Minecraft Mod**. Releases are compiled and published to both mod hosting websites. +--- -All credits for contributors are available on [GitHub Insights](https://github.com/LtxProgrammer/Changed-Minecraft-Mod/graphs/contributors) and in the mod menu. +This repository holds the source code for the **Changed: Minecraft Mod**. Releases are compiled and published to both Modrinth and Curseforge. Credits for contributors are available on [GitHub Insights](https://github.com/LtxProgrammer/Changed-Minecraft-Mod/graphs/contributors) and in the mod menu. ## How can I help? -Any aspiring developer is welcome to fork and create a pull request to submit their content. **Programmers, texture artists, and 3D modelers** all have a place here. +Any aspiring developer is welcome to fork and create a pull request to submit their content. Programmers, texture artists, and 3D modelers all have a place here. - Textures are kept in *src/main/resources/assets/changed/textures* - Java code is in *src/main/java/net/ltxprogrammer/changed* - 3D models are kept in *src/main/java/net/ltxprogrammer/changed/client/renderer/model* -Even if **you aren't a developer**, you can help with **translations, documentation, or other simple issues**. However, any changes you make to the code or files should be on your own fork. **Create a pull request** when you are ready to submit any changes. +Even if you aren't a developer, you can help with translations, documentation, or other simple issues. However, any changes you make to the code or files should be on your own fork. Create a pull request when you are ready to submit any changes. ## How can I make my own sub-mod? First, grab the [Forge MDK](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.18.2.html), and install **Intellij**. @@ -62,7 +68,7 @@ Then add a **mod dependency** to *mods.toml*: [[dependencies.your_mod_id]] modId="changed" mandatory=true - versionRange="[0.12b]" # Replace with the version you plan to mod + versionRange="[0.13.1]" # Replace with the version you plan to mod ordering="NONE" side="BOTH" ``` @@ -71,32 +77,12 @@ Then add a **mod dependency** to *mods.toml*: You'll now have access to **all the tools** within the Changed: Minecraft Mod, good luck! -## General FAQ +## How can I compile the mod? -**Will there be a Fabric/Quilt version?** +Without a IDE and assuming you have `git` installed and Java 17 as your default java: +- Clone the repo `git clone https://github.com/LtxProgrammer/Changed-Minecraft-Mod.git` +- Navigate into the directory `cd Changed-Minecraft-Mod` +- Run Gradlew `./gradlew build` (Linux/MacOS) or `gradlew build` (Windows) +- Once completed, check builds/libs for the results. -There are no current plans to port to another modloader, this is subject to change. - -**Can you port the mod to 1.xx.x?** - -We will not be porting the mod until it is deemed complete. - -**Can you make the mod for Pocket Edition?** - -If you're asking this, you're probably too young to be getting into Changed... - -**Can the mod be used with Optifine?** - -The mod is incompatible with Optifine. We will not be fixing this due to Optifine being closed source. Please use Rubidium or Embeddium instead. - -**What mods are compatible?** - -There (hopefully) shouldn't be too many mods that are incompatible. If you do find a mod which behaves weird with Changed:MC, feel free to report it. - -**What are the special forms for?** - -Anyone who is a Tier 4 Patron get to design their own transfur variant exclusive to them, otherwise, the special syringe doesn't do anything. - -**Will I lose my special form when I'm no longer a patron?** - -No, but you will lose the in-game title and access to some discord channels. +Now you can test the latest commit of the mod, enjoy. diff --git a/images/discord-custom_vector.svg b/images/discord-custom_vector.svg new file mode 100644 index 000000000..10e44a739 --- /dev/null +++ b/images/discord-custom_vector.svg @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +