Merge pull request #494 from mydroidandi/fb/estebanways

Fb/estebanways

README.md

@@ -24,10 +24,31 @@
 
 <div align="center">
 
-Commbase is a flexible and extensible ✨ development framework ✨ designed to empower computers and other devices with cutting-edge conversational AI capabilities. It serves as both a module and library bundler, incorporating third-party LLMs to enable features such as "distributed AIs" or "multi-agent systems" (MAS). Commbase extends its reach to applications and diverse devices, including droids, smart appliances, and various types of vehicles. Operating effortlessly on either a single machine or a pair of machines in a client-server architecture, Commbase offers unparalleled adaptability and scalability.
+Commbase is a flexible and extensible ✨ development framework ✨ designed to empower computers and other devices with cutting-edge conversational AI capabilities. It serves as both a module and library bundler, incorporating third-party LLMs to enable features such as "distributed AIs" or "multi-agent systems" (MAS). Commbase adapts across a diverse range of devices, from computers to robots, smart appliances, vehicles, Iron Man like suits, starships, and beyond, ensuring universal accessibility and functionality. Operating effortlessly on either a single machine or a pair of machines in a client-server architecture, Commbase offers unparalleled adaptability and scalability.
 
 </div>
 
+## Detailed Feature Overview
+
+| Topic                   | Features                                                                                                                                                                        |
+|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 🛠️ Installation & Setup    | * Detailed installation steps, structure, and contribution guidelines are available on the GitHub repository, ensuring secure and transparent setup processes.                    |
+| 💻 Commands & Interfaces   | * Help option to see available built-in commands for terminal use or development. <br> * Built-in commands support both voice and terminal command calls.                        |
+| ⚙️ Control & Accessibility | * Easy to start and stop using init systems, cron jobs, terminal commands, or voice commands. <br> * Terminal-based interface, with the option to create custom UIs.            |
+| 🔀 Navigation              | * Seamlessly switch among windows using keybindings to access dashboards, server connections, etc.                                                                            |
+| 🖥️ Multi-pane Support      | * Multiple panes are provided, covering functionalities like the chat room, STT engine (Speech-to-Text), server pane, client pane, and additional options. |
+| 📂 Custom Applications     | * Load custom terminal applications and seamlessly switch back to the chat room in the same pane.                                                                             |
+| 🎨 Personalization         | * Customizable application, user, and assistant names.                                                                                                                                       |
+| 📝 Logging & Recording     | * Terminal and voice command recorder-transmitter area easy to install even in other hosts for remote control through networks, with enabled secure access control and logging.  |
+| 🔧 Configuration           | * Effortlessly adjust and customize your settings with our platform's centralized configuration files. No code is required to configure built-in options.                        |
+| 🗣️ STT & TTS Engines       | * The STT Engine operates in Whisper reactive mode by default, with the ability to switch to Whisper proactive mode at any time. <br> * TTS Engines are dedicated for text-to-speech functionalities, so projects can effectively speak in various languages, enhancing accessibility and global reach.      |
+| 🌍 Internationalization    | * Support to global audiences with seamless internationalization. <br> * Tailor your user experience by modifying i18n files to customize voice commands.                        |
+| 📜 Custom Scripting        | * Effortlessly create custom server-side command scripts with a single file catalog database (scalable to any RDBMS), our up-to-date well-documented API, and JSON simplicity. <br> * Write command scripts in any programming language.             |
+| ♻️ Reusable Functions      | * Access to a comprehensive library of reusable functions to enhance custom command scripts with streamlined efficiency and tailored functionalities.                           |
+| 🤖 Advanced Capabilities   | * LLMs (Large Language Models) integration. <br> * Enhanced assistant capabilities with advanced language understanding, including additional features like vision.               |
+| 📊 Activity Management     | * Efficiently manage your system's activity and user interactions by seamlessly integrating Commbase logs with custom app logs.  <br> * Logs include customizable backups of past assistant-user conversations.                                              |
+| 🛡️ Platform Stability      | * The use of Linux enhances the stability, reliability, and security of our software, ensuring robust and flexible performance in various environments.                        |
+
 ## Usage
 
 [`INSTALL`](./INSTALL) Commbase and then run the next command in a terminal to start the program:
@@ -170,6 +191,18 @@ This project is coded and organized like this:
     └── conversation_logs
 ```
 
+## Approach and Philosophy
+
+Our software embodies the minimalism and DRY (Don't Repeat Yourself) Unix philosophies, ensuring streamlined features and avoiding unnecessary repetition for enhanced efficiency and simplicity.
+
+The open-source nature of our project empowers developers to extend its capabilities by adding more bundles or writing their own code, fostering a collaborative and adaptable environment beyond voice commands.
+
+Additionally, our modular design facilitates flexible customization and extension of functionalities according to user needs.
+
+We adhere to industry-standard best practices in software engineering for design and architecture, ensuring the development of robust, scalable, and maintainable systems that meet the highest quality standards and user expectations.
+
+Moreover, you can incorporate your unique serial and wireless hardware into our platform, enabling tailored communication and interaction with devices, enhancing versatility and functionality.
+
 ## Contributing
 
 To contribute to Commbase, follow these steps:

bundles/commbase-data-exchange/server/client_data/json_1.json

@@ -1 +1 @@
-{"messages": [{"language": "en_us"}, {"control": ""}, {"current_request": "rec"}, {"previous_request": "rec"}, {"current_response": ""}, {"runtime": ""}, {"source_code_display": ""}, {"source_code": ""}]}
+{"messages": [{"language": "en_us"}, {"control": ""}, {"current_request": "--select-stt-engine"}, {"previous_request": "--select-stt-engine"}, {"current_response": ""}, {"runtime": ""}, {"source_code_display": ""}, {"source_code": ""}]}

data/.messages.json

@@ -1 +1 @@
-{"messages":[{"language":"en_us"},{"control":""},{"current_request":"rec"},{"previous_request":"rec"},{"current_response":""},{"runtime":""},{"source_code_display":""},{"source_code":""}]}
+{"messages":[{"language":"en_us"},{"control":""},{"current_request":"--select-stt-engine"},{"previous_request":"--select-stt-engine"},{"current_response":""},{"runtime":""},{"source_code_display":""},{"source_code":""}]}

scripts/configuration/install_commbase_executable/commbase.default

@@ -111,7 +111,7 @@ Language:
   options:
     --set-language     (Interactive) List and set languages available
 
-TTS engine (pytts3):
+TTS engine (pyttsx3):
   options:
     --list-pyttsx3-voices               List the commbase-tts-pyttsx3 voices available
     --filter-pyttsx3-english-voices     Filter pyttsx3 English language voices