Souler

A contemplative Three.js solar system — realistic orbits, adjustable time, and a quiet window on the cosmos.

One-line description

Souler is a soulful, sped-up solar system simulation with realistic orbits, stars, and a modern glass HUD built in Three.js.

Features

• Sun through Neptune with Keplerian orbits (eccentricity, inclination, axial tilt & spin)
• Earth’s moon, Saturn’s rings, asteroid belt, starfield, and soft nebulae
• Adjustable time flow (still → years and ages)
• Play / pause / reset, orbit lines, labels, motion trails
• Focus any body for poetic info and a smooth camera ease-in
• Bloom lighting and a glassmorphism HUD

Quick start

cd D:\Codebase\MVPs\Souler
npm install
npm run dev

Open http://localhost:5173/

npm run build    # production build → dist/
npm run preview  # preview production build

Deploy to GitHub Pages

Live URL (after Pages is enabled): https://temidayoxyz.github.io/souler/

1. In the repo on GitHub: Settings → Pages
2. Under Build and deployment → Source, choose GitHub Actions
3. Push to main (or run the Deploy to GitHub Pages workflow manually)

Vite is configured with base: '/souler/' so asset paths match the project site URL. The workflow in .github/workflows/deploy.yml builds and publishes dist/ automatically.

Controls

Action	How
Look around	Drag
Zoom	Scroll
Focus a world	Right-side body rail
Time speed	Bottom slider
Pause / play	Space or dock button
Nudge speed	[ / ]

Stack

• Three.js — WebGL scene, postprocessing bloom, OrbitControls, CSS2D labels
• Vite — dev server and build

Project layout

Souler/
  index.html
  package.json
  vite.config.js
  src/
    main.js    # scene, orbits, camera, UI wiring
    data.js    # body facts and poetry
    style.css  # HUD and atmosphere

License

Private MVP — all rights reserved unless otherwise noted.