Skip to content

Commit

Permalink
Updated the description and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MehradN committed Jul 1, 2023
1 parent 3bf4fea commit 7eea590
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# Cave Survey
This Minecraft mod adds cave maps to the game. These maps use a 3D path-finding algorithm to deliver accurate maps even on slopes and complicated cave systems. This mod is powered by the [Polymer](https://github.com/Patbox/polymer) library, so you aren't required to install any resource pack or client mod.
[![GitHub Repo stars](https://img.shields.io/github/stars/MehradN/CaveSurvey?style=flat-square&logo=github&label=github)](https://github.com/MehradN/CaveSurvey)
[![Modrinth Downloads](https://img.shields.io/modrinth/dt/cave-survey?style=flat-square&logo=modrinth&label=modrinth)](https://modrinth.com/mod/cave-survey)
[![CurseForge Downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.cfwidget.com%2F852151&query=%24.downloads.total&style=flat-square&logo=curseforge&logoColor=orange&label=curseforge&color=pink)](https://www.curseforge.com/minecraft/mc-mods/cave-survey)
[![Discord](https://img.shields.io/discord/1124688511358992426?style=flat-square&logo=discord&label=discord)](https://discord.gg/8ZbPdJ7SJd)

If you want to install this mod on a server, make sure to check the [Installation Guide](https://github.com/MehradN/CaveSurvey/wiki/Installation-Guide).
Cave Survey adds advanced cave maps to Minecraft. These maps use a 3D path-finding algorithm to deliver accurate maps even on slopes and complicated cave systems. This mod is powered by the [Polymer](https://github.com/Patbox/polymer) library, so you aren't required to install any resource pack or client mod.

If you want to install this mod on a server, make sure to check the [Installation Guide](https://github.com/MehradN/CaveSurvey/wiki/Installation-Guide). <br>
You can find information about the item interactions at the [wiki](https://github.com/MehradN/CaveSurvey/wiki).

![Map of an ancient city](https://raw.githubusercontent.com/MehradN/CaveSurvey/master/screenshots/Ancient%20City.png)

## Contact Me
You can contact me about the mod via [GitHub issues](https://github.com/MehradN/CaveSurvey/issues) or [Discord](https://discord.gg/8ZbPdJ7SJd). Please prioritize using GitHub for reporting bugs and problems and suggestions. Feel free to contact me in Discord if you have questions or suggestions.
2 changes: 1 addition & 1 deletion client/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "cave-survey-client",
"version": "${version}",
"name": "Cave Survey Client",
"description": "This mod adds some client features for the Cave Survey mod.",
"description": "Optional client-side mod for playing on servers with Cave Survey installed on them",
"authors": [
"Mehrad Nayyeri"
],
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "cave-survey",
"version": "${version}",
"name": "Cave Survey",
"description": "This mod adds cave maps to the game.",
"description": "Advanced cave maps based on 3D path-finding",
"authors": [
"Mehrad Nayyeri"
],
Expand Down

0 comments on commit 7eea590

Please sign in to comment.