aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoringlettronald <inglettronald@gmail.com>2023-07-03 05:03:48 -0500
committeringlettronald <inglettronald@gmail.com>2023-07-03 05:03:48 -0500
commit58b0f74fd9747002f734a025862b64f236534bd1 (patch)
treedf563103a6760dd7cb99a128f99a682810af977b /README.md
parentec276d4a14735d3c69f7bb62f3389705c8b07e15 (diff)
downloadDulkirMod-Fabric-58b0f74fd9747002f734a025862b64f236534bd1.tar.gz
DulkirMod-Fabric-58b0f74fd9747002f734a025862b64f236534bd1.tar.bz2
DulkirMod-Fabric-58b0f74fd9747002f734a025862b64f236534bd1.zip
Fleshed out Readme a bit more
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 45 insertions, 6 deletions
diff --git a/README.md b/README.md
index 68df016..9d3e1e9 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
# DulkirMod-Fabric
+[![discord badge](https://img.shields.io/discord/819011720001224735?label=discord&color=9089DA&logo=discord&style=for-the-badge)](https://discord.gg/WnJwrNZQSn)
+[![twitch](https://img.shields.io/twitch/status/dulkir?style=for-the-badge)](https://www.twitch.tv/dulkir)
Future home of dulkirmod for modern versions of minecraft.
@@ -8,11 +10,48 @@ DulkirMod 1.8.9 Can be found [here](https://github.com/inglettronald/DulkirMod).
<summary>
<b>Currently Implemented Features</b>
</summary>
-
- -Toggle Reverse third person
- -Expandable Chat Macros with Keybindings
- -Dynamic Key
- -Config Menu Backend and Front End
- -Scrollable Toolips with Zoom Option
+<ul>
+ <li>Toggle Reverse third person</li>
+ <li>Expandable Chat Macros with Keybindings</li>
+ <li>Dynamic Key</li>
+ <li>Config Menu Backend and Front End</li>
+ <li>Scrollable Toolips with Zoom Option, compatible with inventory scaling</li>
+ <li>Inventory Scaling, supports any float</li>
+ <li>Command aliases</li>
+ <li>WireFrame and World Text Rendering (needs a recoding)</li>
+ <li>Abiphone DND</li>
+ <li>Custom Selected Block outline</li>
+</ul>
+</details>
+
+<details>
+ <summary>
+ <b>Planned</b>
+ </summary>
+ <ul>
+ <li>Most features from DulkirMod 1.8.9</li>
+ <li>Starred Mob Outlines in Dungeons</li>
+ <li>A more thorough Rendering library to support the expandability of this mod</li>
+ <li>Waypoints (coming soon!)</li>
+ <li>OldAnimations AND customAnimations</li>
+ <li>Etherwarp display</li>
+ </ul>
+</details>
+
+<details>
+ <summary>
+ <b>Suggestions</b>
+ </summary>
+ Please feel free to drop any suggestions for stuff to add to this mod over in my discord, linked above! I think I
+ usually have a good understanding of what mod features need coding, but I'm always open to ideas.
+</details>
+
+<details>
+ <summary>
+ <b>Contributing</b>
+ </summary>
+ Contributions are welcome! The best way to do this is to create a fork of this repository and suggest changes through
+ a pull request on GitHub. Read more about contributions and pull requests <a href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork">here</a>.
+ My discord dms are also publicly open if you have further questions.
</details> \ No newline at end of file