Skip to content

Commit

Permalink
Update README.md (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
seaneoo authored Nov 18, 2024
1 parent ba5676f commit 76b1a43
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 30 deletions.
Binary file added .github/assets/sgp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 29 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,29 @@
[![Modrinth Downloads](https://img.shields.io/modrinth/dt/CiE7du5Z?style=flat&logo=modrinth&logoColor=%23ffffff&label=Modrinth&color=%231bd96a)](https://modrinth.com/mod/sgp) [![CurseForge Downloads](https://img.shields.io/curseforge/dt/1138196?style=flat&logo=curseforge&logoColor=%23ffffff&label=CurseForge&color=%23ff784d)](https://www.curseforge.com/minecraft/mc-mods/sgp)

# Sean's Guinea Pigs

![](https://cdn.modrinth.com/data/CiE7du5Z/images/813ae77c09fda419b9af33a27646ef026f5e5368.jpeg)

## Mod Compatibility

Adding support for mods (or other vanilla features) is extremely easy and can be done yourself through the use of[
data packs](https://minecraft.wiki/w/Data_pack).

To add new food items, create a file named `guinea_pig_food.json` in the `data/sgp/tags/item` directory. Inside that
file you will add the identifiers of the new items.

**Note: Make sure to include `"replace": false` so the default food
items do not get overwritten by your data pack.**

```json
{
"replace": false,
"values": [
"minecraft:diamond"
]
}
```

Then package this up like a normal data pack and put it into your `worlds` folder.

If you need more assistance, you can ask for help on
the [discussions page](https://github.com/seaneoo/sgp/discussions/categories/help).
<div align="center">
<br/>
<img alt="Sean's Guinea Pigs" src=".github/assets/sgp.png" width="80%"/>
<br/>
<br/>
<a href="https://modrinth.com/mod/sgp">
<img alt="Modrinth Downloads" src="https://img.shields.io/modrinth/dt/CiE7du5Z?style=for-the-badge&logo=modrinth&logoColor=%23ffffff&labelColor=%23CEA35B&color=%23CEA35B">
</a>
&nbsp;
<a href="https://www.curseforge.com/minecraft/mc-mods/sgp">
<img alt="CurseForge Downloads" src="https://img.shields.io/curseforge/dt/1138196?style=for-the-badge&logo=curseforge&logoColor=%23ffffff&labelColor=%23CEA35B&color=%23CEA35B">
</a>
&nbsp;
<a href="https://github.com/sponsors/seaneoo">
<img alt="Support me on GitHub Sponsors" src="https://img.shields.io/badge/Support%20me%20on-GitHub-%23CEA35B?style=for-the-badge&logo=githubsponsors&logoColor=%23ffffff&labelColor=%23CEA35B&color=%23CEA35B">
</a>
<br/>
<br/>
<img alt="The seven varieties of guinea pigs from left to right: black, chocolate, classic, cream, dutch, golden, and white" src=".github/assets/showcase_banner.png" width="80%"/>
<br/>
<h2>Features</h2>
<p>
New passive and tameable animal - the Guinea Pig!<br/>
They can be found in 7 different colors.<br/>
Spawn in Windswept, Meadows, and Cherry Grove biomes.<br/>
Tame them with apples, carrots, wheat, and sweet berries.<br/>
Untamed guinea pigs will be attacked by ocelots, cats, and foxes.<br/>
</p>
</div>

0 comments on commit 76b1a43

Please sign in to comment.