BadMagic100 / TheRealJournalRando

A Hollow Knight Itemchanger addon that allows changing and randomizing additional Hunter's Journal entries
MIT License
0 stars 3 forks source link

# TheRealJournalRando

A Hollow Knight mod that adds Hunter's Journal Entries and Hunter's Notes to the randomization pool. This mod adds items and locations for every journal entry that is not included in base rando/itemchanger, with the exception of Shade, which is automatically granted as usual when gaining the Hunter's Journal.

This readme is broken into 4 major sections, ordered by importance:

Items, Costs, and Locations

This mod introduces 2 new items types, 2 new location types, and 1 new payable cost type. Each killable enemy has 2 new items and locations corresponding to unlocking the Hunter's Journal entry and completing the Hunter's notes for that enemy. Crawlids, which are normally granted automatically when gaining the Hunter's Journal, are treated the same as other enemies if any of these items or locations is placed, and require 30 kills for the Hunter's notes. Extra (non-killable) entries, including Hunter's Mark, Void Idol, and Weathered Mask, each have 1 new item and location added that corresponds to unlocking the entire entry and Hunter's notes, similar to the journal entries in base rando.

Items

Journal entry items and Hunter's notes items are provided for each killable enemy type. If both items are placed for a given enemy, they act progressively (in other words, you are guaranteed the entry before the notes). If only one item is placed, the other behaves as it would in vanilla. If only the entry item is placed, killing the normal amount of that enemy will unlock the hunter's notes text. If only the notes item is placed, you must kill one enemy of the appropriate type before viewing the entry in the journal. Regardless of which items are or are not placed, you must obtain the Hunter's journal to be able to view any entry in the journal.

Costs

This mod adds a cost which represents killing a certain number of a given enemy. All killable enemies are counted, including most Godhome bosses (more details on how this works in logic below). Godhome Nightmare King Grimm and Crystal/Enraged guardian do not count, as they don't count towards the journal entry/hunter's notes in vanilla HK. These costs can be applied on any location, though the randomizer connection only applies them to the journal entry and Hunter's notes locations.

Locations

Journal entry and Hunter's notes locations are very nearly indistinguishable aside from costs and previews. Both locations work like this:

In addition, the items and costs of the Hunter's notes location can be previewed in the notes pane of the Hunter's journal once you've obtained both the Hunter's journal and the corresponding Journal entry (either from obtaining the placed item, or by killing the appropriate enemy type if the entry is not placed). This preview is either in place of the "Defeat X more to decipher the Hunter's notes" text if you have not obtained the notes item, or after the end of the Hunter's notes if you have obtained the items.

Logic Info

Mostly, logic works how you would expect, with a few quirks to note.

Settings

When enabled with rando, this mod will provide several connection settings. More information about each is provided below, grouped by category. This mod has a large number of settings, and provides its own settings code. Clicking the button to copy the code will automatically copy the code to your clipboard, and clicking the button to apply the code will read a code on your clipboard and apply the settings.

The mod comes with some default settings enabled; I recommend these on your first playthrough to get the full experience of the mod without it being super cursed.

Basic Settings

Pool Settings

Cost Settings

Long Location Settings

Base Rando Settings

Journal rando respects several settings from base rando:

Other Mods

This mod is the first mod that provides checks which are accessible in more than one place. As such, it interacts in unique ways with many other mods which have traditionally expected that checks can only appear in a single room. This mod provides full information about scenes, titled areas, and map areas in which an enemy appears so that other mods can use that info to provide a more integrated experience.

RandoMapMod

Enemies that appear in multiple rooms appear in the bottom left corner of the world map. Each pin is marked with the corresponding enemy's icon. These icons will also appear around the edge of the quick map if the enemy appears in that area. Additionally, if pin selection (Ctrl + P) in RMM is enabled, the rooms that the enemy appears in are highlighted. You can lock the selection to scroll around the map and get a better view of the highlighted rooms.

RandoPlus

In Area Blitz, an enemy's location(s) is selected if the enemy is available in at least one of the selected map areas.

TrandoPlus

With the Remove Random Rooms setting, an enemy's location(s) is selected if at least one of its rooms is available. With the Remove Empty Rooms setting, each enemy is randomly assigned one if its rooms.

MajorItemsByAreaTracker/RandoStats

If the enemy is available in only a single map area, its locations are counted under that area. If the enemy is available in multiple map areas, its locations will be counted under "Other."

RandoSettingsManager

This connection is fully integrated with RandoSettingsManager. It does not need to be configured manually after saving/sharing/loading settings and will disable itself if no settings are available.

ItemSync

When playing with ItemSync, enemy kills are synced to count towards note costs.