RoomForge

RoomForge is a browser-based interior planning demo for fast layout exploration, furniture swapping, and presentation-ready review.

Why this project exists

Most room planners force a tradeoff between technical floor-plan editing and visual presentation. RoomForge exists to collapse that gap into one workflow:

• build quickly on a 1:1 meter grid
• evaluate the same project in 2D and isometric
• replace furniture variants without leaving the scene

Features

• Apartment / House project types
• ready-made templates for Studio, 1-Bedroom, 2-Bedroom, House 80 m², House 120 m², Office, Bedroom, and Kitchen-Living Room
• shared planner state across 2D and Isometric
• categorized furniture library with five variants per item tier: Compact, Standard, Premium, Minimal, Statement
• right-side inspector with selection details, color changes, replacement options, duplication, locking, rotation, and deletion
• drag-and-drop placement in the 2D planner
• live layout validation checks

Modes

• 2D: primary planning mode with a meter grid, room resizing, room movement, and item placement
• Isometric: cutaway presentation mode for polished layout review

Templates

• Studio
• 1-Bedroom
• 2-Bedroom
• House 80 m²
• House 120 m²
• Office
• Bedroom
• Kitchen-Living Room

Styles

• Minimal
• Scandinavian
• Japandi
• Loft
• Warm Neutral
• Modern Classic

Lighting

• Day
• Evening
• Warm Light
• Cool Light
• Night

How to run

npx roomforge

npx roomforge is the recommended user-facing entrypoint. It will:

• download the published RoomForge package from npm
• start a local server for the built demo
• pick an available port automatically
• open RoomForge in your default browser

You only need Node.js and npm installed locally.

Useful options:

npx roomforge --port 4173
npx roomforge --host 0.0.0.0
npx roomforge --no-open

Develop locally

For contributors working from a cloned repository, use:

npm start

npm start is the recommended local development entrypoint. It will:

• install dependencies automatically if they are missing
• start the Vite dev server
• wait until the app is reachable
• open RoomForge in your default browser

Advanced developer-only flow:

npm run setup
npm run dev

Build for production:

npm run build

Release workflow

• CI runs on every push to main and every pull request
• it installs dependencies, builds the app, packs the npm tarball, installs it into a clean temp directory, and smoke-tests the packaged roomforge CLI
• Publish runs on GitHub Release publish or manual dispatch and executes npm publish --access public --provenance

Before using the publish workflow, add an NPM_TOKEN repository secret with publish access to the roomforge package.

Demo deployment

The project is Vite-based and ready for Vercel deployment. The included vercel.json routes all requests to the SPA entry.

How to contribute

See CONTRIBUTING.md for local setup, scope guidance, and contribution expectations.

Good first issue

• add richer door/window authoring to the 2D planner
• improve library search and room-aware recommendations
• split heavy scene bundles with dynamic imports
• add dedicated Playwright coverage for both 2D and isometric modes

Roadmap

See ROADMAP.md.

Support

• Support the project
• Crypto support