diff --git a/README.md b/README.md index 8ab0624d..b3fcea51 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,46 @@ -# RaspberryCast 3.0 -> Transform your Raspberry Pi into a streaming device. -Cast videos from mobile devices or computers to your TV. +
+ banner +
+

OpenCast

+OpenCast is a client-server media player that transforms your Raspberry Pi into an awesome streaming device. +All you need to make it work is a Raspberry Pi, an internet connection and a screen of your choice. -[![Android app on Google Play](https://developer.android.com/images/brand/en_app_rgb_wo_60.png)](https://play.google.com/store/apps/details?id=com.kiwiidev.raspberrycast) -[![Extension for Chrome](https://developer.chrome.com/webstore/images/ChromeWebStore_BadgeWBorder_v2_206x58.png)](https://chrome.google.com/webstore/detail/raspberrycast/aikmhmnmlebhcjjdbjilohbpfljioeak) -[![Extension for Firefox](https://raw.githubusercontent.com/vincelwt/RaspberryCast/master/images/firefox.png)](https://addons.mozilla.org/firefox/addon/raspberrycast/) +### Background +Opencast started off as a fork of the [RaspberryCast](https://github.com/vincelwt/RaspberryCast) project to implement features specific to my home setup. It has since evolved into a derivative work which includes a full rewrite of the server's code base allowing it to be maintainable and testable. -## Supported services -Works with all youtube-dl supported websites: http://rg3.github.io/youtube-dl/supportedsites.html (YouTube, SoundCloud, Dailymotion, Vimeo, etc...) and also any direct link to mp3, mp4, avi and mkv file. +General goals of this project are: +- Using and supporting newer features of the python language standards. +- Conforming to the [PEP-8 guidelines](https://www.python.org/dev/peps/pep-0008/). +- Openness to contributions including pull requests with new features. +- Providing a continuous integration and unit tests to avoid regressions. +- Accommodating both the user and the developer with utilities to easily install/use/test the project. -You can also cast playlists from Youtube or Soundcloud. +### Features +Opencast supports streaming videos from the biggest platforms and a few [more sites](https://rg3.github.io/youtube-dl/supportedsites.html). -## How to install (Raspberry Pi side) +It is also possible to play medias located on your Raspberry Pi or from any device connected to it; to do so just provide the full path of the file. -``` -wget https://raw.githubusercontent.com/vincelwt/RaspberryCast/master/setup.sh && sudo sh setup.sh -``` -That's it. +Other features: +- Youtube playlist support. +- History and browsing support. +- Subtitle loading for local files (when name matches). + - example: Tv Show S01E01.mp4, Tv Show S01E01.srt +- Dependency management using [Pipenv](https://github.com/pypa/pipenv) +- User friendly configuration file. -The installation script will: -- Download RaspberryCast and install the necessary dependencies -- Autostart RaspberryCast at boot (added to /etc/rc.local) -- Reboot +### How to +#### Install +- Clone this project and enter the Pi-Opencast directory. +- Execute the setup script and follow the instructions. +- Reboot your Raspberry-Pi (recommended). -You can review the [install script](https://github.com/vincelwt/RaspberryCast/blob/master/setup.sh). +#### Use +First of all, note the IP address of your Raspberry-Pi by executing `sudo ifconfig`. -# Remote control (mobile devices) -![The remote on Android](https://raw.githubusercontent.com/vincelwt/RaspberryCast/master/images/android.png) +###### Computer +Open your favorite browser and go on `IP-address:2020` -On any device connected to the same network as you Pi, you can visit the page: -``` -http://raspberrypi.local:2020/remote -``` -Note that you can "Add to homescreen" this link - -You can also use the Android application (link to Playstore at the top of the page) - -## Chrome & Firefox extension -#### Extension options -![alt tag](https://raw.githubusercontent.com/vincelwt/RaspberryCast/master/images/extension.png) - -#### Right-click options -![alt tag](https://raw.githubusercontent.com/vincelwt/RaspberryCast/master/images/rightclick.png) - -You can configure RaspberryCast settings in the extension option page. - -## Cast videos from computer - -Works on Linux, Mac OS, and Windows (Python needed) - -**Download** - -``` -wget https://raw.githubusercontent.com/vincelwt/RaspberryCast/master/rcast.py -``` - -**Usage** - -``` -python rcast.py video.mkv -``` - -Subtitles can be given as an optional second argument. If no subtitle argument is found, RaspberryCast will attempt to find a subtitle file with the same name as the video. In the case of TV shows and movies, RaspberryCast will attempt to match the video with an appropriate subtitle file. This behaviour can be disabled in the configuration file. - -## Demos - -Demo video with the Chrome extension: - -[![Video 1](http://img.youtube.com/vi/0wEcYPSm_f8/0.jpg)](http://www.youtube.com/watch?v=0wEcYPSm_f8) - -Demo video with an Android (also works on iOS): - -[![Video 2](http://img.youtube.com/vi/ZafqI4ZtJkI/0.jpg)](http://www.youtube.com/watch?v=ZafqI4ZtJkI) - -## Uninstall -Remove reference to RaspberryCast.sh in /etc/rc.local - -Delete the /home/pi/RaspberryCast/ folder. - -## Contribute - -If you enjoyed using RaspberryCast, and/or would like to support the development, please consider making a donation. - -[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=XLQTUNFTN9FU8) - -## License -Code released under the MIT license. - -You are welcome to contribute to the project. +### License +OpenCast is distributed under the [MIT License](https://raw.githubusercontent.com/Tastyep/Pi-OpenCast/master/LICENSE) diff --git a/assets/images/banner.png b/assets/images/banner.png new file mode 100755 index 00000000..43281727 Binary files /dev/null and b/assets/images/banner.png differ diff --git a/assets/images/browser-interface.png b/assets/images/browser-interface.png new file mode 100644 index 00000000..7b17e9ff Binary files /dev/null and b/assets/images/browser-interface.png differ