灌木绽放模组

灌木绽放模组

允许创建自定义灌木开花计划,以支持您想要的任何季节、日期、地点和物品。

你喜欢到处跑,点击五颜六色的灌木丛,然后获得免费物品吗?你希望自己能更频繁地这样做,并且获得除了鲑莓和黑莓以外的东西吗?

我也是!

这个模组实际上并不能做到这一点,但它允许你(或其他人)通过内容包让这个梦想成真。

这最初是为了让我另一个模组 [url=https://www.nexusmods.com/stardewvalley/mods/15333]Copper Still[/url] 中的杜松子能够开花,随着时间的推移发展成了一个通用框架。

[b][size=3][u]常规功能:[/u][/size][/b]
[list=1]
[]创建你自己的灌木开花时间表;[/]
[]摇落你选择的任何物品;[/]
[]支持多个时间表同时激活;[/]
[]支持为每个时间表自定义浆果贴图;[/]
[]支持自定义开花概率;[/]
[]支持仅在特定地点开花,可通过包含或排除来设置;[/]
[]支持仅在特定天气开花,可通过包含或排除来设置(或摧毁现有花朵);[/]
[]时间表可以短至一天,也可以长至全年;[/]
[]支持仅在特定年份开花;[/]
[]支持仅在特定地块上开花;[/]
[]允许其他模组检查自定义开花时间表;[/]
[]根据你的其他模组提供配置选项来切换某些功能。[/]
[][s]内置支持 [/s][url=https://www.nexusmods.com/stardewvalley/mods/7920]Deluxe Grabber Redux[/url](在其更新至 1.6 之前禁用)[/]
[][s]内置支持 [/s][url=https://www.nexusmods.com/stardewvalley/mods/11022][s]Almanac[/s][/url](在其更新至 1.6 之前禁用)[/]
[][s]内置支持 [url=https://www.nexusmods.com/stardewvalley/mods/1063/]Automate[/url][/s](Automate 现已原生支持自定义摇落物品)[/]
[][b]1.2.0 新增[/b] 现在支持通过 [url=https://www.nexusmods.com/stardewvalley/mods/1915]Content Patcher[/url] 加载和/或编辑的内容(参见压缩包中的示例模组)[/]
[][b]1.3.0 新增[/b]* 现在也支持小型和大型灌木丛。需要通过开花条目配置选择启用。[/]
[/list][b][u][size=3]
配置选项:
[/size][/u][/b]你可以在游戏内使用 [url=https://www.nexusmods.com/stardewvalley/mods/5098]Generic Mod Config Menu[/url] 界面编辑这些配置文件,也可以直接编辑 config.json 文件。

[b] Enable Default Blooming[/b]:([u]true[/u]|false)启用游戏默认的春季和秋季灌木开花时间表。禁用它们不会修改游戏中的任何其他逻辑、收集包、任务或剧情。请自行承担风险!

[b] Use Spring Bush for Summer[/b]:([u]true[/u]|false)默认的夏季开花灌木没有浆果。此选项复用春季灌木来适应夏季开花。如果你使用了其他添加夏季浆果灌木贴图的模组,请禁用此选项。

[b]Use Custom Winter Berry[/b]:([u]true[/u]|false)默认的冬季开花灌木不存在。此选项使用自定义贴图来适应冬季开花。如果你使用了其他添加冬季开花灌木贴图的模组,请禁用此选项。
                   
[s][b]Support Deluxe Grabber Redux[/b]:(true|false)使用该模组时,允许采集器从灌木丛中收获自定义物品。

[b] Support Almanac[/b]:(true|false)使用该模组时,允许年鉴显示自定义采集时间表。启用后,强烈建议禁用该模组的选项“页面:本地通知”>“显示采集”,以避免显示默认采集时间表的重复项。[/s]

[s][b]Support Automate[/b]:(true|false)使用该模组时,允许箱子从灌木丛中收获自定义物品。[/s]

[b][u][size=3]内容包详情:[/size][/u][/b]
此模组包含一个 [u]example[/u] 目录,其中有 manifest.json、content.json 和 assets/berry.png。这些可以作为创建其他内容包的模板。以下是 content.json 可以包含的一些示例。

你也可以参考我的另一个模组作为示例:[url=https://www.nexusmods.com/stardewvalley/mods/15805]Ore Berries[/url]

完整时间表配置示例:

[code][{
// 可选;缺失时默认为 true
"Enabled": true,

// 可选:缺失时默认为 'ModDirectoryName/StartSeason_ShakeOff'
"Id": "[BBM] Bush Bloom Example/spring_0",

// 必需;值可以是物品 ID 或名称,但必须存在
"ShakeOff": 0,

// 必需;值必须是 'spring'、'summer'、'fall' 或 'winter'
"StartSeason": "spring",

// 必需;值必须为 1 到 28
"StartDay": 1,

// 可选;缺失时默认为 StartSeason 的值
"EndSeason": "winter",

// 可选;缺失时默认为 StartDay 的值
"EndDay": 28,

// 可选;默认为第一年
"StartYear": 1,

// 可选:默认无年份限制
"EndYear": 2,

// 可选:可使用此时间表开花的灌木尺寸。默认为 1(中型)。
//           值:0 = 小型,1 = 中型,2 = 大型
"BushSizes": [ 0, 1, 2 ],

// 可选;缺失时默认为内置贴图
"Texture": "assets/berry.png",

// 可选;默认为无
"TextureSmall": "assets/berry_small.png",

// 可选;默认为无
"TextureLarge": "assets/berry_large.png",

// 可选;缺失时默认为 0.2;值在 0.0 到 1.0(含)之间
//           决定总体概率。大于 1.0 的值将
//           保证该物品必定开花,无论是否存在现有花朵
//           或其他可能的时间表,除非它们的值也大于 1.0。
//           虽然并非必需,但建议记住
//           较小的灌木往往产出略少,而较大的
//           灌木产出会略多于普通中型
//           灌木,因此如果你想保持相对平衡,
//           最好为每个尺寸使用单独的条目。
"Chance": 0.2,

// 可选;缺失或为空时默认为所有地点
"Locations": [ "Forest", "Mountain" ],

// 可选:缺失或为空时默认不排除任何地点
"ExcludeLocations": [ "Town" ],

// 可选;缺失或为空时默认为所有天气
"Weather": [ "Rain", "GreenRain", "Sun", "Wind" ],

// 可选:缺失或为空时默认不排除任何天气
"ExcludeWeather": [ "Storm", "Festival", "Wedding" ],

// 可选:缺失或为空时默认不摧毁任何天气
"DestroyWeather": [ "Snow" ],

// 可选:将开花限制为仅在给定地块位置的灌木丛。
//           与特定的 "Locations" 设置结合使用时最有效,
//           以便让
非常*特定的一组灌木丛开花。
"Tiles": [
{ "X": 10, "Y": 20 },
{ "X": 23, "Y": 32 }
]
}][/code]
最小默认时间表示例:

[code][{
"ShakeOff": 296,
"StartSeason": "spring",
"StartDay": 15,
"EndDay": 18
}, {
"ShakeOff": 410,
"StartSeason": "fall",
"StartDay": 8,
"EndDay": 11
}][/code]Content Patcher 也可以用于修改时间表或贴图,例如:

[code]{
"Format": "2.0.0",
"Changes": [
{
// 此示例将修改现有的默认秋季黑莓
// 时间表,以保证在精灵非常高兴时必定开花
"Action": "EditData",
"Target": "NCarigon.BushBloomMod/Schedules",
"Fields": {
// 来自 BBM 内容包的条目 ID 将格式化为:
//     ModDirectoryName/StartSeason_ShakeOff
// 除非在其配置中指定了特定的 Id
"default/fall_410": {
"Chance": 1.0
}
},
"When": {
// 也可以使用 CP 令牌来动态修改时间表。
// 参考:https://github.com/Pathoschild/StardewMods/blob/develop/ContentPatcher/docs/author-guide/tokens.md
"Query: {{DailyLuck}} > 0.07": true // 今天精灵非常高兴
}
},
{
// 此示例将更改默认秋季黑莓开花浆果的图像
"Action": "EditImage",
"Target": "NCarigon.BushBloomMod/Textures/default/fall_410",
// 将开花图像更改为不同的图像
"FromFile": "assets/berry.png"
}
]
}[/code]你也可以通过 Content Patcher 创建一个全新的时间表,例如:

[code]{
"Format": "2.0.0",
"Changes": [
{
"Action": "EditData",
"Target": "NCarigon.BushBloomMod/Schedules",
"Entries": {
// 此处的 Id 应该 与 'ModDirectoryName/StartSeason_ShakeOff' 的默认值匹配
// 但技术上可以是任何你想要的。也可以通过使用相同的
// id 来覆盖现有时间表。
"CPExampleBBM/spring_0": {
"ShakeOff": 0,
"StartSeason": "spring",
"StartDay": 1,
"BushSizes": [ 0, 1, 2 ]
}
}
},
{
// 中型灌木图像目标应匹配:NCarigon.BushBloomMod/Textures/YOUR-MOD-ID/ENTRY-ID
"Action": "EditImage",
"Target": "NCarigon.BushBloomMod/Textures/CPExampleBBM/spring_0",
"FromFile": "assets/berry.png"
},
{
// 小型灌木图像目标应匹配:NCarigon.BushBloomMod/Textures/YOUR-MOD-ID/ENTRY-ID_small
"Action": "EditImage",
"Target": "NCarigon.BushBloomMod/Textures/CPExampleBBM/spring_0_small",
"FromFile": "assets/berry_small.png"
},
{
// 大型灌木图像目标应匹配:NCarigon.BushBloomMod/Textures/YOUR-MOD-ID/ENTRY-ID_large
"Action": "EditImage",
"Target": "NCarigon.BushBloomMod/Textures/CPExampleBBM/spring_0_large",
"FromFile": "assets/berry_large.png"
}
]
}[/code][b][u]关于时间表 ID 生成:[/u][/b]
当未提供时间表 ID 时,默认行为是根据字段生成一个 ID,如下所示:

[code]ModDirectoryName/StartSeason_ShakeOff[/code]如果多个时间表会生成相同的 ID,则会为第一个条目之后的每个条目添加递增后缀,如下所示:

[code]ModDirectoryName/StartSeason_ShakeOff_1[/code]这一点在通过 Content Patcher 动态修改时间表时尤其值得注意,因为你需要准确知道要修改的 ID。

[b][u][size=3]集成详情:[/size][/u][/b]
如果你正在制作其他模组并希望与此模组的功能集成,请熟悉以下内容:[url=https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Integrations]Modding:Modder Guide/APIs/Integrations
[/url]
要将此模组的逻辑整合到你的模组中,请在你的项目中创建此接口,包含你实际需要的特定方法:

[code]public interface IBushBloomModApi {
    /// <summary>
    /// 返回 (item_id, first_day, last_day) 数组,表示给定灌木尺寸、
    /// 给定季节和日期下所有可能激活的开花时间表,
    /// 可选地限制在给定年份和/或地点内。
    /// </summary>
    public (string, WorldDate, WorldDate)[] GetActiveSchedules(int size, string season, int dayofMonth, int? year = null, GameLocation location = null, Vector2? tile = null)

    /// <summary>
    /// 该函数的旧版本,没有 'size' 参数,将默认为值 1。
    /// </summary>
public (string, WorldDate, WorldDate)[] GetActiveSchedules(string season, int dayofMonth, int? year = null, GameLocation? location = null, Vector2? tile = null);

    /// <summary>
    /// 返回所有开花时间表的 (item_id, first_day, last_day) 数组。
    /// </summary>
    public (string, WorldDate, WorldDate)[] GetAllSchedules();

    /// <summary>
    /// 清除并重新解析所有时间表。
    /// </summary>
    public void ReloadSchedules();

    /// <summary>
    /// 指定 BBM 是否成功解析了所有时间表。
    /// </summary>
    public bool IsReady();

    /// <summary>
    /// 执行 Bush.shake() 函数的一般操作,但不包含所有玩家、碎片
    /// 和 UI 逻辑。具体来说,如果灌木正在开花,这将返回一个物品 ID
    /// 并将灌木标记为不再开花。你必须创建物品并处理所需的任何操作。
    /// </summary>
    public string FakeShake(Bush bush);
}[/code]
然后在你的 Entry 方法中调用 API:

[code]var bbm = helper.ModRegistry.GetApi<IBushBloomModApi>("NCarigon.BushBloomMod");[/code]你需要更新你的灌木检查逻辑以包含对 API 的调用。

例如,如果你的原始方法是:

[code]private void Harvest(Bush bush) {
var season = (bush.overrideSeason.Value == -1) ? Game1.GetSeasonForLocation(bush.currentLocation) : Utility.getSeasonNameFromNumber(bush.overrideSeason.Value);
if (bush.size.Value == 1 && bush.inBloom(season, Game1.dayOfMonth)) {
var shakeOff = -1;
if (season == "spring") shakeOff = 296; //鲑莓
else if (season == "fall") shakeOff = 410; //黑莓;
if (shakeOff != -1) {
bush.tileSheetOffset.Value = 0;
Game1.player.addItemToInventory(new SObject(shakeOff, 1));
}
}
}[/code]
新增 星露谷物语 1.6 版本大大简化了这一点:

[code]private void Harvest(Bush bush) {
    if (bbm is not null) {
        var shakeOff = bbm.FakeShake(bush);
        if (shakeOff != null) {
            Game1.player.addItemToInventory(new SObject(shakeOff, 1));
        }
    } else {
        var season = (bush.overrideSeason.Value == -1)
            ? Game1.GetSeasonForLocation(bush.currentLocation)
            :Utility.getSeasonNameFromNumber(bush.overrideSeason.Value);
    if (bush.size.Value == 1 && bush.inBloom(season, Game1.dayOfMonth)) {
    var shakeOff = -1;
    if (season == "spring") shakeOff = 296; //鲑莓
    else if (season == "fall") shakeOff = 410; //黑莓;
    if (shakeOff != -1) {
    bush.tileSheetOffset.Value = 0;
    Game1.player.addItemToInventory(new SObject(shakeOff, 1));
    }
    }
    }
}[/code]
另一个例子,如果你想枚举给定日期的开花物品,你的原始代码可能如下所示:

[code]private IEnumerable<(Item, WorldDate, WorldDate)> GetBloomSchedules(Bush bush, WorldDate date) {
if (bush.inBloom(date.Season, date.DayOfMonth)) {
int id = -1;
if (date.SeasonIndex == 0) id = 296; // 鲑莓
else if (date.SeasonIndex == 2) id = 410; // 黑莓
if (id != -1) {
if (date.DayOfMonth == 1 || !bush.inBloom(date.Season, date.DayOfMonth - 1)) {
int last = date.DayOfMonth;
for (int d = date.DayOfMonth + 1; d <= 28; d++) {
if (!bush.inBloom(date.Season, d))
break;
last = d;
}
yield return (new SObject(id, 1), new WorldDate(date.Year, date.Season, date.DayOfMonth), new WorldDate(date.Year, date.Season, last));
}
}
}
}[/code]
集成后的代码将如下所示:

[code]private IEnumerable<(Item, WorldDate, WorldDate)> GetBloomSchedules(Bush bush, WorldDate date) {
if (bbm is not null) {
foreach (var sched in bbm.GetActiveSchedules(date.Season, date.DayOfMonth)) {
yield return (new SObject(sched.Item1, 1), sched.Item2, sched.Item3);
}
} else if (bush.inBloom(date.Season, date.DayOfMonth)) {
int id = -1;
if (date.SeasonIndex == 0) id = 296; // 鲑莓
else if (date.SeasonIndex == 2) id = 410; // 黑莓
if (id != -1) {
if (date.DayOfMonth == 1 || !bush.inBloom(date.Season, date.DayOfMonth - 1)) {
int last = date.DayOfMonth;
for (int d = date.DayOfMonth + 1; d <= 28; d++) {
if (!bush.inBloom(date.Season, d))
break;
last = d;
}
yield return (new SObject(id, 1), new WorldDate(date.Year, date.Season, date.DayOfMonth), new WorldDate(date.Year, date.Season, last));
}
}
}
}[/code]
源代码:[url=https://github.com/ncarigon/StardewValleyMods]ncarigon/StardewValleyMods (github.com)[/url]

我的模组:
[url=https://www.nexusmods.com/stardewvalley/mods/15333]Copper Still[/url]
[url=https://www.nexusmods.com/stardewvalley/mods/15212]Garden Pot - Automate[/url]
[url=https://www.nexusmods.com/stardewvalley/mods/15223]Passable Crops
[/url][url=https://www.nexusmods.com/stardewvalley/mods/15792/]Bush Bloom Mod[/url]
[url=https://www.nexusmods.com/stardewvalley/mods/15805]Ore Berries
[/url][url=https://www.nexusmods.com/stardewvalley/mods/15927/]Tree Shake Mod
[/url][url=https://www.nexusmods.com/stardewvalley/mods/21608]Garden Pot Options[/url]