📜 Description

VirtualPet is an all-in-one app that integrates features like AI-powered interactive offline chat, image generation, OCR capabilities, an AI-powered code editor, a built-in web browser, a mini video player, shortcut management, and access to public anime content for local viewing and much more, all within a seamless user interface.

🚀 Demo

VirtualPet.mp4

✨ Features

✨ AI Pre-trained Model Chat A conversational AI model that can respond to a variety of user queries and engage in interactive conversations. Currently, the default model is "gpt4all-falcon-newbpe-q4_0", and it is not possible to switch models dynamically at this time. (Using LLamaSharp) 🎥 Demo

✨ Image Generation in Chat Generate images directly within the chat interface based on user prompts or descriptions. This feature uses Prodia IA to transform text into visuals, creating unique and personalized images instantly. 🎥 Demo

✨ Wikipedia Queries in Chat Query Wikipedia in real-time from within the chat interface, providing quick access to accurate information on a wide range of topics directly in the app. 🎥 Demo

✨ Object Viewer (.obj) View and interact with 3D .obj object files directly in the app using local files or with results from the sketchfab.com website. This feature is designed to help users visualize with 3D models effortlessly. 🎥 Demo

✨ Anime Content Viewer from Two Sources with Spanish/English Language Support Watch anime content from two different sources (allanime.to and www3.animeflv.net), with both Spanish and English subtitle support, providing a broader selection of anime for users from various language backgrounds. 🎥 Demo

✨ Run AI-generated Code in the Integrated Editor Execute code generated by the AI directly within the integrated code editor, allowing for seamless integration between development and AI-driven suggestions. 🎥 Demo

✨ Integrated Code Editor Supporting C#, Python, Java Projects or Solutions A powerful code editor designed to support multiple programming languages including C#, Python, and Java, enabling users to work on a variety of projects and solutions in a unified environment. 🎥 Demo

✨ Autocompletion / IntelliSense in the Editor The integrated editor features autocompletion and IntelliSense support to boost development speed and accuracy by providing code suggestions and real-time syntax help. 🎥 Demo

✨ Custom Web Page Bookmarking Save and organize your favorite websites for quick access within the app, making it easy to navigate to commonly used resources directly from the interface. 🎥 Demo

✨ Mini Video Player A compact and lightweight video player embedded within the app, allowing users to watch video content without needing to leave the interface. 🎥 Demo

✨ Online Multimedia Content Viewer View and stream various forms of multimedia content, including videos, images, and audio, directly from online sources within the app. 🎥 Demo

✨ Web Edge Integration with Desktop Tab Sync A fully integrated Web Edge panel within the app, synchronized with the desktop version of Microsoft Edge. This feature allows you to access and sync browser tabs across devices seamlessly, making it easy to continue browsing from where you left off directly in the app. 🎥 Demo

✨ Integrated OCR Tool An Optical Character Recognition (OCR) tool integrated within the app to extract text from images or scanned documents, helping to digitize written content effortlessly. 🎥 Demo

✨ News Panel Stay up-to-date with the latest news and headlines directly through the integrated news panel, ensuring you're always informed of current events. 🎥 Demo

✨ Integrated Command Line (CMD) Execution in Chat Execute command-line instructions directly from the chat interface, providing a streamlined way to run various tasks and commands without leaving the app. 🎥 Demo

✨ File Sharing Server with WebSocket Support for Devices on the Same Network A server feature that allows file sharing between devices on the same network, coupled with Bluetooth notifications to alert users to the URLs for file access. 🎥 Demo

✨ Screen Casting Server to Stream Device Display Live Stream your device’s screen live to the app, enabling real-time viewing and sharing of what's happening on your device's display using VirtualPetApp. 🎥 Demo

✨ Android App to Share Mobile Screen to VirtualPet An Android app that allows users to share their mobile screen with VirtualPet in real-time, enabling seamless interaction and display mirroring. 🎥 Demo

✨ Send Files via Bluetooth to Multiple Devices Simultaneously Send files to multiple devices at the same time using Bluetooth, allowing you to share files quickly and efficiently between different devices on the same network. 🎥 Demo

✨ AI Response Cancellation This feature allows users to stop the AI ​​response midway by pressing a button. Once activated, the AI ​​immediately stops any further output, giving users the control to move on to the next query or action. 🎥 Demo

Important

The following features are in progress and will be introduced in future updates.

⏰ Dark/Light Mode Toggle between Dark and Light modes based on your environment or preference. Dark mode helps reduce eye strain in low-light conditions, while Light mode offers a more vibrant and energy-efficient experience in bright environments.

⏰ Multi-language Support The app will support multiple languages, allowing users to choose their preferred language for a more personalized and comfortable experience. This feature will make the app accessible to a global audience.

⏰ Hot-swappable AI Models from the Configuration Panel This feature will allow users to dynamically switch between different pre-trained AI models directly from the configuration panel. Users will be able to select the model best suited to their tasks without restarting the application or disrupting their workflow.

⏰ Voice Command Integration Integrate voice commands to control the app’s features, enabling hands-free operation and enhancing accessibility for users who prefer voice interaction over manual input.

📦 Requirements

To run VirtualPet with its full range of features, including the AI model and other functionalities, the following hardware and software specifications are recommended:

🖥️ Hardware Requirements

• RAM: 16 GB or more (for optimal performance)
• CPU: Intel Core i5 or equivalent (minimum), with at least 4 cores and 8 threads. A higher-end processor such as an Intel Core i7 or i9, or an AMD Ryzen 7 or 9, is recommended for better performance, especially when running the AI model.
• GPU: A dedicated GPU with at least 8 GB of VRAM (e.g., NVIDIA GTX 1080, RTX 2060, or better). A GPU is required to run the AI model efficiently, particularly for tasks such as image generation and real-time AI processing.
• Storage: SSD with at least 20 GB of free space for optimal loading and storage of models and assets.
• Network: While the AI model runs locally, an internet connection may be required for some external features, such as browsing or accessing public anime content websites.

🖥️ Software Requirements

• Operating System: Windows 11 (with support for GPU acceleration).
• .NET Framework: .NET 8 or later (for full compatibility with the integrated features and the AI model).
• CUDA (for NVIDIA GPUs): Ensure that the latest CUDA version compatible with your GPU is installed for optimal performance with AI models.
• Driver: Latest GPU drivers installed (required for AI acceleration).

Tip

For best performance, especially when using AI models, it is highly recommended to have a multi-core processor and a high-end GPU to handle complex calculations in real-time. A stable internet connection may be required for some features like anime content viewing and web browsing, but the AI model and most core functionalities are fully operational offline once set up.

📀 Installation

👉Coming Soon...

⚙️ Configuration

VirtualPet relies on external services to provide some of its features, and to use them, you'll need to obtain API keys. The external services used by VirtualPet are as follows:

• Prodia IA: This AI service provides various functionalities within the app.
• NewsAPI: This API allows the app to fetch and display the latest news headlines.

How to Add Your API Keys

Once you have obtained the necessary API keys for these services, you can add them to VirtualPet using one of the following methods:

A. Manual Configuration via apiKeys.json

1. Locate the apiKeys.json file in the VirtualPet/Credentials/ directory. This file is where you will store your API keys.
2. Open the apiKeys.json file and enter your API keys in the following format:

{
  "ApiKeys": [
    { "NEWSAPI": "YOUR_API_KEY" },
    { "PRODIA": "YOUR_API_KEY" }
  ]
}

B. Setting API Keys Through the Configuration Panel

Alternatively, when running VirtualPet, you can set your API keys directly from the Configuration Panel within the application:

1. Launch VirtualPet.
2. Open the Configuration Panel from the app's settings menu.
3. Enter your API keys for both Prodia IA and NewsAPI in the respective fields.
4. Save your changes.

This method allows you to update the API keys without needing to manually edit configuration files.

🤕 Known Issues

• In some screen resolutions, the panel does not adapt correctly, causing overflow of the tabs and their respective icons. This behavior results in incorrect display of the interface, negatively impacting the user experience, especially on screens with non-standard dimensions or smaller resolutions. (🐞)

⌨️ Setup

💻 VirutalPet Prerequisites Before starting with the VirtualPet setup, ensure you meet the following preconditions: Bluetooth Enabled: Enable Bluetooth on your device. Internet Connection: An internet connection is required the first time you run the program to download the necessary components. Windows Transparency Mode: This mode must be enabled. To configure it: Go to Settings > Accessibility > Visual Effects. Enable the Transparency Effects option. Project Setup Obtain the API Keys: Retrieve the API keys mentioned in the Configuration section. Clone the Repository: Run the following command: git clone <repository-URL> Configure the API Keys: Set the API keys using the options provided in the project documentation. Open and Run the Project: Open Visual Studio as Administrator. Run the VirtualPet.Main project with the Debug - x64 profile. Note: The first time you run the project: If the required model is not installed, a form will appear for installation. For subsequent runs, if the model is already installed, the initial loading time will be shorter. Solution Structure The solution consists of two main projects: VirtualPet.Main: Responsible for managing the forms and user interface-related classes. VirtualPet.Lib: Contains abstract classes reusable across the forms. PathArchitecture Class The PathArchitecture class is responsible for managing all paths within the project, differentiating between: Operating systems: x64 and x86. Execution modes: Release or Debug. Important: All project paths must be defined in this class. Avoid hardcoding paths directly in the code.

📱 VirutalPet App Description The VirtualPet app allows you to stream content from an Android device to VirtualPet (the purpose and functionality of the app may change in the future) Setup To configure the application, edit the MainActivity file with the following steps: Locate and modify the line where the WebSocket server URI is set (Replace this IP address with the device running VirtualPet): val serverUri = URI("ws://IP:5700")

👨‍💻 Contributing

Note

Feel free to open an issue or submit a pull request if you have suggestions or improvements! This project uses GitHub Issues for tracking bugs and feature requests. All contributions are welcome! There's a TODO list in VirtualPet Dev Project and you can pick an interesting one to start. Please read the contributing guide for more information.

You can also do one of the following to help me make VirtualPet better

• Submit a feature request.
• Star and share VirtualPet to let others know about it.
• Just open an issue about the problem you've found!

⚠️ Disclaimer

Warning

This software includes features that allow users to extract data from websites. Currently, some of the extraction features are provided for demonstration purposes to showcase the software's capabilities. It is the user's responsibility to ensure that their use of this software complies with all applicable laws and the terms of service of the websites they > interact with. The developer does not endorse or promote unauthorized use of this software to access or extract content from any third-party websites or other platforms. By using this software, you agree that the developer is not responsible for any legal issues or consequences resulting from your use of the software.

📄 License

Caution

If you redistribute or modify this software, you must acknowledge the original code in your work and provide a copy of the AGPL-3.0 license along with the source code. If you make changes, make sure to indicate the modifications made, so that users can distinguish between the original code and your modifications. Thank You 😁

🛠️ External Tools

VirtualPet leverages various external tools and libraries to enhance its functionality. These tools help optimize performance, extend the range of features, and provide a better user experience.

⚙️ AI Model (Local)

• LLamaSharp: A powerful library for interacting with AI models locally. It allows for fast processing of AI-powered tasks without requiring an internet connection.
• Whisper.net: A speech-to-text API that processes audio into text using a local or cloud-based model, providing high accuracy for transcription tasks.

⚙️ Web Browser and Automation

• Selenium WebDriver: A web automation tool for interacting with web pages, used in VirtualPet for automating browser tasks.
• WebDriverManager: A library that automatically manages browser drivers for Selenium WebDriver, ensuring compatibility and simplifying setup.
• RestSharp: A REST API client for interacting with HTTP-based services, used for making API calls and fetching data from web services.
• WebSocketSharp: A library for managing WebSocket connections, allowing real-time communication between VirtualPet and external services.

⚙️ Image Generation

• Stable Diffusion: A deep learning model used for generating high-quality images from text prompts. It is integrated into VirtualPet to enable image generation within the chat feature.
• Prodia: Easy-to-use Stable Diffusion API for AI-powered image generation at 90% lower cost than AWS. Effortless scale with no infrastructure worries.

⚙️ OCR (Optical Character Recognition)

• Tesseract OCR: An open-source OCR engine used for extracting text from images, making it easy to digitize printed or handwritten content.

⚙️ Web Browser

• CEF (Chromium Embedded Framework): A framework used to embed Chromium-based browsers into applications, providing access to web browsing functionality directly within the app.

⚙️ Code Analysis and Editing

• Microsoft.CodeAnalysis: A set of APIs used for analyzing, compiling, and scripting C# code within the VirtualPet environment. Includes several components for C# scripting and workspace management.

⚙️ Audio

• NAudio: A .NET audio library used to record, manipulate, and play audio in VirtualPet, supporting various audio formats and features like real-time audio processing.

⚙️ UI and Graphics

• HelixToolkit: A 3D graphics library for creating high-quality 3D models and visualizations, integrated into VirtualPet for rendering interactive 3D scenes.
• FontAwesome.Sharp: A library that allows the use of Font Awesome icons in Windows Forms and WPF applications, providing intuitive and stylish icons for the UI.
• FCTB: A fast, customizable text box control for displaying and editing text with syntax highlighting in C# and other languages.

These external tools are essential for providing rich features in VirtualPet. They enhance the application's performance and capabilities, making it a powerful and versatile tool for users.