Skip to content
This repository was archived by the owner on Nov 28, 2025. It is now read-only.

Commit 0e57130

Browse files
committed
update README to match modrinth body
1 parent 1f7850e commit 0e57130

File tree

2 files changed

+62
-16
lines changed

2 files changed

+62
-16
lines changed

README.md

Lines changed: 61 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,67 @@
22

33
The mod for Axolotlclient.
44

5-
## Features
6-
Features currently include:
7-
- Various HUD modules
8-
- Badges for players using the mod
9-
- Custom Skies (any known format)
10-
- Configurable Zoom
11-
- Hypixel Mods
12-
- AutoGG
13-
- AutoTip
14-
- LevelHead
15-
- AutoBoop
16-
- A complete config API for addon modules
17-
- Discord RPC with in-game activity support
18-
19-
- in total > 200 options
5+
AxolotlClient is your customizable alternative to popular pvp clients, such as Lunar and Badlion.
6+
7+
Our goal is to create a better environment for everyone, including you, the user.
8+
9+
You should be in charge to decide what mods you want to use, and what data is sent to other people's servers (The only thing we use is your public UUID). This is only achievable through making everything open-source (You probably know what this means as you're currently using an open-source platform).
10+
11+
With AxolotlClient you are deciding what to use and what not. Every aspect of the mod is toggleable in over 200 options.
12+
Features
13+
14+
Custom Skies (all formats)
15+
Discord RPC
16+
Player Badges
17+
HUD modules
18+
Ping
19+
FPS
20+
CPS
21+
Keystrokes
22+
Speed
23+
Scoreboard
24+
and others...
25+
Hypixel mods
26+
LevelHead
27+
AutoGG
28+
AutoTip
29+
AutoBoop
30+
NickHider
31+
Zoom
32+
Time Changer
33+
Custom Block Outlines
34+
Motion Blur
35+
Fullbright
36+
37+
Even better: Since we rely on existing mod loaders, you are able to add your own mods as well, even when using our custom launcher.
38+
39+
A little overview of options is available in the Gallery
40+
41+
For more information take a look at our Website or visit our discord server.
42+
Dependencies
43+
44+
Before downloading, please also download the respective API package for your version:
45+
46+
1.8.9 requires Legacy Fabric API
47+
1.16 (TBD) requires Fabric API
48+
1.19+ requires QSL
49+
50+
Disclaimers
51+
52+
I do not endorse nor support cheats/hacks. If you feel like one or more options packaged by this mod could be regarded as one of the above, please let us know and we'll remove the said options.
53+
54+
A pvp client in the context used above are launcher + game modifications combinations widely used on popular servers such as Hypixel and others. This is not meant in the context of cheats and/or hacks.
55+
56+
This mod is part of a larger package, which is available in our launcher (and soon also modpack). Since some people wished for it separately, it is also released here. All the other mods available and/or downloaded are respective property of their authors. We do not intend to infringe any copyright. If you are the author of a mod used by us and wish for it to be removed, please let us know.
57+
58+
To connect with things said above, the only thing that gets sent to our server is your public Minecraft account UUID. It will not be stored longer than one game session (from when you connect to a server/start a lan server to when you close the game). If you wish for your data to be deleted if it, for any instance has gotten to lure around the server longer, please also let us know and we will follow your request as soon as possible.
59+
Credits
60+
61+
Credit to these wonderful people who create open-source mods.
62+
63+
DarkKronicle, the creator of KronHUD on which the hud modules in this mod are based.
64+
65+
AMereBagatelle, the author of the wonderful FabricSkyBoxes mod.
2066

2167
### Licensing
2268
This mod (and all of its branches) is licensed under the LGPL 3 (or later). This means you need to give credit to the authors of the code you use in your own project.

src/main/java/io/github/axolotlclient/config/ConfigManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ private static JsonObject getConfig(JsonObject object, OptionCategory category){
6262
public static void load() {
6363

6464
try {
65-
JsonObject config = new JsonParser().parse(new FileReader(confPath.toString())).getAsJsonObject();
65+
JsonObject config = JsonParser.parseReader(new FileReader(confPath.toString())).getAsJsonObject();
6666

6767
for(OptionCategory category:categories) {
6868
setOptions(config.get(category.getName()).getAsJsonObject(), category);

0 commit comments

Comments
 (0)