[BUG] Loading Instrument Bug After Renaming Instruments

[dotmatrixgirl]

After renaming an instrument, loading a new instrument results in odd behavior with the samples. Previously changed a variety of things one at a time. It only overwrote the wrong sample after I renamed the samples, and I was able to duplicate it with the below steps.

Loaded 1-3 instruments with no issue.

Renamed instrument 3 as "test test"

Loaded instrument 4 with no issue.

Loaded instrument 2. Sample 1 was empty and sample 0 was overwritten with instrument 2's sample.

test_test.sts.zip

[bazz1tv]

So, I've met with Ravancloak over Zoom to get to the bottom of the issue, and we've not only gotten to the root of it, but also have a solution.

First off, the steps that were included in the post above to reproduce the issue are not accurate. They will not create a problem. Second, when Rowan showed me the problem from their shared desktop (taking different steps), the problem they ran into was from normal SNES Tracker behavior, which is as follows:

When you load an instrument that contains a sample that is already a part of your song's samples, SNES Tracker will refer to that song's already present sample rather than redundantly load the identical sample. This is good behavior, but the issue is that not all users will find this behavior natural without being informed.

In order to remedy this, I will add an on-by-default checkbox in the options menu to "Warn on loading instruments containing song samples." This would cause SNES Tracker to pop a dialog during this circumstance, telling the user eg. "Your song already contains this instrument's sample at Sample Slot #01. Sample #01 will be used directly, and no new sample will be loaded." Users that already know the feature can uncheck this box and not be bothered ever again (it will be persistent), while new users will get a chance to learn about the behavior.

I'm going to leave this issue open until I've fixed it