Skip to content

Commit a136be6

Browse files
authored
Update README.md
Restore readme, with a few updates
1 parent 42ece7b commit a136be6

File tree

1 file changed

+45
-44
lines changed

1 file changed

+45
-44
lines changed

README.md

+45-44
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,46 @@
11
# QudUX
2-
This is a fork of [QudUX-2](https://github.com/egocarib/CavesOfQud-QudUX-v2?tab=readme-ov-file) by Egocarib, I am slowly going through errors the game encounters when trying to load the original mod. When it is done, I'll either do a merge request on the original repo or push this project on steam workshop
3-
4-
See the readme of the [original repo](https://github.com/egocarib/CavesOfQud-QudUX-v2?tab=readme-ov-file) for informations about the mod
5-
6-
## Current status
7-
[You can check my detailed backlog here](https://docs.google.com/spreadsheets/d/16rI_opbPRsOl2Sx3e1c27gCGqyPemlzmNi4WafpfYn8/edit?usp=sharing)
8-
<br>Below, an non exhaustive summary
9-
10-
### Screens
11-
✔ Inventory screen<br>
12-
✔ Cooking with ingredients screen <br>
13-
✔ Cooking with Recipe screen<br>
14-
✔ Autoget settings screen<br>
15-
✔ Character sprite picker screen<br>
16-
✔ Score screen<br>
17-
✔ Enhanced game details screen<br>
18-
19-
### Other
20-
✔ Quest Giver location markers<br>
21-
✔ Restocker / Merchants additional dialog <br><br>
22-
✔ Mark legendary to journal + auto marking hotkey
23-
24-
25-
### Patches
26-
This is just somewhat of a backlog. You'll see right there what I still have to work on
27-
28-
✔ Patch_XRL_Annals_QudHistoryFactory<br>
29-
✔ Patch_XRL_UI_AbilityManager<br>
30-
✔ Patch_XRL_World_Parts_Mutation_MagneticPulse<br>
31-
✔ Patch_XRL_Core_XRLCore<br>
32-
✔ Revamped UI text inventory<br>
33-
✔ Patch_XRL_Core_Scores<br><br>
34-
✔ Patch_XRL_World_Parts_Campfire<br>
35-
✔ Patch_XRL_World_GameObject_Move<br>
36-
✔ Patch_XRL_World_Parts_Physics<br>
37-
✔ Patch_XRL_UI_Look<br><br>
38-
39-
40-
### Unnecessary
41-
Those scripts are not necessary since it appears their features is covered elsewhere, either by vanilla or by other parts of the mod.
42-
43-
🗑️ Patch_XRL_UI_ConversationUI<br>
44-
🗑️ Patch_XRL_UI_CreateCharacter<br>
45-
🗑️ Patch_XRL_World_Parts_Description<br>
2+
3+
QudUX 2.0 is the successor to the [original QudUX](https://github.com/egocarib/CavesOfQud-QudUX-v1) mod for Caves of Qud. It has been completely re-written from the ground up.
4+
5+
All features can now be individually toggled on or off in the Options menu.
6+
7+
![cover image](QudUX_Cover.png)
8+
9+
Features
10+
---------
11+
- Mark legendary creatures in your journal through Look or interaction menu. [`GIF preview`](https://i.imgur.com/2VMiWLb.gif)
12+
- And view their recorded faction relationships in the journal entry.
13+
- You can also batch mark all legendaries you know about on the current screen.
14+
- Find village quest givers more easily (conversation [`PNG preview`](https://i.imgur.com/BlUTRuY.png) an visual effect [`GIF preview`](https://i.imgur.com/5uez0p5.gif))
15+
- Ask traders when they'll restock in a lore-friendly dialog [`PNG preview`](https://i.imgur.com/PVhW7Ks.png)
16+
- Choose **any** sprite for your character - during character creation, by keybind, or by wish. [`GIF preview`](https://i.imgur.com/Gkhl5BO.gif)
17+
- "During character creation" workflow no longer supported at the current time. May be added back later.
18+
- Manage inventory in a revamped text console UI inventory screen [`video preview`](https://youtu.be/kmBPPIo_6Ig)
19+
- Rearrage item categories on different tabs
20+
- View item value-per-pound with a button toggle
21+
- Do your cooking in brand new text console UI cooking screens [`video preview`](https://youtu.be/pYr_74r5_V4)
22+
- Brand new UI for *Choose ingredients to cook with*
23+
- Brand new UI for *Cook from a recipe*
24+
- See ability descriptions and willpower-adjusted cooldown details for **all** activated abilities on the abilities screen [`GIF preview`](https://i.imgur.com/qdwLXIU.gif)
25+
- This only works in "classic" UI mode. The game's "modern" ability UI has been significantly improved since this feature was added.
26+
- Disable auto-pickup for specific items through item interaction menu, such as ape pelts or HE Missiles [`PNG preview`](https://i.imgur.com/eo9ZwF2.png)
27+
- Get particle text indicators when you're blocked at a zone border or when you've paused before entering deep/dangerous liquids [`GIF preview`](https://i.imgur.com/7jHm9N7.gif)
28+
- Optionally, prevent pulsed field magnets from ripping your items away. This option is off by default.
29+
30+
Install
31+
-------
32+
The mod can be installed directly from this repository by downloading the code and following [these mod installation instructions](https://cavesofqud.gamepedia.com/Modding:Installing_a_mod#Manual_Download).
33+
34+
It is also available on the Steam workshop: https://steamcommunity.com/sharedfiles/filedetails/?id=1804499742
35+
36+
Technical Notes
37+
---------------
38+
QudUX 2.0 now relies primarily on Harmony injection to make its modifications, which is a far simpler (and more performant) framework than the Unity MonoBehavior polling that was previously used. Caves of Qud supports Harmony injection natively; Harmony is packaged with the game executable.
39+
40+
Previous / Removed Features
41+
---------------------------
42+
- Automatically track visited locations in your journal (green checkmark or grey questionmark) [`PNG preview`](https://i.imgur.com/7EjlkMb.png)
43+
- (base game now has this feature built-in)
44+
- Preview your builds in a revamped text console UI build library [`GIF preview`](https://i.imgur.com/rWVgJdo.gif)
45+
- Enjoy a unique, dedicated sprite for arrows [`PNG preview`](https://i.imgur.com/9XGyjFZ.png)
46+
- A sprite was added to the base game for this

0 commit comments

Comments
 (0)