Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/remarkablegames/water-pipe

🚰 Water Pipe is a puzzle where you connect all the pipes
https://github.com/remarkablegames/water-pipe

casual-game game javascript kaboom pipe puzzle typescript water web

Last synced: 22 days ago
JSON representation

🚰 Water Pipe is a puzzle where you connect all the pipes

Awesome Lists containing this project

README

        


Water Pipe

# Water Pipe

![release](https://img.shields.io/github/v/release/remarkablegames/water-pipe)
[![build](https://github.com/remarkablegames/water-pipe/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablegames/water-pipe/actions/workflows/build.yml)

🚰 Water Pipe is a puzzle where you connect all the pipes.

The game was made for [Pixel Game Jam 2024](https://itch.io/jam/-pixel-game-jam-2024), which the theme was `AQUA`. See the [Replit](https://replit.com/@remarkablemark/Water-Pipe) demo and read the [blog post](https://remarkablegames.org/posts/water-pipe/).

Play the game on:

- [remarkablegames](https://remarkablegames.org/water-pipe/)
- [itch.io](https://remarkablegames.itch.io/water-pipe)
- [Newgrounds](https://www.newgrounds.com/portal/view/930938)

## Credits

### Art

- [Kenney - Puzzle Pack 2](https://kenney.nl/assets/puzzle-pack-2)
- Photo by [Bernard Hermant](https://unsplash.com/@bernardhermant) on [Unsplash](https://unsplash.com/photos/brown-concrete-brick-t4DuoDHjxrQ)

### Sounds

- [Kenney - UI Audio](https://kenney.nl/assets/ui-audio)
- [Pixabay - SPLASH](https://pixabay.com/sound-effects/splash-by-blaukreuz-6261/)
- [Pixabay - Gentle ocean waves birdsong and gull](https://pixabay.com/sound-effects/gentle-ocean-waves-birdsong-and-gull-7109/)

## Stack

- [Kaboom](https://kaboomjs.com/)
- [Vite](https://vitejs.dev/)
- [GitHub Pages](https://pages.github.com/)

## Prerequisites

- [nvm](https://github.com/nvm-sh/nvm#readme)

## Install

Clone the repository:

```sh
git clone https://github.com/remarkablegames/water-pipe.git
cd water-pipe
```

Use the Node.js version:

```sh
nvm use
```

Install the dependencies:

```sh
npm install
```

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the game in the development mode.

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

The page will reload if you make edits.

You will also see any errors in the console.

### `npm run build`

Builds the game for production to the `dist` folder.

It correctly bundles in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your game is ready to be deployed!

### `npm run bundle`

Builds the game and packages it into a Zip file in the `dist` folder.

Your game can be uploaded to your server, [Itch.io](https://itch.io/), [Newgrounds](https://www.newgrounds.com/), etc.

## License

[MIT](LICENSE)