An open API service indexing awesome lists of open source software.

https://github.com/deadronos/stellar-shell

voxel mining and building a dyson sphere
https://github.com/deadronos/stellar-shell

Last synced: about 2 months ago
JSON representation

voxel mining and building a dyson sphere

Awesome Lists containing this project

README

          

# Stellar Shell

Stellar Shell is a sci-fi voxel automation game where you command a swarm of autonomous drones to strip-mine asteroids and build a megastructure in space.

![License](https://img.shields.io/badge/license-MIT-blue)
![Version](https://img.shields.io/badge/version-0.0.0-orange)

## 🎮 Gameplay

You play as an overseer of a drone swarm. Your goal is to gather resources ("Matter") and use them to expand your fleet and build structures.

- **Explore**: A procedurally generated voxel asteroid field.
- **Mine**: Use your laser or command drones to harvest **Matter** from asteroids.
- **Build**: Place blueprints for structures. Your drones will automatically find tasks and build them using collected matter.
- **Expand**: Construct more drones to increase your harvesting and building power.

## đŸ•šī¸ Controls

- **W, A, S, D**: Move Camera
- **Space / Shift**: Move Up / Down
- **Mouse Drag**: Look around
- **1**: Select Laser tool
- **2**: Select Frame tool
- **Left Click**: Mine / interact with the Laser tool
- **Right Click**: Place a frame blueprint with the build tool

## đŸ› ī¸ Features

- **Voxel Engine**: Built on `@astrumforge/bvx-kit` for performant, destructible voxel worlds.
- **ECS Architecture**: Powered by `miniplex` for managing thousands of entities.
- **Drone "Brains"**: Autonomous behavior for mining and building tasks.
- **Reactive UI**: Built with React and Zustand.

## 🚀 Getting Started

### Prerequisites

- Node.js (v18+)

### Installation

1. Clone the repository
2. Install dependencies (pnpm required):

```bash
pnpm install
```

### Running Locally

```bash
pnpm dev
```

Open [http://localhost:5173](http://localhost:5173) to view it in the browser.

### GitHub Pages Deployment

Production builds are configured with the `/stellar-shell/` base path so the app
loads correctly from `https://deadronos.github.io/stellar-shell/`.

### Package Manager

This project uses pnpm. Use pnpm 10.29.3 (or newer 10.x) to match the lockfile and CI.

## đŸ—ī¸ Tech Stack

- **Framework**: [React 19](https://react.dev) + [Vite](https://vitejs.dev)
- **3D Engine**: [Three.js](https://threejs.org) + [React Three Fiber](https://docs.pmnd.rs/react-three-fiber)
- **ECS**: [Miniplex](https://github.com/hmans/miniplex)
- **State**: [Zustand](https://github.com/pmndrs/zustand)
- **Styling**: [Tailwind CSS](https://tailwindcss.com)

## 📄 License

MIT