https://github.com/floogen/customcompanions
Stardew Valley framework which allows for creating custom entities that can be spawned on maps or follow you around in Stardew Valley.
https://github.com/floogen/customcompanions
Last synced: about 2 months ago
JSON representation
Stardew Valley framework which allows for creating custom entities that can be spawned on maps or follow you around in Stardew Valley.
- Host: GitHub
- URL: https://github.com/floogen/customcompanions
- Owner: Floogen
- License: mit
- Created: 2021-04-22T20:17:51.000Z (about 4 years ago)
- Default Branch: development
- Last Pushed: 2024-11-04T19:19:04.000Z (6 months ago)
- Last Synced: 2025-02-28T22:47:34.101Z (2 months ago)
- Language: C#
- Homepage:
- Size: 415 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CustomCompanions
A Stardew Valley mod that allows the creation of custom companions, which can follow the player or be added to maps as creatures.
## Requirements
Custom Companions only requires [SMAPI](https://smapi.io/), which enables support for spawning custom creatures via the map back tile property.
[Json Assets](https://github.com/spacechase0/JsonAssets/blob/master/README.md) is only required **_if_** the content pack being added utilizes rings to add followers.
## Creating a Content Pack
See [the wiki](https://github.com/Floogen/CustomCompanions/wiki) for detailed instructions on how to create content pack for Custom Companions.
## Spawning a Custom Companion via Map Tile Property
See [this section](https://github.com/Floogen/CustomCompanions/wiki/Spawning-a-Companion-via-Map-Tile) in the wiki for exact details on how to spawn via a map tile property.
## Example Content Packs
Some example companions are included in this repository, which can be [found here](https://github.com/Floogen/CustomCompanions/tree/main/CustomCompanions/Examples/%5BCC%5D%20Example%20Pack) or [downloaded here](https://www.nexusmods.com/stardewvalley/mods/8626?tab=files).
You're free to use any of the example ring assets in your own content pack, so long as credit is given.