Skip to content

API 2.24.2 | Update installation guides and documentation and bug fixes - #339

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

Chaosyr wants to merge 205 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:

  • Updated Installation Guides to Include Pulsar Mod Manager.
  • 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.
  • Improved In-Code Documentation via XML Comments.
  • Added a way to easily patch and modify the default bone gain when a player's card dies.
  • Added the following class: DefaultBoneGainOnDeath and the following methods within that class: DefaultBoneGainOnDeath.ShouldDoDefaultBoneGain and DefaultBoneGainOnDeeath.DoDefaultBoneGain
  • Privatized several Internal Functions.
  • Rename and Reorder configs internally for clarity as to what they are for.
  • Clean up Code formatting.
  • Fix casing of some variables.
  • Implement new Material Overrides to MaterialOverride related to changing Metallic, Smoothness and Height for consistency.
  • Add OverrideQueuedBackground to the PixelCardBehaviours.
    • This is used for overriding the Queued Background of a card.
  • Upgraded the API's .csproj's, and TCLI Build system.
  • Publicized the _originalColor, _enterColor, and _selectedColor used within ActivatedAbilityIconInteractable of the Community Patch.
  • Update the API to use Latest BepInEx.
  • Bug Fix overlapping challenge icons.
  • Removed some Debug Logging.

* 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
Chaosyr and others added 8 commits September 30, 2026 22:29
* 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>
add a method interface in class PixelCardBahaviours, which allows you to override queued background of pixel cards by @chytridi05
@Chaosyr Chaosyr changed the title Update installation guides and documentation and bug fixes API 2.24.2 | Update installation guides and documentation and bug fixes Oct 30, 2026
HumabHatterZed added a commit to HumabHatterZed/InscryptionAPI that referenced this pull request Oct 30, 2026
HumabHatterZed and others added 14 commits October 30, 2026 07:01
…r's card dies (#341)

Adds a new class `DefaultBoneGainOnDeath` and methods `DefaultBoneGainOnDeath.ShouldDoDefaultBoneGain` and `DefaultBoneGainOnDeeath.DoDefaultBoneGain` to the API that basically expose specific parts of the PlayableCard.Die method's code.

These allow modders to patch and modify the default bone gain within the PlayableCard.Die method without needing to patch ResourcesManager.AddBone directly.

---------

Co-authored-by: Chaosyr <Thincreator3483@hotmail.com>
* Add XML for the ReduceGemifiesX methods

* Add XML

* Privatise patches in internal patch class

* Add missing XML

* Add some XML

* More XML

* Replace call to card.Info.BloodCost to card.BloodCost()

* Typo Fix

---------

Co-authored-by: Chaosyr <Thincreator3483@hotmail.com>
**Comment out unusued duplicate field**
@Chaosyr
Chaosyr requested review from HumabHatterZed and removed request for IngoHHacks November 17, 2026 00:49
HumabHatterZed
HumabHatterZed previously approved these changes Nov 17, 2026

@HumabHatterZed HumabHatterZed left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

HumabHatterZed and others added 8 commits November 16, 2026 18:06
Fix boss challenges overlapping each other under certain circumstances
* Try Fix Doc Bugs

* Remove Namespace from Aggregate

* Make summary match the correct extension

* Fix Extension Summaries

* Extension stuff

* More Extension Stuff

* remove debug logging in wiki builds

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.

3 participants