shrani
101
PROJECT_CLEANUP_COMPLETE.md
Normal file
@@ -0,0 +1,101 @@
|
||||
# ✅ PROJECT CLEANUP COMPLETED
|
||||
**Date:** 2025-12-12
|
||||
**Status:** SUCCESS ✅
|
||||
|
||||
---
|
||||
|
||||
## 📊 **Summary:**
|
||||
|
||||
### **Files Organized:**
|
||||
- ✅ **92 files** in root → **10 essential files** in root
|
||||
- ✅ **82 files** moved to organized directories
|
||||
- ✅ **0 files deleted** (all preserved in archive/)
|
||||
|
||||
### **New Directory Structure:**
|
||||
|
||||
```
|
||||
📁 docs/
|
||||
├── planning/ (20 files) - FAZA checklists, development plans
|
||||
├── guides/ (12 files) - User guides, testing documentation
|
||||
├── sessions/ (14 files) - Development session summaries
|
||||
└── design/ (11 files) - Design documents, GDD, roadmaps
|
||||
|
||||
📁 tools/
|
||||
└── python/ (4 files) - Sprite processing scripts
|
||||
|
||||
📁 archive/
|
||||
├── tests/ (9 files) - Old test files
|
||||
├── backups/ (2 dirs) - Backup folders
|
||||
└── deprecated/ (4 files) - Old builds, deprecated docs
|
||||
```
|
||||
|
||||
### **Root Directory (Clean!):**
|
||||
```
|
||||
✅ package.json
|
||||
✅ package-lock.json
|
||||
✅ index.html
|
||||
✅ main.js
|
||||
✅ server.js
|
||||
✅ README.md
|
||||
✅ CHANGELOG.md
|
||||
✅ TASKS.md
|
||||
✅ .gitignore
|
||||
✅ novafarma.code-workspace
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **Actions Taken:**
|
||||
|
||||
1. ✅ Created organized directory structure
|
||||
2. ✅ Moved Python scripts to `tools/python/`
|
||||
3. ✅ Moved test files to `archive/tests/`
|
||||
4. ✅ Moved backup folders to `archive/backups/`
|
||||
5. ✅ Moved documentation to `docs/` (4 categories)
|
||||
6. ✅ Moved deprecated files to `archive/deprecated/`
|
||||
7. ✅ Updated README.md with new structure
|
||||
8. ✅ Tested game - **STILL WORKS!** ✅
|
||||
|
||||
---
|
||||
|
||||
## 📈 **Benefits:**
|
||||
|
||||
- ✨ **Cleaner root directory** - easier to navigate
|
||||
- 📚 **Organized documentation** - easier to find
|
||||
- 🔧 **Separated tools** - clear development workflow
|
||||
- 📦 **Archived old files** - preserved but out of the way
|
||||
- 🚀 **Better maintainability** - professional structure
|
||||
|
||||
---
|
||||
|
||||
## 🔍 **File Locations:**
|
||||
|
||||
### **Need to find something?**
|
||||
|
||||
- **Development plans?** → `docs/planning/`
|
||||
- **User guides?** → `docs/guides/`
|
||||
- **Session notes?** → `docs/sessions/`
|
||||
- **Design docs?** → `docs/design/`
|
||||
- **Python scripts?** → `tools/python/`
|
||||
- **Old tests?** → `archive/tests/`
|
||||
- **Backups?** → `archive/backups/`
|
||||
|
||||
---
|
||||
|
||||
## ✅ **Verification:**
|
||||
|
||||
- ✅ Game runs successfully
|
||||
- ✅ All files preserved (no data loss)
|
||||
- ✅ README.md updated
|
||||
- ✅ Structure documented
|
||||
- ✅ Professional organization
|
||||
|
||||
---
|
||||
|
||||
## 🎉 **Result:**
|
||||
|
||||
**Project is now professionally organized and easier to maintain!**
|
||||
|
||||
The codebase is clean, documentation is organized, and the project structure follows best practices. All files are preserved in appropriate locations for easy access.
|
||||
|
||||
**Status:** READY FOR DEVELOPMENT ✅
|
||||
150
PROJECT_CLEANUP_PLAN.md
Normal file
@@ -0,0 +1,150 @@
|
||||
# 🗂️ PROJECT CLEANUP & ORGANIZATION PLAN
|
||||
**Date:** 2025-12-12
|
||||
**Goal:** Organize NovaFarma project structure for better maintainability
|
||||
|
||||
---
|
||||
|
||||
## 📁 **Current Issues:**
|
||||
- ❌ 92 files in root directory (too many!)
|
||||
- ❌ Multiple `.md` documentation files scattered
|
||||
- ❌ Test files (`.js`) mixed with main code
|
||||
- ❌ Backup folders in root
|
||||
- ❌ Python scripts in root
|
||||
|
||||
---
|
||||
|
||||
## ✅ **Proposed Structure:**
|
||||
|
||||
```
|
||||
c:\novafarma\
|
||||
├── 📁 docs/ # All documentation
|
||||
│ ├── planning/ # FAZA checklists, plans
|
||||
│ ├── guides/ # User guides, testing
|
||||
│ ├── sessions/ # Session summaries
|
||||
│ └── design/ # Design docs, GDD
|
||||
│
|
||||
├── 📁 tools/ # Development tools
|
||||
│ ├── python/ # Python scripts (sprites, bg removal)
|
||||
│ └── build/ # Build scripts
|
||||
│
|
||||
├── 📁 archive/ # Old files, backups
|
||||
│ ├── backups/ # Backup folders
|
||||
│ ├── tests/ # Old test files
|
||||
│ └── deprecated/ # Deprecated code
|
||||
│
|
||||
├── 📁 src/ # Source code (ALREADY ORGANIZED ✅)
|
||||
│ ├── scenes/
|
||||
│ ├── systems/
|
||||
│ ├── entities/
|
||||
│ ├── ui/
|
||||
│ └── utils/
|
||||
│
|
||||
├── 📁 assets/ # Game assets (ALREADY ORGANIZED ✅)
|
||||
│ ├── sprites/
|
||||
│ └── [other assets]
|
||||
│
|
||||
├── 📁 dist/ # Distribution builds
|
||||
├── 📁 build/ # Build output
|
||||
├── 📁 node_modules/ # Dependencies
|
||||
│
|
||||
└── 📄 [Root Files - KEEP ONLY ESSENTIAL]
|
||||
├── package.json ✅ KEEP
|
||||
├── package-lock.json ✅ KEEP
|
||||
├── index.html ✅ KEEP
|
||||
├── main.js ✅ KEEP
|
||||
├── server.js ✅ KEEP
|
||||
├── README.md ✅ KEEP
|
||||
├── CHANGELOG.md ✅ KEEP
|
||||
├── TASKS.md ✅ KEEP
|
||||
├── .gitignore ✅ KEEP
|
||||
└── novafarma.code-workspace ✅ KEEP
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🗑️ **Files to MOVE (not delete):**
|
||||
|
||||
### → `docs/planning/`
|
||||
- FAZA_*_CHECKLIST.md (17 files)
|
||||
- TASKS_*.md
|
||||
- NEXT_STEPS.md
|
||||
- FUTURE_TASKS.md
|
||||
- dev_plan.md
|
||||
- optimizations.md
|
||||
|
||||
### → `docs/guides/`
|
||||
- ACCESSIBILITY.md
|
||||
- ACCESSIBILITY_IMPLEMENTATION_PLAN.md
|
||||
- ANDROID_GUIDE.md
|
||||
- COLLISION_GUIDE.md
|
||||
- DISTRIBUTION_GUIDE.md
|
||||
- FARMING_GUIDE.md
|
||||
- KAKO_OSVEZITI_IGRO.md
|
||||
- TESTING_GUIDE.md
|
||||
- TRANSLATION_TESTING.md
|
||||
- MP4_VIDEO_GUIDE.md
|
||||
- STEAM_INTEGRATION_PLAN.md
|
||||
- SYSTEM_REQUIREMENTS.md
|
||||
|
||||
### → `docs/sessions/`
|
||||
- SESSION_*.md (11 files)
|
||||
- DNEVNIK.md
|
||||
- FINAL_SESSION*.md
|
||||
|
||||
### → `docs/design/`
|
||||
- DESIGN_DOC.md
|
||||
- GDD.md
|
||||
- ADVANCED_*.md
|
||||
- ATMOSPHERIC_EFFECTS.md
|
||||
- BUILDING_CONTROLS_PLAN.md
|
||||
- DLC_ROADMAP.md
|
||||
- FENCE_IMPLEMENTATION_SUMMARY.md
|
||||
- KICKSTARTER_PLAN.md
|
||||
- OPEN_WORLD_PLAN.md
|
||||
- SEZNAM_STAVB_IN_DEKORACIJ.md
|
||||
- UI_IMPROVEMENTS_*.md
|
||||
|
||||
### → `tools/python/`
|
||||
- make_spritesheet.py
|
||||
- process_sprites.py
|
||||
- remove_backgrounds.py
|
||||
- ultra_remove_bg.py
|
||||
|
||||
### → `archive/tests/`
|
||||
- ADVANCED_BUILD_MODE_CODE.js
|
||||
- GAMESCENE_KEYBOARD_BINDINGS.js
|
||||
- QUICK_VIDEO_TEST.js
|
||||
- STAMINA_SYSTEM_INTEGRATION.js
|
||||
- TEST_FENCE_PLACEMENT.js
|
||||
- VIDEO_CHARACTER_TEST.js
|
||||
- clear_all_saves.js
|
||||
- clear_save.js
|
||||
- test_water_animation.js
|
||||
|
||||
### → `archive/backups/`
|
||||
- backup_faza11_2025-12-11/
|
||||
- backup_faza11_extracted/
|
||||
|
||||
### → `archive/deprecated/`
|
||||
- NovaFarma-v2.5.0-Windows.zip (old build)
|
||||
- BUILD_TEST_RESULTS.md
|
||||
- COMMIT_PHASE23.md
|
||||
- DISTRIBUTION_PACKAGE.md
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **Action Plan:**
|
||||
|
||||
1. ✅ Create new directories
|
||||
2. ✅ Move files to appropriate locations
|
||||
3. ✅ Update README.md with new structure
|
||||
4. ✅ Test that game still runs
|
||||
5. ✅ Commit changes with clear message
|
||||
|
||||
---
|
||||
|
||||
## 📝 **Notes:**
|
||||
- **DO NOT DELETE** any files - only move/organize
|
||||
- Keep git history intact
|
||||
- Update any hardcoded paths if needed
|
||||
- Test game after reorganization
|
||||
43
README.md
@@ -93,6 +93,49 @@ NovaFarma je 2.5D izometrična survival farming igra, kjer upravljaš svojo farm
|
||||
|
||||
---
|
||||
|
||||
## 📁 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:
|
||||
|
||||
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 830 KiB After Width: | Height: | Size: 830 KiB |
|
Before Width: | Height: | Size: 559 KiB After Width: | Height: | Size: 559 KiB |
|
Before Width: | Height: | Size: 450 KiB After Width: | Height: | Size: 450 KiB |
|
Before Width: | Height: | Size: 519 KiB After Width: | Height: | Size: 519 KiB |
|
Before Width: | Height: | Size: 848 KiB After Width: | Height: | Size: 848 KiB |
|
Before Width: | Height: | Size: 568 KiB After Width: | Height: | Size: 568 KiB |
|
Before Width: | Height: | Size: 538 KiB After Width: | Height: | Size: 538 KiB |
|
Before Width: | Height: | Size: 441 KiB After Width: | Height: | Size: 441 KiB |
|
Before Width: | Height: | Size: 894 KiB After Width: | Height: | Size: 894 KiB |
|
Before Width: | Height: | Size: 661 KiB After Width: | Height: | Size: 661 KiB |
|
Before Width: | Height: | Size: 522 KiB After Width: | Height: | Size: 522 KiB |
|
Before Width: | Height: | Size: 304 KiB After Width: | Height: | Size: 304 KiB |
|
Before Width: | Height: | Size: 317 KiB After Width: | Height: | Size: 317 KiB |
|
Before Width: | Height: | Size: 520 KiB After Width: | Height: | Size: 520 KiB |
|
Before Width: | Height: | Size: 158 KiB After Width: | Height: | Size: 158 KiB |
|
Before Width: | Height: | Size: 367 KiB After Width: | Height: | Size: 367 KiB |
|
Before Width: | Height: | Size: 106 KiB After Width: | Height: | Size: 106 KiB |
|
Before Width: | Height: | Size: 600 KiB After Width: | Height: | Size: 600 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 185 KiB After Width: | Height: | Size: 185 KiB |
|
Before Width: | Height: | Size: 472 KiB After Width: | Height: | Size: 472 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 710 KiB After Width: | Height: | Size: 710 KiB |
|
Before Width: | Height: | Size: 149 KiB After Width: | Height: | Size: 149 KiB |
|
Before Width: | Height: | Size: 360 KiB After Width: | Height: | Size: 360 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 503 KiB After Width: | Height: | Size: 503 KiB |