UPDATE: 2 JULY 2021
Recently, Nexus announced some policy changes that removes power from mod authors over their creations. This is meant to increase ease-of-use for an upcoming feature, Collections (modpacks). While I do not oppose the creation of modpacks, and would have happily given permission to use my mods in modpacks, the way Nexus chose to implement this feature was sudden and shady. Nexus has refused to compromise or co-operate with mod authors. While I have no intention of removing this mod from the site, I will not update it, and will instead upload and update on another site ([ModDrop]). If Nexus can find a way to concede the following points, I will happily return to Nexus.

1. Allow mod authors to remove their own mod files as they please.
2. Allow Collections to be an opt-in/opt-out feature, either per-mod or per-author.

I recommend that all Nexus users using Flower Dance Fix update to version 1.2.1 so that they will be alerted by SMAPI when the next major release (1.3.0, which will be released on ModDrop) happens. It will be a while still, but the next update focuses on the addition of custom sprites. Custom sprites will allow for mixed-gendered dance lines, handling for non-binary characters with randomized placement in the dance lines, and even background animations for all the spectators watching the dance. Hopefully it'll be worth the download! Thanks for reading, and I hope you enjoy your modding experience.

- elfuun

 ---

Flower Dance Fix changes the "main event" code of the Flower Dance Festival, allowing for Custom NPCs and edited vanilla NPCs to participate in the dance, and for the pairs of dancers to be randomized. An NPC must be "datable", and not a child, to be eligible to participate in the dance.

Mod settings can be configured in the config.json file included in the mod folder, or on the main menu using the Generic Mod Config Menu. Please check out the wiki on GitHub for more information about configuring your dance. Current config settings are:

NPCs Have Random Partners (default: false)

• If false, NPCs pairs are generated using a "Love Interest" pairing, if one is available. This method prioritizes matching a character with the "love interest" value for that character's NPC Disposition entry (index 6). Any NPCs without a valid love interest will be paired with the opposite sex at random. Currently does not work for same-sex couples.
• If true, NPCs are paired with the opposite sex at random.
  

Allow Tourist Dancers (default: false)

• If false, NPCs that do not live in the valley will be excluded from the dancer pools. This is calculated using the NPC's "homeRegion" value.
• If true, valid NPCs living anywhere are eligible to participate in the dance.
  

Blacklist

• Prevents characters from being selected for dance. Enter blacklist character names separated by a single forward-slash "/", with no spaces.
  

Max Dance Pairs

• Change the total number of pairs of dancers allowed to dance. Limited to a maximum of 17 pairs total.
  

Some custom NPCs (particularly older or abandoned ones) may be missing flower dance sprites, or may have flower dance sprites in the wrong location on their spritesheets. If these NPCs are selected by FDF to dance, they may have incorrect animations, appear as glitched sprites, or not appear at all. Please be assured that this isn't a glitch or a bug that will break your game or ruin your save- it's just a minor graphics error. A list in the Github wiki has a list of mods, NPCs, and retextures that have incorrect or missing flower dance sprites.

This mod will likely break when used alongside any unmentioned mod that accesses the Event.setUpFestivalMainEvent() method.



This mod currently contains integrations for the following mods:

• Generic Mod Config Menu by spacechase0
  

Some mods include datable NPCs that will be picked up by FDF as valid partners, even though it doesn't make sense for these NPCs to participate in the dance. It is recommended that you add certain NPCs to FDF's NPC Blacklist up until the point where they would participate in the dance, for the sake of maintaining the plot! See this list on the Github wiki for some recommend blacklist settings.


Further updates will include:

• Variable dance size
• Handling for non-binary NPCs (ie. NPC "gender" = 2)
• Mixed-gendered dance lines (male NPCs dancing in the top row with female NPCs, and vice-versa), with custom sprites
• Crowd animations (thanks for the idea, foggywizard (discord)!)
• API for easy mod integration
  

Some of these features may exist partially in the mod files, or visible in the mod config menu/json. They are unlikely to work, as they are either incomplete or improperly implemented.

• Kelly2892 - for example code regarding harmony implementation
• Matt123337 - for mentorship, and listening to my gripes
• The Stardew Valley Wiki's Modding Guide - for general information and laying out step-by-step how to write a mod
• Stardew Valley Discord Server- for answering quick questions and providing inspiration
• Kdau's Stardew Scroll Generator- for section scrolls
  

Source code on Github!
Custom NPCs in the screenshot are from Ridgeside Village!