amy/almostunified
1
0
Fork 0
mirror of https://github.com/AlmostReliable/almostunified.git synced 2024-11-23 16:18:24 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme for modrinth, add wiki and credits

Browse source
This commit is contained in:
Relentless 2022-08-21 19:47:29 +02:00
parent e37f590800
commit 802fb18106
No known key found for this signature in database
GPG key ID: 759D97B8C6F25265
1 changed files with 29 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
README.md
View file

@ -1,56 +1,61 @@
<div align="center">
<h1>Almost Unified</h1>
A [Minecraft] mod which aims to unify materials.
A [Minecraft] mod to unify resources.
[![Version][version_badge]][version_link]
[![Total Downloads][total_downloads_badge]][curseforge]
[![Total Downloads CF][total_downloads_cf_badge]][curseforge]
[![Total Downloads MR][total_downloads_mr_badge]][modrinth]
[![Workflow Status][workflow_status_badge]][workflow_status_link]
[![License][license_badge]][license]
[Discord] | [CurseForge]
[Discord] | [Wiki] | [CurseForge] | [Modrinth]
</div>
## **🔧 Manually Installation**
1. Download the latest **mod jar** from [CurseForge] or the latest [releases].
## **🔧 Manual Installation**
1. Download the latest **mod jar** from the [releases], from [CurseForge] or [Modrinth].
2. Install Minecraft [Forge] or [Fabric].
3. Drop the mod **jar** into your mods folder.
3. Drop the **jar file** into your mods folder.
## **🖥️ Setup dev environment**
- Clone the repository
- Import into Intellij (VSCode and Eclipse are not tested, we recommend using Intellij)
- Run
- `gradle -> common -> Tasks -> genSources`
- `gradle -> fabric -> Tasks -> genSources`
- `gradle -> forge -> Tasks -> forgegradle runs -> genIntellijRuns`
- Have fun!
## **🖥️ Dev Environment Setup**
1. Clone the repository
2. Import into IntelliJ (VSCode and Eclipse are not tested)
3. Run
- `gradle -> common -> Tasks -> fabric -> genSources`
- `gradle -> fabric -> Tasks -> fabric -> genSources`
- `gradle -> forge -> Tasks -> forgegradle runs -> genIntellijRuns`
4. restart the IDE
The `common` module uses `fabric-loom`, this makes it possible to use parchment. Please do not use fabric related features in the `common` module.
The `common` module uses [fabric-loom]. This makes it possible to use [ParchmentMC][parchment].<br>
Do not use Fabric related features in the `common` module!
## **💚 Credits**
This project is using the [MultiLoader Template] from [Jared].
This project is using the [MultiLoader Template] by [Jared].<br>
The logo was made by [mo_shark].
## **🎓 License**
This project is licensed under the [GNU Lesser General Public License v3.0][license].
<!-- Badges -->
[version_badge]: https://img.shields.io/github/v/release/AlmostReliable/almostunified?style=flat-square
[version_badge]: https://img.shields.io/github/v/release/AlmostReliable/almostunified?include_prereleases&style=flat-square
[version_link]: https://github.com/AlmostReliable/almostunified/releases/latest
[total_downloads_badge]: http://cf.way2muchnoise.eu/full_633823.svg?badge_style=flat
[workflow_status_badge]: https://img.shields.io/github/workflow/status/AlmostReliable/almostunified/CI?style=flat-square
[total_downloads_cf_badge]: http://cf.way2muchnoise.eu/full_633823.svg?badge_style=flat
[total_downloads_mr_badge]: https://img.shields.io/badge/dynamic/json?style=flat-square&color=5da545&label=modrinth&query=downloads&url=https://api.modrinth.com/api/v1/mod/sdaSaQEz
[workflow_status_badge]: https://img.shields.io/github/workflow/status/AlmostReliable/almostunified/Build?style=flat-square
[workflow_status_link]: https://github.com/AlmostReliable/almostunified/actions
[license_badge]: https://img.shields.io/github/license/AlmostReliable/almostunified?style=flat-square
<!-- Links -->
[minecraft]: https://www.minecraft.net/
[discord]: https://discord.com/invite/ThFnwZCyYY
[releases]: https://github.com/AlmostReliable/almostunified/releases
[curseforge]: https://www.curseforge.com/minecraft/mc-mods/almost-unified
[wiki]: https://github.com/AlmostReliable/almostunified/wiki
[curseforge]: https://www.curseforge.com/minecraft/mc-mods/almost-unified
[modrinth]: https://modrinth.com/mod/almost-unified
[releases]: https://github.com/AlmostReliable/almostunified/releases
[forge]: http://files.minecraftforge.net/
[fabric]: https://fabricmc.net/
[changelog]: CHANGELOG.md
[multiLoader template]: https://github.com/jaredlll08/MultiLoader-Template
[jared]: https://github.com/jaredlll08
[mo_shark]: https://www.curseforge.com/members/mo_shark
[license]: LICENSE
[Jared]: https://github.com/jaredlll08
[MultiLoader Template]: https://github.com/jaredlll08/MultiLoader-Template