Files
novafarma/README.md
2025-12-12 13:48:49 +01:00

241 lines
5.9 KiB
Markdown

# 🌾 NovaFarma v2.5.0
**2.5D Isometric Survival Farming Game**
![NovaFarma](build/icon.png)
---
## 🎮 O Igri
NovaFarma je 2.5D izometrična survival farming igra, kjer upravljaš svojo farmo, preživiš noči, zbiraš vire in gradiš svoje kraljestvo!
### ✨ Funkcionalnosti:
- 🌾 **Farming System** - Till, plant, harvest crops
- 🏗️ **Building System** - Build fences, barns, houses
- ⚒️ **Crafting System** - 13 receptov za orodja in stavbe
- 🧟 **NPC System** - 3 NPCji z random walk AI
- 🌙 **Day/Night Cycle** - 24-urni cikel (5 min)
- 🌦️ **Weather System** - Rain, storms, seasons
- 🍖 **Survival Mechanics** - Hunger, thirst, health
- 💾 **Save/Load System** - 3 save slots + auto-save
- 🗺️ **Minimap** - Real-time terrain + NPC tracking
- 🎵 **Sound Effects** - 6 procedural sounds + music
-**Performance** - 60 FPS, optimized rendering
---
## 💻 Sistemske Zahteve
### Minimalne:
- **OS:** Windows 10/11 (64-bit)
- **RAM:** 4 GB
- **Prostor:** 300 MB
- **DirectX:** 11
### Priporočene:
- **OS:** Windows 11
- **RAM:** 8 GB
- **Prostor:** 500 MB
- **GPU:** Integrated graphics
---
## 🚀 Kako Igrati
### Namestitev:
1. Razpakiraj ZIP datoteko
2. Odpri mapo `NovaFarma-win32-x64`
3. Zaženi `NovaFarma.exe`
4. Igraj!
### Kontrole:
#### Gibanje:
- **W A S D** - Premikanje
- **Mouse Wheel** - Zoom in/out
#### Farming:
- **SPACE** - Till soil / Plant seeds / Harvest crops
- **1-9** - Izberi item iz inventory
#### Building:
- **B** - Toggle build mode
- **1-5** - Izberi stavbo (v build mode)
- **Click** - Postavi stavbo
- **ESC** - Zapri build mode
#### UI:
- **C** - Odpri crafting menu
- **F3** - Toggle performance monitor
- **F5** - Quick save
- **F9** - Quick load
- **F12** - Developer console
- **M** - Mute/unmute sound
---
## 🎯 Gameplay
### Začetek:
1. **Zberi vire** - Hodi po mapi in zberi wood, stone
2. **Crafti orodja** - Pritisni C in izdelaj axe, pickaxe
3. **Farmi** - Pritisni SPACE na grass za till, nato plant seeds
4. **Jedi in pij** - Hunger in thirst pada, jedi hrano!
5. **Preživi noč** - Vsako 7. noč je Horde Night!
### Napredovanje:
- **Level Up** - Zberi XP za akcije
- **Build** - Postavi fences, barns, houses
- **Craft** - Izdelaj boljša orodja
- **Explore** - Raziskuj 100x100 mapo
---
## 📁 Project Structure
```
novafarma/
├── 📁 src/ # Source code
│ ├── scenes/ # Game scenes (PreloadScene, GameScene, UIScene, StoryScene)
│ ├── systems/ # Game systems (TerrainSystem, WeatherSystem, etc.)
│ ├── entities/ # Game entities (Player, NPC, etc.)
│ ├── ui/ # UI components
│ └── utils/ # Utility functions
├── 📁 assets/ # Game assets
│ ├── sprites/ # Character sprites
│ └── [other assets] # Tiles, objects, etc.
├── 📁 docs/ # Documentation
│ ├── planning/ # Development plans, FAZA checklists
│ ├── guides/ # User guides, testing guides
│ ├── sessions/ # Development session summaries
│ └── design/ # Design documents, GDD
├── 📁 tools/ # Development tools
│ └── python/ # Python scripts (sprite processing)
├── 📁 archive/ # Archived files
│ ├── tests/ # Old test files
│ ├── backups/ # Backup folders
│ └── deprecated/ # Deprecated code
├── 📁 dist/ # Distribution builds
├── 📁 build/ # Build output
├── 📄 index.html # Main HTML file
├── 📄 main.js # Electron main process
├── 📄 server.js # Development server
├── 📄 package.json # NPM dependencies
├── 📄 README.md # This file
├── 📄 CHANGELOG.md # Version history
└── 📄 TASKS.md # Development tasks
```
---
## 📊 Features
### Core Gameplay:
✅ Farming (till, plant, harvest)
✅ Building (fences, barns, houses)
✅ Crafting (13 receptov)
✅ Resource gathering (auto-pickup)
### Survival:
✅ Hunger/Thirst system
✅ Day/Night cycle (24h = 5 min)
✅ Weather (rain, storm)
✅ Seasons (4 seasons)
✅ Health regeneration
### UI:
✅ HP/Hunger/Thirst bars
✅ Minimap (150x150px)
✅ Inventory (9 slots)
✅ Clock
✅ Performance Monitor (F3)
### NPCs:
✅ 3 NPCs with random walk AI
✅ Visible on minimap
### Sound:
✅ 6 sound effects
✅ Background music
### Save/Load:
✅ 3 save slots
✅ Auto-save (5 min)
✅ F5/F9 shortcuts
### Performance:
✅ Culling system
✅ Object pooling
✅ FPS Monitor
✅ 60 FPS target
---
## 🐛 Znani Problemi
1. **Windows SmartScreen Opozorilo**
- Aplikacija ni code-signed
- Klikni "More info" → "Run anyway"
2. **Ikona**
- Privzeta Electron ikona (ne custom)
3. **Velikost**
- ~225 MB (normalno za Electron apps)
---
## 📝 Changelog
### v2.5.0 (2025-12-12)
- ✅ Dodana minimap
- ✅ Dodani sound effects (6)
- ✅ Dodan NPC spawner (3 NPCs)
- ✅ Dodan performance monitor
- ✅ Optimizacije (culling, pooling)
- ✅ Save/Load system (3 slots)
- ✅ Survival mehanike (hunger, thirst)
- ✅ Dan/Noč cikel + weather
---
## 🏆 Credits
**Razvito z:**
- Phaser.js (Game Engine)
- Electron.js (Desktop App)
- Node.js (Server)
**Verzija:** 2.5.0
**Datum:** 12. December 2025
**Licenca:** MIT
---
## 📧 Podpora
**Našli ste bug?**
Odprite issue na GitHub: [github.com/novafarma/issues](https://github.com)
**Vprašanja?**
Email: support@novafarma.com
**Discord:**
[discord.gg/novafarma](https://discord.gg)
---
## 🎉 Hvala za Igranje!
Uživajte v NovaFarma! 🌾✨
**Made with ❤️ by NovaFarma Team**