mirror of
https://github.com/AlmostReliable/almostunified.git
synced 2024-11-14 11:15:23 -05:00
remove readme
This commit is contained in:
rlnt
parent
d947feacbc
commit
e0649dedd7
1 changed files with 0 additions and 120 deletions
120
README.md
120
README.md
|
|
@ -1,120 +0,0 @@
|
|||
<h1 align="center">
|
||||
<a href="https://github.com/AlmostReliable/almostunified"><img src=https://i.imgur.com/3b7Gjkn.png" alt="Preview" width=200></a>
|
||||
<p>Almost Unified</p>
|
||||
</h1>
|
||||
|
||||
<div align="center">
|
||||
|
||||
A [Minecraft] mod to unify resources.
|
||||
|
||||
[![Workflow Status][workflow_status_badge]][workflow_status_link]
|
||||
[![License][license_badge]][license]
|
||||
|
||||
[![Version][version_badge]][version_link]
|
||||
[![Total Downloads CF][total_downloads_cf_badge]][curseforge]
|
||||
[![Total Downloads MR][total_downloads_mr_badge]][modrinth]
|
||||
|
||||
[![Discord][discord_badge]][discord]
|
||||
[![Wiki][wiki_badge]][wiki]
|
||||
|
||||
</div>
|
||||
|
||||
## **📖 Information**
|
||||
For an in-depth explanation of the mod, its functionality, config descriptions, FAQs and more, check out the [wiki].
|
||||
|
||||
## **🔧 Manual Installation**
|
||||
1. Download the latest **mod jar** from the [releases], from [CurseForge] or [Modrinth].
|
||||
2. Install Minecraft [Forge] or [Fabric].
|
||||
3. Drop the **jar file** into your mods folder.
|
||||
|
||||
## **🔗 Depending on the Mod**
|
||||
|
||||
### Maven
|
||||
Every release of this project is built on and published to the [BlameJared] maven.
|
||||
|
||||
```groovy
|
||||
repositories {
|
||||
maven {
|
||||
url = 'https://maven.blamejared.com'
|
||||
name = 'BlameJared Maven'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Common [![Maven][maven_common_badge]][maven_common_link]
|
||||
```groovy
|
||||
dependencies {
|
||||
modApi("com.almostreliable.mods:almostunified-common:<version>")
|
||||
}
|
||||
```
|
||||
|
||||
### Fabric [![Maven][maven_fabric_badge]][maven_fabric_link]
|
||||
```groovy
|
||||
dependencies {
|
||||
modApi("com.almostreliable.mods:almostunified-fabric:<version>")
|
||||
}
|
||||
```
|
||||
|
||||
### Forge [![Maven][maven_forge_badge]][maven_forge_link]
|
||||
```groovy
|
||||
dependencies {
|
||||
modApi(fg.deobf("com.almostreliable.mods:almostunified-forge:<version>"))
|
||||
}
|
||||
```
|
||||
|
||||
### Examples
|
||||
For code examples on how to use the API, check out the [wiki][api-wiki].
|
||||
|
||||
## **🖥️ 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 -> loom -> genSources`
|
||||
- `gradle -> Tasks -> buildconfig -> generateBuildConfig`
|
||||
4. Restart the IDE
|
||||
|
||||
The `common` module uses [fabric-loom]. This allows to use [ParchmentMC][parchment].<br>
|
||||
Do not use Fabric related features inside the `common` module!
|
||||
|
||||
## **💚 Credits**
|
||||
The logo was made by [mo_shark].
|
||||
|
||||
## **🎓 License**
|
||||
This project is licensed under the [GNU Lesser General Public License v3.0][license].
|
||||
|
||||
<!-- Badges -->
|
||||
[workflow_status_badge]: https://img.shields.io/github/actions/workflow/status/AlmostReliable/almostunified/build.yml?branch=1.19.2&style=for-the-badge
|
||||
[workflow_status_link]: https://github.com/AlmostReliable/almostunified/actions
|
||||
[license_badge]: https://img.shields.io/github/license/AlmostReliable/almostunified?style=for-the-badge
|
||||
[version_badge]: https://img.shields.io/badge/dynamic/json?color=0078FF&label=release&style=for-the-badge&query=name&url=https://api.razonyang.com/v1/github/tag/AlmostReliable/almostunified%3Fprefix=v1.19.2-
|
||||
[version_link]: https://github.com/AlmostReliable/almostunified/releases/latest
|
||||
[total_downloads_cf_badge]: https://img.shields.io/badge/dynamic/json?color=e04e14&label=CurseForge&style=for-the-badge&query=downloads.total&url=https%3A%2F%2Fapi.cfwidget.com%2F633823&logo=curseforge
|
||||
[total_downloads_mr_badge]: https://img.shields.io/modrinth/dt/sdaSaQEz?color=5da545&label=Modrinth&style=for-the-badge&logo=modrinth
|
||||
[discord_badge]: https://img.shields.io/discord/917251858974789693?color=5865f2&label=Discord&logo=discord&style=for-the-badge
|
||||
[wiki_badge]: https://img.shields.io/badge/Read%20the-Wiki-ba00ff?style=for-the-badge
|
||||
[maven_common_badge]: https://img.shields.io/maven-metadata/v?color=C71A36&label=Latest%20version&logo=Latest%20version&metadataUrl=https%3A%2F%2Fmaven.blamejared.com%2Fcom%2Falmostreliable%2Fmods%2Falmostunified-common%2Fmaven-metadata.xml&style=flat-square
|
||||
[maven_common_link]: https://maven.blamejared.com/com/almostreliable/mods/almostunified-common/
|
||||
[maven_fabric_badge]: https://img.shields.io/maven-metadata/v?color=C71A36&label=Latest%20version&logo=Latest%20version&metadataUrl=https%3A%2F%2Fmaven.blamejared.com%2Fcom%2Falmostreliable%2Fmods%2Falmostunified-fabric%2Fmaven-metadata.xml&style=flat-square
|
||||
[maven_fabric_link]: https://maven.blamejared.com/com/almostreliable/mods/almostunified-fabric/
|
||||
[maven_forge_badge]: https://img.shields.io/maven-metadata/v?color=C71A36&label=Latest%20version&logo=Latest%20version&metadataUrl=https%3A%2F%2Fmaven.blamejared.com%2Fcom%2Falmostreliable%2Fmods%2Falmostunified-forge%2Fmaven-metadata.xml&style=flat-square
|
||||
[maven_forge_link]: https://maven.blamejared.com/com/almostreliable/mods/almostunified-forge/
|
||||
|
||||
<!-- Links -->
|
||||
[minecraft]: https://www.minecraft.net/
|
||||
[discord]: https://discord.com/invite/ThFnwZCyYY
|
||||
[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/
|
||||
[blamejared]: https://maven.blamejared.com
|
||||
[api-wiki]: https://github.com/AlmostReliable/almostunified/wiki/API
|
||||
[fabric-loom]: https://github.com/FabricMC/fabric-loom
|
||||
[parchment]: https://parchmentmc.org/
|
||||
[multiLoader template]: https://github.com/jaredlll08/MultiLoader-Template
|
||||
[jared]: https://github.com/jaredlll08
|
||||
[mo_shark]: https://www.curseforge.com/members/mo_shark
|
||||
[license]: LICENSE
|
||||
Loading…
Reference in a new issue