Skip to content

Commit

Permalink
Update 1.21 readme to match 1.20 readme (#2193)
Browse files Browse the repository at this point in the history
  • Loading branch information
Pumpkin7266 authored Oct 19, 2024
1 parent 3d255e8 commit c10e783
Showing 1 changed file with 49 additions and 27 deletions.
76 changes: 49 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,58 @@
# GregTechCEu

<a title="Join us on Discord!" href="https://discord.gg/bWSWuYvURP"><img src="https://img.shields.io/discord/701354865217110096?label=GTCEu%20Discord&amp;logo=Discord&amp;style=?flat" alt="Discord"/></a>

GregTech based on Architectury for performing on Forge, Fabric, and Quilt, simultaneously.


## Download
[`Github Releases`](https://github.com/GregTechCEu/GregTechCEu-1.19/releases).
[`Curseforge`](https://www.curseforge.com/minecraft/mc-mods/gregtechceu-modern/files)
[`Modrinth`](https://modrinth.com/mod/gregtechceu-modern)


## Documentation / Wiki
[`Wiki`](https://gregtechceu.github.io/gtceu-modern-docs/)


## Dev Q&A
* [Todo List](https://github.com/GregTechCEu/GregTechCEu-1.19/issues/125) for potential contributors who are interested in this project
* [Dev Q&A](https://github.com/GregTechCEu/GregTechCEu-1.19/wiki/Dev-Q&A) illustrates common questions and answers related to development.


## IDE Requirements (when using IntelliJ IDEA)

For developing this mod, the [Lombok plugin](https://plugins.jetbrains.com/plugin/6317-lombok) for IntelliJ IDEA is strictly required.
<p align="center"><img src="https://github.com/user-attachments/assets/547baf4d-088b-4311-9366-80260c2d1f55" alt="Logo"></p>
<h1 align="center">GregTech CEu: Modern</h1>
<p align="center">GregTech:CEu built on modern Minecraft versions for Forge(1.20.1) & NeoForge(1.21+).</p>
<h1 align="center">
<a href="https://www.curseforge.com/minecraft/mc-mods/gregtechceu-modern"><img src="https://img.shields.io/badge/Available%20for-MC%201.20.1+%20-informational?style=for-the-badge" alt="Supported Versions"></a>
<a href="https://github.com/GregTechCEu/GregTech-Modern/blob/1.21/LICENSE"><img src="https://img.shields.io/github/license/GregTechCEu/GregTech?style=for-the-badge" alt="License"></a>
<a href="https://discord.gg/bWSWuYvURP"><img src="https://img.shields.io/discord/701354865217110096?color=5464ec&label=Discord&style=for-the-badge" alt="Discord"></a>
<br>
<a href="https://www.curseforge.com/minecraft/mc-mods/gregtechceu-modern"><img src="https://cf.way2muchnoise.eu/890405.svg?badge_style=for_the_badge" alt="CurseForge"></a>
<a href="https://modrinth.com/mod/gregtechceu-modern"><img src="https://img.shields.io/modrinth/dt/gregtechceu-modern?logo=modrinth&label=&suffix=%20&style=for-the-badge&color=2d2d2d&labelColor=5ca424&logoColor=1c1c1c" alt="Modrinth"></a>
<a href="https://github.com/GregTechCEu/GregTech-Modern/releases"><img src="https://img.shields.io/github/downloads/GregTechCEu/GregTech-Modern/total?sort=semver&logo=github&label=&style=for-the-badge&color=2d2d2d&labelColor=545454&logoColor=FFFFFF" alt="GitHub"></a>
</h1>

### [Wiki](https://gregtechceu.github.io/gtceu-modern-docs/)

## Developers

To add GTCEu: Modern (GTM) to your project as a dependency, add the following to your `build.gradle`:
```groovy
repositories {
maven {
name = 'GTCEu Maven'
url = 'https://maven.gtceu.com'
content {
includeGroup 'com.gregtechceu.gtceu'
}
}
}
```
Then, you can add it as a dependency, with `${mc_version}` being your Minecraft version target and `${gtm_version}` being the version of GTM you want to use.
```groovy
dependencies {
// Forge (see below block as well if you use Forge Gradle)
implementation fg.deobf("com.gregtechceu.gtceu:gtceu-${mc_version}:${gtm_version}")
// NeoForge
implementation "com.gregtechceu.gtceu:gtceu-${mc_version}:${gtm_version}"
// Architectury
modImplementation "com.gregtechceu.gtceu:gtceu-${mc_version}:${gtm_version}"
}
```

### IDE Requirements (when using IntelliJ IDEA)

For contributing to this mod, the [Lombok plugin](https://plugins.jetbrains.com/plugin/6317-lombok) for IntelliJ IDEA is strictly required.
Additionally, the [Minecraft Development plugin](https://plugins.jetbrains.com/plugin/8327-minecraft-development) is recommended.


## Credited Works
- Most textures are originally from the **[ZedTech GTCEu Resourcepack](https://github.com/brachy84/zedtech-ceu)**, with some changes made by the community.
- Most textures are originally from [Gregtech: Refreshed](https://modrinth.com/resourcepack/gregtech-refreshed) by @ULSTICK. With some consistency edits and additions by @Ghostipedia.
- Some textures are originally from the **[ZedTech GTCEu Resourcepack](https://github.com/brachy84/zedtech-ceu)**, with some changes made by the community.
- New material item textures by @TTFTCUTS and @Rosethorns.
- Wooden Forms, World Accelerators, and the Extreme Combustion Engine are from the **[GregTech: New Horizons Modpack](https://www.curseforge.com/minecraft/modpacks/gt-new-horizons)**.
- Primitive Water Pump is from the **[IMPACT: GREGTECH EDITION Modpack](https://gtimpact.space/)**.
- Primitive Water Pump is from the **[IMPACT: GREGTECH EDITION Modpack](https://gt-impact.github.io/#/)**.
- Ender Fluid Link Cover, Auto-Maintenance Hatch, Optical Fiber, and Data Bank Textures are from **[TecTech](https://github.com/Technus/TecTech)**.
- Steam Grinder is from **[GregTech++](https://www.curseforge.com/minecraft/mc-mods/gregtech-gt-gtplusplus)**.
- Certificate of Not Being a Noob Anymore is from **[Crops++](https://www.curseforge.com/minecraft/mc-mods/berries)**.
Expand Down

0 comments on commit c10e783

Please sign in to comment.