History

Rodrigo Rodriguez (Pragmatismo) fd97028995 - From 4 to 7.		2025-11-23 20:12:09 -03:00
..
console-mode.md	- From 4 to 7.	2025-11-23 20:12:09 -03:00
default-gbui.md	- From 4 to 7.	2025-11-23 20:12:09 -03:00
README.md	- From 4 to 7.	2025-11-23 20:12:09 -03:00
single-gbui.md	- From 4 to 7.	2025-11-23 20:12:09 -03:00

README.md

Chapter 04: .gbui User Interface Reference

The .gbui (General Bots User Interface) file format provides HTML-based templates for bot interfaces. These files create conversational experiences that work across web, desktop, and mobile platforms.

Available Templates

General Bots includes two built-in UI templates located in ui/desktop/:

1. default.gbui

Full-featured interface with multiple applications:

Chat, Drive, Tasks, and Mail integration
Theme selector with dark mode
Keyboard shortcuts (Alt+1 through Alt+4)
Responsive design for all screen sizes
WebSocket real-time communication

2. single.gbui

Minimalist chat-only interface:

Clean, focused conversation view
Fast loading (< 50KB total)
Auto dark mode support
Perfect for embedding or kiosks
Mobile-optimized touch targets

How .gbui Files Work

Each .gbui file is a complete HTML document with:

Structure: Standard HTML5 markup
Styling: Embedded CSS or theme integration
Behavior: JavaScript for WebSocket communication
Responsiveness: Media queries for different screens

The bot server automatically serves the appropriate .gbui file based on:

User device (desktop/mobile detection)
Configuration in config.csv
URL parameters (e.g., ?ui=single)

Choosing a Template

Use default.gbui when:

Building a full workspace application
Users need file management (Drive)
Task tracking is required
Email integration is needed
Desktop is the primary platform

Use single.gbui when:

Creating a simple chatbot
Embedding in existing websites
Optimizing for mobile devices
Building kiosk interfaces
Minimizing load time is critical

Creating Custom Templates

To create your own .gbui file:

Copy an existing template as a starting point
Modify the HTML structure
Adjust CSS styles
Update JavaScript behavior
Save to ui/desktop/custom.gbui

The bot automatically detects new .gbui files on restart.

Other UI Files

Besides .gbui templates, the ui folder contains:

index.html - Original HTML interface (kept for compatibility)
account.html - User account settings page
settings.html - Application settings page
Supporting folders: /css, /js, /chat, /drive, /tasks, /mail

Console Mode

For terminal users, General Bots also provides a console interface (not a .gbui file):

Text-based UI using terminal capabilities
Keyboard-driven navigation
Works over SSH connections
See Console Mode for details