Documentation

Readme

View as plain text



This mod displays character names above their heads with various customization options.

## Requirements
- Stardew Valley 1.5 or later
- SMAPI 3.0 or later

## Features
- **Show player names**: Display the player's name above their character.
- **Show NPC names**: Display names of non-player characters.
- **Show child names**: Display names of children.
next:
- **Show farm animal names**: Display names of farm animals.
- **Show horse names**: Display names of horses.
- **Show pet names**: Display names of pets.

## Configuration
The mod can be configured via the `config.json` file in the mod folder. The available settings are:

- `ShowPlayerNames` (true/false): Show or hide player names.
- `ShowNPCNames` (true/false): Show or hide NPC names.
- `ShowFarmAnimalNames` (true/false): Show or hide farm animal names.
- `ShowHorseNames` (true/false): Show or hide horse names.
- `ShowPetNames` (true/false): Show or hide pet names.
- `ShowChildNames` (true/false): Show or hide child names.
- `NameSize` (integer): Set the size of the name text.
- `NameVerticalOffset` (float): Set the vertical offset of the name text.

### Example `config.json`:
```json
{
"ShowPlayerNames": false,
"ShowNPCNames": true,
"ShowFarmAnimalNames": false,
"ShowChildNames": false

}
```

## General Information
- Clean and optimized for performance.
- Easy to configure and customize.

## Known Issues
- None reported. Please report any issues you find.

## Credits
- **dvkin**: Development and coding
- **SMAPI**: For the modding API and support

## Recommended Mods
- [Content Patcher](https://www.nexusmods.com/stardewvalley/mods/1915): For managing other content packs.
- [UI Info Suite](https://www.nexusmods.com/stardewvalley/mods/1150): For additional in-game information.

## Installation
1. Install the latest version of [SMAPI](https://smapi.io/).
2. Download this mod and unzip it into your `Mods` folder.
3. Run the game using SMAPI.

## Uninstallation
1. Delete the mod's folder from your `Mods` directory.

---

Let me know if you need any more adjustments or additions!