Skip to content

RobbyCBennett/SeeSlug

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

See Slug

Web server to stream or download videos

  • Install See Slug on your server

  • Stream or download videos in the web interface

Web Interface

Browse Page

Keyboard shortcuts:

  • Arrows: Move up, down, left, and right
  • Space/Enter: Click on the video/collection link
  • Letter: Go to the first video starting with that character

Watch Page

Keyboard shortcuts:

  • C: Captions
  • F: Fullscreen
  • P: Picture in Picture
  • Space: Play/pause
  • Left/Right: Go back/forward 5 seconds

Build

  1. Install git and rustup

  2. Clone and build

    git clone https://github.com/RobbyCBennett/SeeSlug.git seeslug
    cd seeslug
    cargo build --release

Install

  1. Get the executable

  2. Gather your movies and shows into one place

  3. Configure your system to run the executable as a startup service

Naming and Organization

  • All videos, posters, subtitles, and subfolders must be under 1 folder
  • Videos are sorted alphabetically, so consider putting them in collections and prepending a number
  • To show a poster, give it the basename of the video or subfolder like VIDEO.png
  • To get a subtitle, give it the basename of the video like VIDEO.vtt where English is assumed
  • Specify the subtitle language with VIDEO.LANG.vtt (to add support for other languages, edit src/languages.rs)
    • ar: Arabic
    • bn: Bengali
    • en: English
    • es: Spanish
    • fr: French
    • hi: Hindi
    • pt: Portuguese
    • ru: Russian
    • ur: Urdu
    • zh: Chinese
  • Subtitles can be enabled by default with VIDEO.default.vtt or VIDEO.default.LANG.vtt
  • Example file structure:
    • Inception.mp4
    • Inception.png
    • Inception.vtt
    • Indiana Jones.jpg
    • Indiana Jones
      • 1: Raiders of the Lost Ark.default.vtt
      • 1: Raiders of the Lost Ark.mp4
      • 1: Raiders of the Lost Ark.webp
      • 2: Indiana Jones and the Temple of Doom.en.vtt
      • 2: Indiana Jones and the Temple of Doom.mp4
      • 2: Indiana Jones and the Temple of Doom.png
      • 3: Indiana Jones and the Last Crusade.default.en.vtt
      • 3: Indiana Jones and the Last Crusade.es.vtt
      • 3: Indiana Jones and the Last Crusade.mp4
      • 3: Indiana Jones and the Last Crusade.png

Optional Command Line Arguments

Configuration:

  • --folder: Folder which contains the posters, subtitles, and videos (string)
  • --port: TCP port to listen to (integer from 0 to 65535)

Other:

  • --help or -h: Display the help text
  • --version or -v: Display the version text

Supported Formats

Video File Extensions

  • .mp4

Poster File Extensions

  • .jpeg
  • .jpg
  • .png
  • .webp

Subtitle File Extensions

  • .vtt