Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/majdlhb/majdsub
A Python scriptthat integrates OpenSubtitle and Maze-TV APIs to fetch subtitles (and encode them in UFT-8) and episode counts, manages local series files, and controls VLC for seamless fullscreen playback with subtitles.
https://github.com/majdlhb/majdsub
encoding maze-tv maze-tv-api open-source opensubtitles opensubtitles-api series series-progress-saver srt srt-subtitles subtitle subtitle-downloader subtitles video video-opner video-player vlc vlc-media-player
Last synced: 12 days ago
JSON representation
A Python scriptthat integrates OpenSubtitle and Maze-TV APIs to fetch subtitles (and encode them in UFT-8) and episode counts, manages local series files, and controls VLC for seamless fullscreen playback with subtitles.
- Host: GitHub
- URL: https://github.com/majdlhb/majdsub
- Owner: MajdLHB
- Created: 2024-07-12T00:27:38.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T12:19:27.000Z (3 months ago)
- Last Synced: 2024-08-27T14:04:47.922Z (3 months ago)
- Topics: encoding, maze-tv, maze-tv-api, open-source, opensubtitles, opensubtitles-api, series, series-progress-saver, srt, srt-subtitles, subtitle, subtitle-downloader, subtitles, video, video-opner, video-player, vlc, vlc-media-player
- Language: Python
- Homepage:
- Size: 155 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **MajdSub V1.0**
MajdSub V1.0 is a Python script that integrates the OpenSubtitle and Maze-TV APIs to fetch subtitles in any language, encode them in UTF-8, and manage episode counts. It also controls VLC for seamless fullscreen playback with subtitles. This tool is ideal for those who want an easy way to manage subtitles and watch episodes directly in VLC.
Watch the [video tutorial](https://youtu.be/WKzk7VpAuEI).
## **Overview**
- **Subtitle Download and Encoding**: Automatically downloads subtitles for your episodes and encodes them to UTF-8.
- **Episode Tracking**: Uses the Maze-TV API to track the number of episodes in the series you are watching and saves the last episode you watched.
- **Automated Playback**: Searches for the episode in your local files and opens it directly in VLC media player with the encoded subtitles.
- **Next Episode Handling**: By pressing the 'Next' button, the script fetches the next available subtitle from OpenSubtitles and adds it to VLC.
- **GUI**: Utilizes Tkinter for a user-friendly graphical interface.
- **Future Support for Movies**: Planned updates to handle movies.
- **Multi-language Support**: Plans to expand subtitle download options to include all languages supported by OpenSubtitles.
## **Note**
- **Update button**: Updates the information about the episode you will watch (Movie support will be added soon).
- **Play button**: Plays the current episode in fullscreen mode in VLC with subtitles.
- **Redownload sub button**: Redownloads the subtitle with the same settings.
- **Next subtitle button**: Downloads the next subtitle and adds it to VLC directly.
- **Show subs button**: Displays available subtitles.
## **Future Plans**
- **Support for Movies**: The script will be updated to handle movies, making it versatile for both TV series and films.
- **Executable File**: Develop an executable (.exe) version of the app for users who prefer not to run the script directly.
- **Cross-Platform Support**: Develop versions of the app for other operating systems such as macOS and Linux.
- **Script Reorganization**: Reorganize the script to improve readability, maintainability, and performance.
## **Installation**
1. **Install the source code (.zip)**:
- Extract the zip file.
- Open script.py with the python application.
2. **Set Up VLC HTTP Interface**:
- Open VLC media player.
- Go to `Tools > Preferences`.
- Under `Show settings`, select `All`.
- Navigate to `Interface > Main interfaces > Lua`.
- Set the password and ensure the HTTP interface is enabled.
- Update the port and password in the script accordingly.
## **Directory Structure**
- The series must be organized as follows:
- A folder with the series name without spaces.
- Inside this folder, a subfolder for each season (e.g., `s1` or `S01`).
- Each episode file must have the letter 'e' followed by the episode number in its name (e.g., `e01`).
## **Usage**
1. **Run the Script**:
```bash
python script.py
```
2. **Graphical User Interface**:
- Use the GUI to select the series and episode you want to watch.
- The script will handle downloading and encoding the subtitle, then open the episode in VLC.
## **Configuration Files**
- **APIKey.json**: Stores your API key for OpenSubtitles.
- **Episode.json**: Configuration for the current episode.
- **OSPassword.json**: Stores your OpenSubtitles password.
- **OSUsername.json**: Stores your OpenSubtitles username.
- **PrevEpisode.json**: Stores information about the previous episode watched.
- **PrevSeason.json**: Stores information about the previous season watched.
- **PrevSeries.json**: Stores information about the previous series watched.
## **Contributing**
Feel free to contribute to the project by:
- Forking the repository.
- Creating a new branch (`git checkout -b feature-branch`).
- Making your changes.
- Submitting a pull request.
## **License**
This project is open-source and available under the MIT License.
## **Support**
For any issues or feature requests, please open an issue on the [GitHub repository](https://github.com/MajdLHB/MajdSub/issues).
## **Acknowledgments**
- [OpenSubtitles API](https://www.opensubtitles.com) for providing subtitle data.
- [Maze-TV API](https://www.maze.tv) for episode tracking.
- [VLC Media Player](https://www.videolan.org/vlc/index.html) for media playback.
---
**Note**: Please ensure you update the file paths, API keys, and other configurations to match your setup.