MineLittlePony/README.md

# Mine Little Pony

[![Current Version](https://img.shields.io/github/v/release/MineLittlePony/MineLittlePony)](https://github.com/MineLittlePony/MineLittlePony/releases/latest)
[![Build Status](https://github.com/MineLittlePony/MineLittlePony/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/MineLittlePony/MineLittlePony/actions/workflows/gradle-build.yml)
![Downloads](https://img.shields.io/github/downloads/MineLittlePony/MineLittlePony/total.svg?color=yellowgreen)
[![Modrinth](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.modrinth.com%2Fv2%2Fproject%2Fmine-little-pony%2Fversion&query=%24%5B0%5D.version_number&label=modrinth)](https://modrinth.com/mod/mine-little-pony)
[![Discord Server](https://img.shields.io/discord/182490536119107584.svg?color=blueviolet)](https://discord.gg/HbJSFyu)
![License](https://img.shields.io/github/license/MineLittlePony/MineLittlePony)
[![Crowdin](https://badges.crowdin.net/mine-little-pony/localized.svg)](https://crowdin.com/project/mine-little-pony)
![](https://img.shields.io/badge/api-fabric-orange.svg)

Turns players and mobs into ponies.

https://minelittlepony-mod.com

## Building

1. JDK 17 is required. Install it using https://adoptium.net/?variant=openjdk17&jvmVariant=hotspot

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`.

## Installation

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.

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.

**Remember to use the fabric launcher profile when starting the game!**

## Maven

Stable Releases Channel: `https://repo.minelittlepony-mod.com/maven/release`

Unstable Snapshot Channel: `https://repo.minelittlepony-mod.com/maven/snapshot`

Dependency: `com.minelittlepony:minelittlepony:<version>`
Add a readme 2016-05-17 10:00:26 +02:00			`# Mine Little Pony`

Update readme: show release version instead of tag version 2023-05-30 21:25:45 +02:00			`[![Current Version](https://img.shields.io/github/v/release/MineLittlePony/MineLittlePony)](https://github.com/MineLittlePony/MineLittlePony/releases/latest)`
Fix the build status badge 2021-12-04 14:44:10 +01:00			`[![Build Status](https://github.com/MineLittlePony/MineLittlePony/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/MineLittlePony/MineLittlePony/actions/workflows/gradle-build.yml)`
Update README.md 2019-06-13 14:33:48 +02:00			`![Downloads](https://img.shields.io/github/downloads/MineLittlePony/MineLittlePony/total.svg?color=yellowgreen)`
Add modrinth badge 2023-07-24 22:41:16 +02:00			`[![Modrinth](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.modrinth.com%2Fv2%2Fproject%2Fmine-little-pony%2Fversion&query=%24%5B0%5D.version_number&label=modrinth)](https://modrinth.com/mod/mine-little-pony)`
Update README.md 2019-06-13 14:33:48 +02:00			`[![Discord Server](https://img.shields.io/discord/182490536119107584.svg?color=blueviolet)](https://discord.gg/HbJSFyu)`
Update README.md 2021-06-21 01:14:20 +02:00			`![License](https://img.shields.io/github/license/MineLittlePony/MineLittlePony)`
Update README.md 2024-04-09 14:31:18 +02:00			`[![Crowdin](https://badges.crowdin.net/mine-little-pony/localized.svg)](https://crowdin.com/project/mine-little-pony)`
Update README.md 2019-06-13 14:33:48 +02:00			`![](https://img.shields.io/badge/api-fabric-orange.svg)`
Badges are fum 2019-06-01 10:26:35 +02:00
Add a readme 2016-05-17 10:00:26 +02:00			`Turns players and mobs into ponies.`

Use https 2020-01-30 21:51:10 +01:00			`https://minelittlepony-mod.com`
Update README.md 2018-08-20 21:51:26 +02:00
			`## Building`

Revert "Update README.md" This reverts commit 3978ace41c003964085454276cb2b6e8c75d7b59. 2021-11-27 17:49:33 +01:00			`1. JDK 17 is required. Install it using https://adoptium.net/?variant=openjdk17&jvmVariant=hotspot`
Update README.md 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`.
Update README.md 2019-06-13 14:33:48 +02:00
Update README.md 2021-11-27 17:45:42 +01:00			`## Installation`
Update README.md 2019-06-13 14:33:48 +02:00
Update README.md 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.`
Update README.md 2019-06-13 14:33:48 +02:00
Update README.md 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.`
Update README.md 2019-06-13 14:33:48 +02:00
Update README.md 2021-11-27 17:45:42 +01:00			`Remember to use the fabric launcher profile when starting the game!`
Update README.md 2019-06-13 14:40:41 +02:00
Update README.md 2021-11-27 17:45:42 +01:00			`## Maven`
Slightly better instructions 2020-04-29 11:24:22 +02:00
			Stable Releases Channel: `https://repo.minelittlepony-mod.com/maven/release`
F****ng markdown 2020-04-29 11:24:43 +02:00
Slightly better instructions 2020-04-29 11:24:22 +02:00			Unstable Snapshot Channel: `https://repo.minelittlepony-mod.com/maven/snapshot`

Updated dependency maven path in readme 2022-11-11 09:00:19 +01:00			Dependency: `com.minelittlepony:minelittlepony:<version>`