homecast/README.md

<!-- Header -->

<div id="top" align="center">
  <br />

  <!-- Logo -->

  <img src="https://git.zakscode.com/repo-avatars/8be45ee4b7c1acd45c73cfc7e9c189f139d69a1c9ec9aba29849ae6a8a0cfb40" alt="Logo" width="200" height="200">

  <!-- Title -->

### Homecast

  <!-- Description -->

A homebrew Chromecast

  <!-- Repo badges -->

[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version\&style=for-the-badge\&url=https://git.zakscode.com/api/v1/repos/ztimson/homecast/tags\&query=$\[0\].name)](https://git.zakscode.com/ztimson/homecast/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests\&style=for-the-badge\&url=https://git.zakscode.com/api/v1/repos/ztimson/homecast\&query=open_pr_counter)](https://git.zakscode.com/ztimson/homecast/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues\&style=for-the-badge\&url=https://git.zakscode.com/api/v1/repos/ztimson/homecast\&query=open_issues_count)](https://git.zakscode.com/ztimson/homecast/issues)

  <!-- Links -->

---

  <div>
    <a href="https://git.zakscode.com/ztimson/homecast/wiki" target="_blank">Documentation</a>
    • <a href="https://git.zakscode.com/ztimson/homecast/releases" target="_blank">Release Notes</a>
    • <a href="https://git.zakscode.com/ztimson/homecast/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
    • <a href="https://git.zakscode.com/ztimson/homecast/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
  </div>

---

</div>

## Table of Contents

* [Homecast](#top)
  * [About](#about)
    * [Built With](#built-with)
  * [Setup](#setup)
    * [Production](#production)
    * [Development](#development)
  * [License](#license)

## About

Homecast is a homebrew, Chromecast-style streaming appliance built around a Raspberry Pi connected to a television.

The goal is to provide a simple, self-hosted casting and media experience while retaining complete control over the underlying hardware and software.

Features include:
- Installs ontop of any Rasbian + Wayland OS
    - Allows you to fully customize and use as your own media center
- Remote desktop into the pi via the browser on any device
	- Mirrors to the TV
- Install the PWA via the browser to get the remote control app
	- Use the share button built into any site / app to cast media to Homecast
- Custom screen savers, automatic background music, and AI harness integration

### Built With

[![Linux](https://img.shields.io/badge/Linux-eeeeee?style=for-the-badge\&logo=linux\&logoColor=000000)](https://www.linux.org/)
[![Node](https://img.shields.io/badge/Node.js-000000?style=for-the-badge\&logo=nodedotjs)](https://nodejs.org/)
[![JavaScript](https://img.shields.io/badge/JavaScript-000000?style=for-the-badge\&logo=javascript)](https://javascript.com/)
[![HTML](https://img.shields.io/badge/HTML-FFFFFF?style=for-the-badge\&logo=html5)](https://developer.mozilla.org/en-US/docs/Glossary/HTML)
[![CSS](https://img.shields.io/badge/CSS-1572B6?style=for-the-badge\&logo=css3)](https://www.w3.org/Style/CSS/Overview.en.html)
[![Raspberry Pi](https://img.shields.io/badge/Raspberry%20Pi-A22846?style=for-the-badge\&logo=raspberrypi\&logoColor=white)](https://www.raspberrypi.com/)
[![Wayland](https://img.shields.io/badge/Wayland-FFBC00?style=for-the-badge\&logo=wayland\&logoColor=black)](https://wayland.freedesktop.org/)
[![WebSocket](https://img.shields.io/badge/WebSocket-000000?style=for-the-badge)](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)
[![noVNC](https://img.shields.io/badge/noVNC-000000?style=for-the-badge)](https://novnc.com/)

## Setup

<details>
<summary>
  <h3 id="production" style="display: inline">
    Production
  </h3>
</summary>

#### Prerequisites

- Raspberry Pi 4/5 (2GB min/4GB ideal)
- Updated version of Raspberry Pi OS

#### Instructions

1. Install homecast: `curl -sL https://git.zakscode.com/ztimson/homecast/raw/branch/master/install.sh | sudo bash`

</details>

<details>
<summary>
  <h3 id="development" style="display: inline">
    Development
  </h3>
</summary>

#### Prerequisites

* Node.js

#### Instructions

1. Clone the repository.
2. Install the dependencies: `npm install`
3. Start the development server: `npm run start`

</details>

## License

Copyright © 2026 Zakary Timson | Available under MIT Licensing