7033595a90
Sets up C# .NET 8 project with modinfo.json, ModSystem entry point, full asset directory structure, .gitignore, and README. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
73 lines
1.8 KiB
Markdown
73 lines
1.8 KiB
Markdown
# VS Vineyard
|
|
|
|
A Vintage Story mod adding viticulture and winemaking mechanics.
|
|
|
|
## Features (Planned)
|
|
|
|
- Grape vine blocks with seasonal growth stages
|
|
- Grape harvesting and pressing into juice
|
|
- Fermentation and barrel aging system
|
|
- Multiple wine varieties with stat effects
|
|
- Wild grape vines in world generation
|
|
|
|
## Development Setup
|
|
|
|
### Prerequisites
|
|
|
|
- [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
|
|
- Vintage Story installed
|
|
|
|
### Environment Variable
|
|
|
|
Set `VINTAGE_STORY` to your game installation path:
|
|
|
|
**Linux:**
|
|
```bash
|
|
export VINTAGE_STORY="$HOME/.local/share/vintagestory"
|
|
```
|
|
|
|
**Windows (PowerShell):**
|
|
```powershell
|
|
$env:VINTAGE_STORY = "$env:APPDATA\Vintagestory"
|
|
```
|
|
|
|
Add this to your shell profile so it persists.
|
|
|
|
### Build
|
|
|
|
```bash
|
|
dotnet build # Debug build
|
|
dotnet build -c Release # Release build + creates releases/vsvineyard-x.x.x.zip
|
|
```
|
|
|
|
### Install for Testing
|
|
|
|
Symlink or copy the `releases/*.zip` into your Mods folder:
|
|
|
|
**Linux:** `~/.config/VintagestoryData/Mods/`
|
|
**Windows:** `%APPDATA%\VintagestoryData\Mods\`
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
VSVineyard/
|
|
├── src/ C# source files
|
|
├── resources/
|
|
│ ├── modinfo.json Mod metadata
|
|
│ └── assets/
|
|
│ └── vsvineyard/
|
|
│ ├── blocktypes/ Block JSON definitions
|
|
│ ├── itemtypes/ Item JSON definitions
|
|
│ ├── textures/ PNG textures
|
|
│ ├── shapes/ 3D model JSON
|
|
│ ├── recipes/ Crafting/cooking recipes
|
|
│ ├── worldgen/ World gen patches
|
|
│ └── lang/ Localization strings
|
|
├── releases/ Built mod zips (git-ignored)
|
|
└── VSVineyard.csproj
|
|
```
|
|
|
|
## Contributing
|
|
|
|
This is a group project — feel free to open issues or PRs!
|