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

https://github.com/deadronos/idle-dungeon-crawler

Idle Dungeon Crawler A browser-based incremental RPG where you manage a party of heroes fighting through dungeon floors.
https://github.com/deadronos/idle-dungeon-crawler

Last synced: 10 days ago
JSON representation

Idle Dungeon Crawler A browser-based incremental RPG where you manage a party of heroes fighting through dungeon floors.

Awesome Lists containing this project

README

          

# Idle Dungeon Crawler

A browser-based incremental RPG where you manage a party of heroes fighting through dungeon floors. The project uses React + TypeScript + Vite and is structured with explicit architecture documentation in `docs/ARCHITECTURE`.

## Demo Screenshot

![Demo Screenshot](https://raw.githubusercontent.com/deadronos/idle-dungeon-crawler/main/image.png)

## Features

- Solo hero start with expandable party growth up to five adventurers
- Shop-based party slot unlocks and class-based recruitment
- Active Time Battle (ATB) simulation
- Selector-based `zustand` game store with compatibility provider support
- Separate toggles for Autofight and Autoadvance to enable strategic farming
- Persistent gold-upgrades via an in-game shop
- Local autosaves plus JSON export/import for sharing or backing up runs
- Live combat log and per-unit skill banners
- Tailwind CSS + shadcn/Base UI styling
- Full testing suite with Vitest + Testing Library
- GitHub Pages deployment on `v*` tags

## Getting started

```sh
# install dependencies
npm ci

# run development server
npm run dev

# build production
npm run build
```

## Testing

Run the full test set with coverage:

```sh
npm run test
```

Interactive watch mode:

```sh
npm run test:watch
```

## Deployment

Deploys automatically to GitHub Pages at `https://deadronos.github.io/idle-dungeon-crawler/` when a tag matching `v*` is pushed (or via manual workflow dispatch). The workflow now uses `actions/configure-pages` and `actions/deploy-pages` for reliability; authentication is granted via scoped permissions in the YAML. Edit the `base` field in `vite.config.ts` or adjust the workflow if the repository path changes.

Tag and push to release:

```sh
git tag v1.0.0
git push origin v1.0.0
```

## License

This repository is licensed under the MIT license. See [LICENSE.md](LICENSE.md) for details.

## Disclosure

Art generated mostly using Gemini.