aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 31d98ef0724b91c5e8cdd3e3a5311983395b0afe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# 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.

## Beta 1.0 will be available on **JULY 31st**! You are welcome to compile stuff before this but there is more that will be added before the first beta :)

DulkirMod 1.8.9 Can be found [here](https://github.com/inglettronald/DulkirMod).

<details>
    <summary>
        <b>Currently Implemented Features</b>
    </summary>

<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>
  <li>Inactive Effigy Waypoints (rift)</li>
  <li>Custom Held Item Placement/Animations</li>
  <li>Glow Utility (ESP Toggle currently broken on AMD, HMU if you're a wizard with OpenGL and feel inclined to help)</li>
  <li>Cooldown Tracking through Durability Display (Working for some sound cooldowns, need to input some data)</li>
  <li>NO DOWNTIME alarm. Plays Iphone alarm if you stop moving after a certain amount of time.</li>
  <li>Large Explosion Particle render toggle</li>
  <li>Hide Scoreboard Numbers</li>
  <li>Arachne Spawn Timer and Keeper Waypoints</li>
  <li>Hide Hunger Display option</li>
  <li>AOTV Etherwarp display</li>
  <li>Action Bar HUD replacements (HEALTH, MANA, DEF, SPEED)</li>
</ul>
</details>

<details>
    <summary>
        <b>Planned</b>
    </summary>
    <ul>
      <li>Most features from DulkirMod 1.8.9</li>
      <li>Lots more Rendering Utility</li>
      <li>OldAnimations ??</li>
      <li>Etherwarp display</li>
      <li>HUD for health, Mana, Speed</li>
      <li>A lot more I'm forgetting about</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>

## For Users
Opening the settings menu can be achieved through the escape menu or through the `/dulkir` command.

Editing HUD positioning makes use of the [JARVIS API](https://github.com/romangraef/jarvis). This library is still in development, but is a fantastic library for a common HUD element editor.
This allows multiple mods to handle the rendering on their own, but have the positioning logic be handled in one place.

Use the command `/jarvis gui` to access the main editor.