Give Feedback
- All games
- Stardew Valley
- Mods
- Modding Tools
- Custom Companions
Custom Companions
-
Endorsements
-
Unique DLs--
-
Total DLs--
-
Total views--
-
Version3.0.0
- Download:
- Manual
0 of 0
File information
Last updated
Original upload
Created by
PeacefulEndUploaded by
PeacefulEndVirus scan
Safe to use
Tags for this mod
Current section
About this mod
Framework for creating custom entities that can be spawned on maps or follow you around in Stardew Valley.
- Requirements
-
Nexus requirements
Mod name Notes SMAPI - Stardew Modding API Mods requiring this file
- Permissions and credits
-
Credits and distribution permission
- Other user's assets All the assets in this file belong to the author, or are from free-to-use modder's resources
- Upload permission You are not allowed to upload this file to other sites under any circumstances
- Modification permission You must get permission from me before you are allowed to modify my files to improve it
- Conversion permission You are not allowed to convert this file to work on other games under any circumstances
- Asset use permission You must get permission from me before you are allowed to use any of the assets in this file
- Asset use permission in mods/files that are being sold You are not allowed to use assets from this file in any mods/files that are being sold, for money, on Steam Workshop or other platforms
- Asset use permission in mods/files that earn donation points You are not allowed to earn Donation Points for your mods if they use my assets
Author notes
This author has not provided any additional notes regarding file permissions
File credits
This author has not credited anyone else in this file
Donation Points system
This mod is opted-in to receive Donation Points
- Changelogs
-
-
Version 3.0.0
- Added the following API endpoints: GetLoadedContentPackIds and GetCompanionModelById
-
Version 2.5.0
- Implemented Companion.DialogueSequence, which allows mod authors to create companions with multiple dialogue sequences.
- Now hiding custom companion build data from trace logs.
- Fixed issue where map-based companions would not be interactable during festivals.
-
Version 2.4.2
- Fixed issue where companions would not spawn during festivals when using EnableEventAppearance.
-
Version 2.4.1
- Fixed issue where Custom Companion spawns were not checked if added via buildings.
-
Version 2.4.0
- Added ResetWhenPlayerAway and MinTilesForAway companion property, which allows for map-based companions to reset their behavior once the player leaves the specified distance.
- Added the PlayOnlyOnce property for ManualFrames, allowing for certain frames to only be played once.
-
Version 2.3.0
- Fixed compatibility issue with SMAPI v3.14+.
- Implemented support for SMAPI's new content events, allowing for more accurate patch detection for companions when editing them via Content Patcher.
- Flagged the EnablePeriodicPatchCheck as obsolete, as it is no longer needed due to SMAPI's new content pipelines.
-
Version 2.2.0
- Added EnableEventAppearance companion property, which allows for map-based companions to appear during events.
- Fixed issue where companions spawned in Farmhouses would not re-appear the next morning in certain situations.
-
Version 2.1.1
- Fixed issue where farmhouse-based spawns would not respawn after the player re-enters.
-
Version 2.1.0
- Fixed issue where Portrait.FrameIndex would not actually apply.
- Added special handling for spawning companions in the FarmHouse via the "front" layer.
-
Version 1.7.2
- Fixed issue where sound components would fail when incorrectly called.
-
Version 1.7.1
- Added exception handling for GameLocations with missing maps or "Back" layers.
-
Version 1.7.0
- Added EnableSpawnAtDayStart companion property, which allows for map-based companions to be spawned at the start of the day (instead of when the player warps to their location).
-
Version 1.6.6
- Fixed issue where Content Patcher patches using OnDayStart would not affect any Custom Companion models.
-
Version 1.6.5
- Added support for FOLLOW behavior to have unlimited follow range.
- Added TargetNpcName companion property, which currently allows for FOLLOW type companions to follow a specific NPC.
-
Version 1.6.4
- Added EnableCharacterCollision companion property.
- Implemented support for FOLLOW behavior to follow NPCs or other companions.
-
Version 1.6.3
- Fixed a bug where multiple OverheadTexts could fail to pick any of them when using ChanceWeight.
-
Version 1.6.2
- Map-based spawns will now open doors for SIMPLE_PATH and PACING idle behaviors.
- Added argument for SIMPLE_PATH to allow the companion to stop at its destination tile.
- Fixed issue with cc_spawn command not outputting the location's proper name.
-
Version 1.6.1
- Added basic support for Save Anywhere to prevent crashes while saving.
-
Version 1.6.0
- Fixed critical issue where SIMPLE_PATH behavior failed to check for an existing activePath during temporary workaround.
- Fixed bug where Content Patcher OnTimeChange patches would fail to occur without a When condition.
- Added UpdateWhenPlayerNearby and MinTilesForNearby companion properties.
- Added OverheadTexts and related companion properties.
- Added Portrait and related companion properties.
-
Version 1.5.0
- Fixed issue where breathing overlay didn't use the companion's color.
- Added DespawnOnTimer companion property.
- Added DespawnOnTile companion property.
- Added Respawn companion property.
- Added PACING idle behavior.
- Added WALK_SQUARE idle behavior.
- Added FOLLOW idle behavior.
- Added SIMPLE_PATH idle behavior.
- Added CollisionPositionX companion property.
- Added CollisionPositionY companion property.
- Added CollisionPositionHeight companion property.
- Added CollisionPositionWidth companion property.
-
Version 1.4.4
- Added multiplayer support.
- Fixed issue where companions would be greeted by villagers.
- Fixed issue where isThereAFarmerOrCharacterWithinDistance would cause NPC.performTenMinuteUpdate to fail.
-
Version 1.4.3
- Added EnablePeriodicPatchCheck companion property.
- Implemented checking for patches of valid companions over a 5 second interval. The checks will trigger on location change or every 5 seconds if the companion has the EnablePeriodicPatchCheck property.
-
Version 1.4.2
- Fixed issue where GameLocation.isCollidingPosition would allow colliding with other companions.
- Preserved translation helper across models when using Content Patcher.
- Fixed issue where map-based spawns would be reset on location change.
- Prevented MaxHaltTime property from being higher than MinHaltTime.
-
Version 1.4.1
- Fixed critical bug when companions would run into furniture.
- Companions now respect EnableFarmerCollision while moving.
- Fixed shadow rendering.
- Fixed breathing animation due to layer depth issue.
-
Version 1.4.0
- Added Content Patcher integration. See the repo's wiki for details.
- Added the AppearUnderwater companion property.
- Implemented cc_reload console command, which allows reloading of CC packs without restarting the game.
- Renamed cc_spawnCompanion console command to cc_spawn.
- Renamed cc_removeAll console command to cc_clear.
- Fixed issue where map-based spawns would not despawn after their tile property was cleared or replaced.
- Fixed issue where map-based spawns would not collide with certain tiles.
-
Version 1.3.1
- Fixed critical bug where companions would not load if Json Assets was not installed, even if not utilizing summoning rings.
-
Version 1.3.0
- Added Scale companion property.
- Added Pitch, MinPitchRandomness, MaxPitchRandomness companion properties.
- Added ChanceForHalting, MinHaltTime, MaxHaltTime companion properties.
- Map-based spawns now respect back tiles with the NPCBarrier property.
- Fixed issue where map-based spawns with NOTHING idle type would not play their full animation.
- Fixed issue where follower-based companions were using the incorrect starting point for Utility.getVelocityTowardPoint.
-
Version 1.2.0
- Better collision handling for map-based spawns.
- Added i18n support, only usable with InspectionDialogue currently.
- Fixed issue where light property would not refresh on area change for map-based spawns.
- Random direction is now used for map-based spawns if SpawnDirection isn't given.
- Added warning if content pack is missing sub-folders under the Companions parent folder.
- Added null check to debug command.
- Added DirectionChangeChanceWhileMoving and DirectionChangeChanceWhileIdle companion properties. See Wiki for details.
- Converted HOVER idle types to utilize game's gravity field. JUMPER and HOVER idle types both can have configured gravity for IdleArguments property.
- Updated and added some new examples to the example pack.
-
Version 1.1.2
- Fixed issue where CustomCompanion property, when cleared by Content Patcher, would result in warnings.
-
Version 1.1.0
- Added EnableShadow setting.
- Added EnableBreathing setting.
- Updated some of the example companions in the example pack.
-
Version 1.0.0
- Release.
-
- Donations
-
Straight donations accepted
See the GitHub repository for an in-depth wiki on how to create a content pack for Custom Companions.
See the example pack in the Optional Files section for example companions.
Multiplayer is supported!
Content Patcher is supported!
Save Anywhere is supported!
Source code is available here.
See the example pack in the Optional Files section for example companions.
Multiplayer is supported!
Content Patcher is supported!
Save Anywhere is supported!
Source code is available here.