diff --git a/README.md b/README.md index 5dfb2dc..b09cc58 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,162 @@
-
-
+ TraktDiscordPresence Banner + +# 🎬 TraktDiscordPresence: Your Binge-Watching Broadcaster! 🎭 +

- - Support - - - Language - - - Issues - - - Pull Requests - - - Codacy Ranking - + Discord + Stars + Forks + Issues + License +
+ Codacy + Powered by Trakt + Made with TypeScript

+ +

Because your friends deserve to know you're on your 17th consecutive hour of that obscure Danish crime drama!

-# Trakt Discord Presence +--- +## 🌟 Welcome to the Couch Potato's Dream App! + +TraktDiscordPresence is the missing link between your Trakt.tv account and Discord status. Now, your friends can marvel at your impressive TV show marathon skills or judge your questionable movie choices - all in real-time! Whether you're diving into a new series, revisiting a classic, or just leaving Netflix running in the background while you nap, TraktDiscordPresence has got you covered. + +## 🎭 Features That'll Make You the Star of Discord + + + + + + + + + + +
+

🔄 Real-Time Sync

+

Your Discord status updates faster than you can say "Just one more episode"!

+ 		+

🎨 Rich Presence Display

+

Show off what you're watching with style - movie posters included!

+
+

📊 Smart Progress Tracking

+

Let everyone know you're 5 hours into your 12-hour binge session!

+ 		+

🛠️ Easy Setup & Configuration

+

Get up and running quicker than deciding what to watch next!

+
+ +## 🚀 Requirements -Instantly stream your watching status on Discord courtesy [Trakt](https://trakt.tv/). Please note, due to certain -limitations on Discord, this script is required to run on the same device as your Discord client. +- [Node.js](https://nodejs.org/) +- [Yarn](https://yarnpkg.com/) +- [Trakt.tv](https://trakt.tv/) account +- [Discord](https://discord.com/) account -## Requirements +## 🛠️ Installation & Setup -- [Node.js](https://nodejs.org) -- [Yarn](https://yarnpkg.com) -- [Trakt.tv](https://trakt.tv) & [Discord](https://discord.com) accounts +1. [Download](https://github.com/RagnarLothbrok-Odin/TraktDiscordPresence/releases) the latest release. -## Installation & Setup +2. Extract and move the files to your desired location. -1. [Download](https://github.com/RagnarLothbrok-Odin/TraktDiscordPresence/releases), extract, and move the latest - release to your chosen location. +3. [Install Node.js](https://nodejs.org/) (LTS version recommended). -2. [Install Node.js](https://nodejs.org) (preferably the `LTS` version) and ensure `Node` is added to `PATH`. +4. Ensure `Node` is added to your system's PATH. -3. [Install Yarn](https://classic.yarnpkg.com/en/docs/install) globally, navigate to the source directory using the `cd` - command. - ```Shell +5. Install Yarn globally: + ```bash npm install --global yarn + ``` + +6. Navigate to your project folder: + ```bash cd /path/to/your/extracted/source ``` -4. Install packages using `yarn install`. A confirmation message appears upon successful installation. +7. Install dependencies: + ```bash + yarn install + ``` + +## ⚙️ App Configuration + +1. [Create a new Trakt application](https://trakt.tv/oauth/applications) + - Name it `Discord` + - Set `Redirect uri` as `urn:ietf:wg:oauth:2.0:oob` + +2. [Create a new Discord application](https://discord.com/developers/applications) + - Name it `Trakt` + - Add `trakt.png` from the `images` folder as the app icon and cover image in `Rich Presence` section + - Upload the remaining images from the `images` folder -## App Configuration +## 🎬 Usage -1. [Create a new Trakt application](https://trakt.tv/oauth/applications), name it `Discord` and set `Redirect uri` - as `urn:ietf:wg:oauth:2.0:oob`. +1. Start the application: + ```bash + yarn start + ``` -2. [Create a new Discord application](https://discord.com/developers/applications), name it `Trakt` and - add `trakt.png` (available in `images` folder) as the app icon and as the cover image in `Rich Presence` section. - Upload the remaining images found in `images` folder. +2. When prompted, enter your Trakt Client ID, Trakt Client Secret, and Discord Client ID. -## How to Use +3. Follow the provided URL to authorize your Trakt account. Grant access and enter the received code in the terminal. -1. Run the program using `yarn start`. +4. After initial setup, run `yarn start` again to launch the program. -2. It prompts for [Trakt Client ID and Secret](https://trakt.tv/oauth/applications) - and [Discord Client ID](https://discord.com/developers/applications) (Refer to `App Configuration` section if not - already setup). +Upon successful setup, your console output should resemble this: -3. You're then provided a `URL`. Paste this onto any browser, retrieve the code and enter it in your terminal. +- **Console Output** +
Example Output +- **Discord Status** +
Discord Example -4. Run `yarn start` to launch the program. +## 📊 Logging -If set up correctly, your output should resemble this: +The application provides real-time updates on your watching status directly in the console. -- **Example Output** -
Example Output -- **Discord Example** -
Discord Example +## 🤝 Contributing -## Decorative Logging +We welcome contributions to TraktDiscordPresence. If you'd like to contribute, please follow these steps: -
Decorative Logging +1. Fork the repository +2. Create a new branch for your feature or bug fix: + ```bash + git checkout -b feature/your-feature-name + ``` +3. Make your changes and commit them with a clear, descriptive message: + ```bash + git commit -m 'Add feature: brief description of your changes' + ``` +4. Push your changes to your fork: + ```bash + git push origin feature/your-feature-name + ``` +5. Open a Pull Request against the main repository's `main` branch -## License +Please ensure your code adheres to the project's coding standards and include tests for new features or bug fixes where applicable. We appreciate detailed descriptions in your Pull Request to help with the review process. - +## 📜 License + +This project is licensed under the GPL-3.0 License - see the LICENSE file for details. (It's mostly "Share the love, and keep it open!") + +## 🙏 Wall of Fame + +- [Trakt.tv](https://trakt.tv/) for keeping track of our questionable viewing habits +- [Discord](https://discord.com/) for giving us a place to show off said habits +- All our contributors, supporters, and that one guy who starred the repo by accident + +## 📬 Join the Watch Party + +Got questions? Want to debate the best TV shows? Join our [Discord server](https://discord.gg/Q3ZhdRJ) - it's like a virtual living room, but with less fighting over the remote! + +--- + +
+ +💻 Crafted with ❤️ (and many snacks) by [RagnarLothbrok-Odin](https://github.com/RagnarLothbrok-Odin) + +[🐛 Spotted an issue?](https://github.com/RagnarLothbrok-Odin/TraktDiscordPresence/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBUG%5D+Short+Description) | [💡 Got an idea?](https://github.com/RagnarLothbrok-Odin/TraktDiscordPresence/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.yml&title=%5BFeature%5D+Short+Description) | [🤔 Need a viewing guide?](https://discord.gg/Q3ZhdRJ) + +🔝 Back to Top (Time for a Snack Break) +