MineLittlePony/README.md

42 lines
1.8 KiB
Markdown
Raw Normal View History

2016-05-17 10:00:26 +02:00
# Mine Little Pony
2021-06-21 01:14:20 +02:00
[![Build Status](https://travis-ci.org/MineLittlePony/MineLittlePony.svg?branch=1.17)](https://travis-ci.org/MineLittlePony/MineLittlePony)
2019-06-13 14:33:48 +02:00
![Downloads](https://img.shields.io/github/downloads/MineLittlePony/MineLittlePony/total.svg?color=yellowgreen)
[![Discord Server](https://img.shields.io/discord/182490536119107584.svg?color=blueviolet)](https://discord.gg/HbJSFyu)
2021-06-21 01:14:20 +02:00
![License](https://img.shields.io/github/license/MineLittlePony/MineLittlePony)
2019-06-13 14:33:48 +02:00
![](https://img.shields.io/badge/api-fabric-orange.svg)
2019-06-01 10:26:35 +02:00
2016-05-17 10:00:26 +02:00
Turns players and mobs into ponies.
2020-01-30 21:51:10 +01:00
https://minelittlepony-mod.com
2018-08-20 21:51:26 +02:00
## Building
1. JDK 17 is required. Install it using https://adoptium.net/?variant=openjdk17&jvmVariant=hotspot
2018-08-20 21:51:26 +02:00
2. Open a terminal window in the same directory as the sources (git clone or extracted from zip). Run the following command (windows).
```
gradlew build
```
3. After some time, the built mod will be in `/build/libs`.
2019-06-13 14:33:48 +02:00
2021-11-27 17:45:42 +01:00
## Installation
2019-06-13 14:33:48 +02:00
2021-11-27 17:45:42 +01:00
Fabric (And FabricAPI) are required. Please refer to their installation instructions <a href="https://fabricmc.net">here</a> and come back once you have Fabric functioning.
2019-06-13 14:33:48 +02:00
2021-11-27 17:45:42 +01:00
Once you have fabric installed, simply download the MineLittlePony-version.jar for your particular version from [the releases page](https://github.com/MineLittlePony/MineLittlePony/releases) and place it into your mods folder next to the fabric-api jar and (optionally) the hdskins jar.
2019-06-13 14:33:48 +02:00
2021-11-27 17:45:42 +01:00
**Remember to use the fabric launcher profile when starting the game!**
2019-06-13 14:40:41 +02:00
2021-11-27 17:45:42 +01:00
## Maven
2020-04-29 11:24:22 +02:00
Stable Releases Channel: `https://repo.minelittlepony-mod.com/maven/release`
2020-04-29 11:24:43 +02:00
2020-04-29 11:24:22 +02:00
Unstable Snapshot Channel: `https://repo.minelittlepony-mod.com/maven/snapshot`
Dependency: `com.minelittlepony:MineLittlePony:<version>-1.15.2`
Check [releases](https://github.com/MineLittlePony/MineLittlePony/releases) for the most recent release version or the `gradle.properties` for most recent snapshot version.