MycoMerger

MycoMerger

Extends Mycologists functionality to allow non-duplicate merges and unique merge results. Supports use by other mods including JSONCardLoader.

Features

• Merge two different cards, not just duplicates, for a specified result!
• Change the maximum number of sigils that can be added to a card through merging.
• Change what is inherited by the result from the cards used in merging.
• Cards and mods can override a user's default settings for merges if the user doesn't disallow overriding in their configuration. (It is allowed by default.) Specific settings of a merge when available are always used over the default.

How to use

Simply install if you're not making new cards or mods. If you are, see below.

With your mod

• If you include MycoMerger in your project, you can use the MergerManager class to do:

MergerManager.AddMergeData("SourceCardName", "TargetCardName", "Result")

• You can also specify MergeInheritance for a merge using:

MergerManager.AddMergeData("SourceCardName", "TargetCardName", "Result", "MergeInheritance")

• If you don't include MycoMerger, you can set an extended property for cards using the InscryptionAPI CardInfo extension with the following format:

SourceCardInfo.SetExtendedProperty("MycoMerger", "TargetCardName1:Result1, TargetCardName2:Result2:MergeInheritance … " )

• SourceCardInfo can be retrieved with CardLoader.GetCardByName("SourceCardName").
• Beware that if the SourceCard already has MycoMerger data as using SetExtendedProperty will overwrite that data. You can retrieve that data using SourceCardInfo.GetExtendedProperty("MycoMerger") and check if any data exists using string.IsNullOrWhiteSpace. You can append any new data with string.Concat(ExistingMycomergerData, ",", "AdditionalMycomergerData") before using that to set the extended property but beware duplicate TargetCardName entries.

With JSON Loader (jldr2)

• In your card's .jldr2 file, add an entry to its extensionProperties with the following format: "extensionProperties": { "MycoMerger": "[MERGEDATA]" }.
• If there are other entries in your card's extensionProperties, it will look like this: "extensionProperties": { "Property1": "Value1", "Property2": "Value2", "MycoMerger": "[MERGEDATA]" }.
• [MERGEDATA] is composed of the following: TargetCard:Result with each entry separated by commas. Spaces between don't matter. Example: Packrat:Cat, FieldMouse : FieldMouse.
• MergeInheritance can be specified by adding another colon : and a plus sign + if there is more than one keyword. See References further below. Example:

Packrat:Cat:UserDefault, FieldMouse : FieldMouse : Attack + Health.

• If the card you're making should be the result of a merge, you can use this special format: !RESULT!:SourceCard:TargetCard.
• !RESULT! means this card is the result of the merge of two other cards. This MergeData is then assigned to the SourceCard. This is mostly meant for making a new card using jldr2 the result of a merge without needing to make files for or edit other cards. This means that if you're making a new card and use this format, it's equivalent to adding this merge data in SourceCard: TargetCard:NewCard.
• Example in FieldMouse.jldr2:

"extensionProperties": { "MycoMerger": "FieldMouse:SporeMouse" }

• Example !RESULT! in SporeMouse.jldr2:

"extensionProperties": { "MycoMerger": "!RESULT!:FieldMouse:FieldMouse" }

• Example MergeInheritance in Stoat.jldr2:

"extensionProperties": { "MycoMerger": "Burrow:Rabbit:None" }

• Example of other valid formatting with RatKing.jldr2:

"extensionProperties": { "OtherProperty1": "OtherValue1", "MycoMerger": "!RESULT!:FieldMouse:FieldMouse, !RESULT!:PackRat:PackRat:UserDefault, !RESULT! : FieldMouse : PackRat : Attack+Health+AddedSigils, !RESULT!: RatKing :FieldMouse, PackRat:RatKing:Vanilla, Hodag:MycoMerger_TotalStats:All RatKing:RatEmperor", "OtherProperty2: "OtherValue2" }

Notes

• SourceCard just means the card where the merge data is stored.
• TargetCard is the card targeted for the merge from the SourceCard.
• Result is either another card or a MergeResult that determines which between the two cards used in the merge should be the result. It can also have a MergeInheritance specified.
• A MergeResult is a special Result that chooses between the two cards used in the merge to be the result based on certain criteria. UserDefault can be used, which is TotalStats by default. See References further below.
• MergeInheritance specifies what is inherited by the Result. Vanilla inheritance is Attack+Health+AddedSigils. When not specified, uses UserDefault which is Vanilla by default. See References further below.
• You only need to add the data for the merge you want to one of the cards involved in the merge.
• Merge data in a SourceCard may be overridden by new merge data, specifically when a TargetCard is specified for a new result. This may happen if several mods or cards target the same card combination.
• If there is valid merge data in multiple cards that specify the same two cards for a merge but the results are different, the result is randomly chosen between those results.
• Adding merge data to a card should not conflict with anything else, but the MycoMerger mod may conflict with any mod that makes changes to the Mycologists event.
• Doubled sigils are not implemented in merge inheritance because there's no point in getting more than one copy of a sigil most of the time. For it to be useful, specific sigils need to be included or excluded and I think it's better to just make a new card that have duplicated base sigils.
• Settings can be overriden by mods for more general use instead of only for specific