Skip to content

Latest commit

 

History

History
134 lines (94 loc) · 3.95 KB

README.md

File metadata and controls

134 lines (94 loc) · 3.95 KB

Light ChatGPT (Client)

Light ChatGPT is a light-weight application for ChatGPT. The client is buit with Python and PyQT5.

Requirements

Python 3.8 and packages in envs/requirements.txt are recommanded.

Usage

You can choose to run the application in python or in .exe file freely :

1. Run the GUI with python:

python light_chat.py

2. Install and run .exe application:

python install.py

Then the application is installed in folder ./dist/light_chat, and the application file is in ./dist/light_chat/light_chat.exe.

Manual

Light Chat consists of a main application and optional plugins. By default we provide two plugins : light chat and google translation.

1. The main application

It consists of Floating window, Main window and Tray icon.
  • Floating window :
    • left-click[hot-key:ctrl+space] - show the main window
    • right-click - show a menu
      • user - set user information
      • settings - change settings (e.g., global hot key)
      • to tray - shrink to the tray icon
      • close - close the applciation
  • Main window:
    • title - is on the top of the window
      • plugin name - shows the name of current plugin, e.g., light chat
        • switch the plugin by moving your mouse on it and click the target plugin.
        • [hot-key:ctrl+tab] : swtich to the next plugin
      • shrink icon[hot-key:ctrl+space] - shrink the window into the floating window
    • plugin - the main content of the window, e.g., Light Chat plugin.
    • [hot-key:ctrl+q] : close the application
  • Tray icon:
    • right-click - show a menu
      • show / hide - show / hide the application
      • close - close the applciation

2. Plugin : Light Chat

A light plugin for OpenAI ChatGPT
  • Display region - show the history questions / answers
    • questions - shown with white background
    • answers - shown with gray background
  • Control region - get input from you
    • send icon[hot-key:enter / ctrl+space] - send the text in the text box
    • text box - input your question in it
    • new icon[hot-key:ctrl+n]- refresh the history and start a new chat

3. Plugin : Google Translation

A plugin for Google translation web server
  • Display region - show the history translation items
    • text - shown with white background
    • result - shown with gray background
  • Control region - get input from you
    • send icon[hot-key:enter / ctrl+space] - send the text in the text box
    • text box - input your question in it
    • new icon[hot-key:ctrl+n]- refresh the history

Add your own plugin

You can program your own plugin and add it to the application

  1. Program a plugin file (we provide a template in GUI/plugins/template.py)

  2. Put it in GUI/plugins/

  3. Change the loaded plugins in GUI/client.py :

    # this command is in LightChatGPTClient.__init__ : 
self.main_window = MainWindow([..., "your_plugin_file_name"], self)

  4. (For .exe) import the new .py files as a library in light_chat.py:

    import GUI.plugins.xxx

  5. Run the application

TODOs

  • Plugin - ChatGPT
  • Plugin - Google translation
  • Plugin - (HTTP) File transfer
  • Plugin - AI drawing
  • GUI - relative size adjustment
  • GUI - resize window

Contact us: