Skip to content

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

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

API 2.24.2 | Update installation guides and documentation and bug fixes#339
Chaosyr wants to merge 28 commits into
mainfrom
Update-Installation-Guides-and-Documentation-and-Bug-Fixes

Conversation

@Chaosyr

@Chaosyr Chaosyr commented Oct 1, 2026 •
edited
Loading

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.

@Chaosyr
UPDATE Guides Part 1
444d16d 
* Incorporate Pulsar into the Installation Guides.
@Chaosyr
UPDATE Guides Part 2
e4fd1fb 
* Incorporate Pulsar into the Installation Guides.
@Chaosyr
Null Checks and Custom Appearances
a58736c 
* 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 •
edited
Loading

Copy link
Copy Markdown

Download the artifacts for this pull request:

@Chaosyr
Update thunderstore.toml
48a0835 
* 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
@Chaosyr
Update Thunderstore.toml
ce8e0b9 
* Copy over License and Changelog in Builds.
* Renamed LICENSE to LICENSE.md
@Chaosyr
XML Docs Part I, Rename Internal Config Keys
0bd72f8 
* 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
@Chaosyr
ReInternalize 3 ConfigEntry's
45431da
@Chaosyr
XML Docs Part II, and some Cleanup
8d07b07 
* 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>
@Chaosyr
Add Debug Logging related to GenerateTradeCardsWithCostTier.
d2f115b 
* 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>
@Chaosyr
Attempt to fix the Description of configEnableTraderCostTierBugDebugL…
ce2a6b1 
…ogging
@Chaosyr
Correctly Fix Key.
d8d1160
@chytridi05
Add queued background override to pixel appearances (#340)
cbe00db 
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
(Hopefully) revert changes to csproj files in lieu of changes in Insc…
f806ecd 
…ryptionModding#339
HumabHatterZed and others added 14 commits October 30, 2026 07:01
@HumabHatterZed @Chaosyr
Add way to easily patch and modify the default bone gain when a playe…
908b1a8 
…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>
@HumabHatterZed @Chaosyr
Add some missing XML and minor cost fix (#342)
21949ee 
* 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>
@Chaosyr
Add XML Comments to the GUID Module of the API.
a2ca935
@Chaosyr
Add XML Docs to the Tests Module of the Community Patch.
b8cf619
@Chaosyr
Add XML Docs to the Community Patch Sequencers Module
212ff8a
@Chaosyr
Implement XML Docs for ResourceManagers Module of Community Patch
2b62c39
@Chaosyr
Implement XML Docs for the PixelTutor Module in Community Patch
61ef9a3
@Chaosyr
Implement XML Docs to a chunk of the Card Module of the Community Patch
06d88b0
@Chaosyr
Finish PixelTutor Module XML Docs
b253513
@Chaosyr
Update Changelog (+Formatting)
30da297
@Chaosyr
Add a few more items to the Changelog, and update BIE
74b5ec1
@Chaosyr
Integrate TS-Build Support
d96ee1b 
This is mainly useful for when it comes to publishing the packages, and bug fixing issues when installing via mod man and stuff. It does not automatically publish the package just prepares it for Thunderstore and GitHub Releases.
@Chaosyr
Fix TOML to new Build Location for APIPatcher
b92d33f
@Chaosyr
Upgrade Documentation Workflow
3cb4a5d
@Chaosyr
Chaosyr requested a review from IngoHHacks November 14, 2026 12:09
@Chaosyr

Chaosyr commented Nov 14, 2026

Copy link
Copy Markdown
Collaborator Author

@IngoHHacks setting you as a reviewer because I can't push this without having you review, note not ready to push yet ^^

@Chaosyr
Update Wiki Styling (#345)
44be5c0 
* Update Styling

* Remove Styles folder from `api_wiki`

* Fix Style and implement Community Patch and APIPatcher to Docs

* remove arbitrary exclusions for CSProj

* Replace code block font to match

* Update toc.yml

* Update main.css

* Update main.css

* Update main.css

* Update main.css

* Update main.css

* Update main.css

* Remove unneeded Partials folder carried over from DarkFX Copy

* Typo fix and Prettify class.header.tmpl.partial

* Fix up inheritence related look

* Update main.css

* Update main.css

* Update main.css

* Update main.css

* Update Table Implementation to DL

* Undo Table Changes

Gonna look back into this with a fresh state of mind tommarrow

* Pop off API Patcher from Docs

* Move the class header partial under api_wiki and delete inheritence template

* Experiment with disabling darkfx

* part 2

* fix css

* switch to min-height

* Update Templates

* Some fixing

* 2col params, and fields table

* CSS Cleaning and quick fix

* Inline code background

* Underscore the page heading

* Underscore H3 Headers

* Fix borders

* Update main.css

* Conditionalize H3 Headers

* Overhaul Index.md

* Conditionalize H1

* Make Wiki be named Wiki
@Chaosyr
Implement Embedding (#346)
8c34d84 
* Update Styling

* Remove Styles folder from `api_wiki`

* Fix Style and implement Community Patch and APIPatcher to Docs

* remove arbitrary exclusions for CSProj

* Replace code block font to match

* Update toc.yml

* Update main.css

* Update main.css

* Update main.css

* Update main.css

* Update main.css

* Update main.css

* Remove unneeded Partials folder carried over from DarkFX Copy

* Typo fix and Prettify class.header.tmpl.partial

* Fix up inheritence related look

* Update main.css

* Update main.css

* Update main.css

* Update main.css

* Update Table Implementation to DL

* Undo Table Changes

Gonna look back into this with a fresh state of mind tommarrow

* Pop off API Patcher from Docs

* Move the class header partial under api_wiki and delete inheritence template

* Experiment with disabling darkfx

* part 2

* fix css

* switch to min-height

* Update Templates

* Some fixing

* 2col params, and fields table

* CSS Cleaning and quick fix

* Inline code background

* Underscore the page heading

* Underscore H3 Headers

* Fix borders

* Update main.css

* Conditionalize H3 Headers

* Overhaul Index.md

* Conditionalize H1

* Make Wiki be named Wiki

* Allow Embedding

* Fix Embeddability

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

Reviewers

@IngoHHacks IngoHHacks Awaiting requested review from IngoHHacks

At least 1 approving review is required to merge this pull request.

Assignees

@Chaosyr Chaosyr

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Chaosyr @chytridi05 @HumabHatterZed