https://github.com/gabe565/ascii-movie

Star Wars SSH + Telnet server written in Go.
https://github.com/gabe565/ascii-movie

ascii-art golang ssh star-wars telnet tui

Last synced: 5 days ago
JSON representation

Star Wars SSH + Telnet server written in Go.

• Host: GitHub
• URL: https://github.com/gabe565/ascii-movie
• Owner: gabe565
• License: gpl-3.0
• Created: 2022-09-27T07:35:44.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-25T16:19:37.000Z (18 days ago)
• Last Synced: 2024-12-01T08:08:54.181Z (12 days ago)
• Topics: ascii-art, golang, ssh, star-wars, telnet, tui
• Language: Go
• Homepage:
• Size: 898 KB
• Stars: 220
• Watchers: 3
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-terminal-art - movie.gabe565.com
• charm-in-the-wild - ASCII Movie - A Star Wars ASCII art movie player. (_built with Bubble Tea_) (Applications / Games)

README

        
# ASCII Movie



[![GitHub release (latest by date)](https://img.shields.io/github/v/release/gabe565/ascii-movie)](https://github.com/gabe565/ascii-movie/releases)

[![Build](https://github.com/gabe565/ascii-movie/actions/workflows/build.yml/badge.svg)](https://github.com/gabe565/ascii-movie/actions/workflows/build.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/gabe565/ascii-movie)](https://goreportcard.com/report/github.com/gabe565/ascii-movie)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gabe565_ascii-movie&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gabe565_ascii-movie)

Stream the original Star Wars ASCII movie to command-line clients via SSH or Telnet.

Inspired by [asciimation](https://asciimation.co.nz) and the iconic [towel.blinkenlights.nl](https://web.archive.org/web/20021205144143/http://www.blinkenlights.nl/thereg/), this Go rewrite introduces an interactive UI with both keyboard and mouse support.

## Try It

Run one of these commands in a terminal to see it in action:

- **SSH:** `ssh starwarstel.net`

- **Telnet:** `telnet starwarstel.net`

- **Docker:** `docker run --rm -it ghcr.io/gabe565/ascii-movie play`



  



  Also available on asciinema

  


    

  


## Installation

See [Installation](https://github.com/gabe565/ascii-movie/wiki/Installation).

## Usage

The app can play a movie directly on your terminal with the [`play`](docs/ascii-movie_play.md) subcommand, or it can host SSH and Telnet servers with the [`serve`](docs/ascii-movie_serve.md) subcommand.

See generated [docs](./docs/ascii-movie.md) for command line usage information.

### Docker (Suggested)

An image is available at [`ghcr.io/gabe565/ascii-movie`](https://ghcr.io/gabe565/ascii-movie).

#### Watch Locally

The following command will run a container that plays the movie directly in your terminal.

```shell

sudo docker run --rm -it ghcr.io/gabe565/ascii-movie play

```

#### Serve Movie over Telnet and SSH

The following command will run a Telnet server on port `23` and an SSH server on port `2222`.

```shell

sudo docker run --port=22:22 --port=23:23 ghcr.io/gabe565/ascii-movie serve

```

### Other

See [Usage](https://github.com/gabe565/ascii-movie/wiki/Usage).