Git Product home page Git Product logo

tuitch's Introduction

tuitch

Tuitch is a Twitch chat TUI that implements Twitch chat's basic functionality into your terminal. You can join Twitch chat channels anonymously or with your own Twitch account using your Twitch OAuth token. The token is saved locally on your machine in a Config.toml file.

This project is ongoing and in early development stages. I do have plans for other future functionality, and will update the README and documentation accordingly.

How does Tuich work?

Tuitch uses the twitch_irc crate to communicate with the Twitch servers and termion for a light and simple UI. See the Cargo.toml file for the full list of dependancies.

How to install

Right now, I haven't built any deployment or installation for the project, so you'll need to clone the repository yourself. This project is in early development and I only have so much free time on my hands.

How to use Tuitch

Tuitch comes with very basic commands and functionality. A list of commands is shown on the home page when the appliction starts, they include :join <channel> to join a Twitch channel's chatroom and :credentials <username> <oauth token> to update your config file's Twitch user credentials.

Planned features and contributions

If you would like to contribute to this project then I am open to pull requests and bug fixes. This project started as a learning opportunity and has grown into most of the functionality I set out to attempt.

Planned features include:

  • Proper login handling to include changing users without restarting the application.
  • Viewer lists for current channels.
  • Color-scheme customization.
  • Emote and Twitch Badge support.
  • Tabs for multiple chats simultaneously.

tuitch's People

Contributors

b-dont avatar wgaffa avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.