Giter VIP home page Giter VIP logo

summarizer's Introduction

✨ Summarizer

Summarizer is a BetterDiscord plugin that generates summaries of articles linked in Discord messages. It uses AI-powered summarization to provide concise and informative summaries, making it easier for users to quickly grasp the main points of shared articles without having to read through the entire content.

Ko-fi Donation Page

Features

  • Generate summaries using advanced AI models
  • Select between multiple AI providers (OpenAI, Google Gemini, and Groq)
  • Customizable system prompts and message responses through templating
  • Mitagate content retrieval errors with request proxying (cors, archives, etc)
  • Support for YouTube videos and other media links
  • Rewrite summaries using different AI models

Installation

  1. Ensure you have BetterDiscord installed. If not, download and install it from BetterDiscord's official website.
  2. Download the Summarizer.plugin.js file from the official repository or BetterDiscord plugin repository (coming soon).
  3. Navigate to your BetterDiscord plugins folder. You can find this folder by going to User Settings > Plugins > Open Plugin Folder within Discord.
  4. Drag and drop the Summarizer.plugin.js file into the plugins folder.
  5. Enable the Summarizer plugin from the BetterDiscord plugins tab.

Configuration

To use the Summarizer plugin, you need to provide an API key for the AI provider. Follow these steps to configure the plugin:

  1. Go to User Settings > Plugins.
  2. In the settings panel, enter your API key for the selected AI provider (e.g., Google Gemini).
  3. Choose the desired AI model from the dropdown list (default is "gemini-1.5-flash").
  4. Edit the system prompt, summary template and output template to your liking.

Usage

Once the Summarizer plugin is installed and configured, it will automatically detect article links in Discord messages. When a message contains a link, you will see a "✨ Summarize" button in the message context menu (right-click on the message).

Click on the "✨ Summarize" button to generate a summary of the linked article. The message will be edited to include the summary using your template.

Default template

## 📰 Article Summary
> **🌟 Key Highlights**
> - {keyPoints}
> **📌 Main Topic(s)**
> - {mainTopics}
> **💡 Takeaway**
> {takeaway}

Contributing

Contributions are welcome! If you'd like to contribute, feel free to fork the repository and submit a pull request.

Support

If you encounter any issues or have suggestions for improvements, please open an issue.

Acknowledgements

The build tools for this project are based on JustOptimize's return-ShowHiddenChannels plugin.

License

This project is licensed under GPLv3 - see the LICENSE file for details.

Copyright Disclaimer

Summarizer is not affiliated with Discord or any of the platforms it supports. All product names, logos, and brands are property of their respective owners.

summarizer's People

Contributors

janitorialmess avatar

Stargazers

 avatar RoyRiver avatar

Watchers

 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.