Skip to content

Update installation guides and documentation and bug fixes - #339

Open
Chaosyr wants to merge 11 commits into
mainfrom
Update-Installation-Guides-and-Documentation-and-Bug-Fixes
Open

Chaosyr wants to merge 11 commits into
mainfrom
Update-Installation-Guides-and-Documentation-and-Bug-Fixes

Conversation

@Chaosyr

@Chaosyr Chaosyr commented Oct 1, 2026

Copy link
Copy Markdown
Collaborator

This is a work in progress PR that:

  • Updates the Installation Guides
  • Updates the In-Code Documentation
  • Incorporates Bug Fixes
  • Incorporates some new features such as Custom Appearances (See the TextureHelper class.)

* Incorporate Pulsar into the Installation Guides.
* Incorporate Pulsar into the Installation Guides.
* Added more null checks into the following patches `GainGemsForOpponents`, `LoseGemsForOpponents`, `GainTripleGemsForOpponents`, `LoseTripleGemsForOpponents`.
* Removed `_specialSequencer` from `SpecialSequenceManager` as it was unused.
* Removed `FontReplacementDataInitialized` from `LocalizationManager` as it was unused.
* Added new Support for Custom Appearances.
    - Image Handling is to be handled by the mods using the API.
    - We now provide a storage of Base Game Decals that mods can reference without needing to instantiate their own.
    - This comes with 5 new Dictionaries `BaseGameCustomAppearances` (Internal), `BaseGameCustomAppearancesPublic`, `ModdedCustomAppearancesDictionary` (Internal), `ModdedCustomAppearancesDictionaryPublic`, `CombinedCustomAppearancesDictionaryPublic`.
    - This system is stored under the `TextureHelper` class.
@github-actions

github-actions Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Download the artifacts for this pull request:

* Copy over PDB and XML associated with out DLLs to the Output.
* Update BepInEx dependency.
@Chaosyr Chaosyr self-assigned this Oct 1, 2026
* Copy over License and Changelog in Builds.
* Renamed LICENSE to LICENSE.md
* First batch of work on the XML Documentation.
* Add a Saftey Check for Instantiating the Base Game Custom Appearences Dict.
* Rename Internal Configuration Key Names, namely in Community Patch to reflect their functionality.
* Updated Internal Code Versions to 2.24.2
* Moved `ResourceLookup.cs` to `InscryptionAPI.Helpers`, it was perviously listed there but not actually in the perscribed namespace. E.G. it was `InscryptionAPI.Items` instead.
* Changed the `BoardManagerExtensions` to be One-line functions rather than Multi-line. Did similar in `CardSlotExtensions` but with the function params.
* Renamed `objectFields` to `ObjectFields` within `CustomFields` under `InscryptionAPI.Helpers`
* Add Bool Overrides to the `Metalic`, `Smoothness` and `Height` fields in `MaterialOverride.cs`, along with functions for overriding each of these respective components.
* Fixed some XML Docs within `TextureHelper.cs`.
* Fixed the `TranspilerHelpers.cs`'s function to use `LogCodeInstructions` rather than the typoed `LogCodeInscryptions`.
* Completed Documentation related to the `InscryptionAPI.Helpers` classes.

Signed-off-by: Chaosyr <Thincreator3483@hotmail.com>
* Puts `SteelTrapDeathPatch.cs` under the `InscryptionAPI.Card.Patches` Namespace.
* Adds a Patch that Injects Debug Logging related to `GenerateTradeCardsWithCostTier` issues.
* Adds a Configuration for enabling the Logging.
* Adds Debug Logging for the Entiere `CardLoader.LearnedCards` List.

Signed-off-by: Chaosyr <Thincreator3483@hotmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant