README.md

Header

Icon

Modify your mod's icon/logo under the src/main/resources/assets/<your mod id here>/icon.png file.

-<img alt="Example Icon" src="src/main/resources/assets/modid/icon.png" width="128">
+<img alt="Darkness Icon" src="src/main/resources/assets/darkness/icon.png" width="128">

You may also choose to minify the icon to save repository space and hence reduce your mod's file size.

Title

Choose a unique, descriptive mod title.

-# Fabric Example Mod
+# Darkness Mod

Slogan

The following line is a quick description. Keep it short!

-Lorem ipsum dolor sit amet
+You succumb to the darkness

Badges

By using Shields.io, we can add visually appealing badges. Provided are some commonly used badges, but feel free to add your own.

Release

This badge shows the latest version of your mod. It is taken directly from GitHub Releases and depends on semver versioning.

<!-- Replace "axieum/fabric-example-mod" with your own repository -->
[![Release](https://img.shields.io/github/v/release/axieum/fabric-example-mod?style=for-the-badge&include_prereleases&sort=semver)][releases]

Available For

This badge shows the latest version of Minecraft that is supported. This is taken from the latest CurseForge release.

<!-- Replace "494721" with your CurseForge project id -->
[![Available For](https://img.shields.io/badge/dynamic/json?label=Available%20For&style=for-the-badge&color=34aa2f&query=gameVersionLatestFiles%5B0%5D.gameVersion&url=https%3A%2F%2Faddons-ecs.forgesvc.net%2Fapi%2Fv2%2Faddon%2F494721)][curseforge]

Downloads

This badge shows the total number of downloads your mod has acquired on CurseForge.

<!-- Replace "494721" with your CurseForge project id -->
[![Downloads](https://img.shields.io/badge/dynamic/json?label=Downloads&style=for-the-badge&color=f16436&query=downloadCount&url=https%3A%2F%2Faddons-ecs.forgesvc.net%2Fapi%2Fv2%2Faddon%2F494721)][curseforge:files]

Body

Description

Be descriptive, let the audience know that this codebase is for a Minecraft mod and provide insight into what it does.

Darkness is a **Minecraft mod** that aims to bring prolonged nights to your
worlds. It reduces the chance of the sun rising each day to 0.01%.

Let them know if your mod is targeted at players, server owners, or both!

Both

It is built on the [Fabric][fabric] mod loader and is available for modern
versions of [Minecraft][minecraft] Java Edition.

Client-Side Only

It is a **client-side** only mod, built on the [Fabric][fabric] mod loader
and is available for modern versions of [Minecraft][minecraft] Java Edition.

Server-Side Only

It is a **server-side** only mod, built on the [Fabric][fabric] mod loader
and is available for modern versions of [Minecraft][minecraft] Java Edition.

Licence

By default, this repository applies a Creative Commons Zero (CC0) licence to itself, this ensures those who want to use this template are free to change it to suit their own projects. Check out https://choosealicense.com/ for help with picking a licence.

Be sure to update the LICENCE.txt file, any references to the CC0 licence throughout the project with the one you've picked!

Links

Be sure to update any references with your own project links. These are found at the bottom of the README.md file.:

[curseforge]: https://curseforge.com/minecraft/mc-mods/modid
[curseforge:files]: https://curseforge.com/minecraft/mc-mods/modid/files
[licence]: https://creativecommons.org/publicdomain/zero/1.0
[releases]: https://github.com/axieum/fabric-example-mod/releases