Metadata-Version: 2.4
Name: stardewModPY
Version: 0.3.11.post1
Summary: Uma biblioteca para gerar mods com packs de conteúdo em json para Stardew Valley
Home-page: 
Author: alichan
Author-email: suportestardewmodspy@gmail.com
Project-URL: Documentação, http://stardewmodpy.kya.app.br/
Project-URL: Suporte, https://discord.gg/Pxj3EDafsv
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: prettytable
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# StardewModPY

## 🌍 Other languages

- 🇬🇧 English (you are here)
- 🇧🇷 [Português](README.pt.md)

**StardewModPY** is a Python library designed to simplify the creation and manipulation of content patch files (mods) for the game **Stardew Valley**.

## Installation

You can install the library via pip:

```bash
pip install StardewModPY
```

## 1. Creating a New Project

After installing StardewModPY, you can easily create a new mod project using the following command:

```bash
sdvpy create nameMod nameAuthor 0.0.1 "Mod Description"
```

**File: ModEntry.py**

```python
from StardewValley import Manifest
from StardewValley.helper import Helper

class ModEntry(Helper):
    def __init__(self):
        super().__init__(Manifest(
            "nameMod", "nameAuthor", "0.0.1", "Mod Description", "nameAuthor.nameMod", ContentPackFor={
                "UniqueID": "Pathoschild.ContentPatcher"
            }
        ))
        self.contents()

    def contents(self):
        ...
```

**File: main.py**

```python
from ModEntry import ModEntry

mod=ModEntry()
mod.write()
```



## Compiling the Mod

To compile the mod, simply run:

```bash
sdvpy run
```


> We will continue improving the library's documentation over time. We also recommend checking the Stardew Valley wiki to find accurate information about the game data you want to modify. [Documentation](http://stardewmodpy.kya.app.br/)
