Documentation

Everything you need to know about guideXOS

→

Getting Started

Quick start guide to run guideXOS

→

GXM Format

Learn about the custom executable format

→

Networking

Configure and use network features

Getting Started

First Boot

When you first boot guideXOS, the system automatically initializes:

  • PS/2 keyboard and mouse drivers
  • USB HID support (if available)
  • VMware Tools integration (if running in VMware)
  • Network stack (with NETWORK flag enabled)
  • GUI desktop environment

Using the Desktop

The desktop environment features:

  • Taskbar: Located at the bottom, shows running applications and system tray
  • Start Menu: Click the start button to access applications
  • Desktop Icons: Double-click to launch applications
  • Window Management: Drag windows by title bar, resize from edges
// Launch applications from the console > Notepad // Open text editor > Paint // Open graphics editor > Calculator // Open calculator > GUISamples // View GXM demos > WebBrowser // Open web browser

GXM Executable Format

What is GXM?

GXM (guideXOS eXecutable Module) is a custom executable format that supports both native code execution and declarative GUI scripting. This makes it easy to create applications without writing complex code.

File Structure

Offset | Bytes | Content -------|-------|------------------ 0-3 | 4 | 'G','X','M',0x00 4-7 | 4 | Version (0x01000000) 8-11 | 4 | Entry RVA (0x00000000 for GUI) 12-15 | 4 | Total file size (little-endian) 16-19 | 4 | 'G','U','I',0x00 20-... | var | Script text (UTF-8) ... | 1 | 0x00 (null terminator)

Creating a Simple GXM Application

Here's a complete example of a "Hello World" GXM application:

WINDOW|Hello World|320|200 LABEL|Welcome to guideXOS!|16|16 BUTTON|1|Click Me|16|60|120|28 ONCLICK|1|MSG|Hello from guideXOS! BUTTON|2|Open Notepad|16|100|120|28 ONCLICK|2|OPENAPP|Notepad BUTTON|99|Close|16|140|120|28 ONCLICK|99|CLOSE|

Supported Controls

  • WINDOW: Creates the main window with title and dimensions
  • LABEL: Displays static text at a position
  • BUTTON: Interactive button with ID and position
  • LIST: Scrollable list view with selectable items
  • DROPDOWN: Combo box with collapsible items
  • ONCLICK: Button click event handler
  • ONCHANGE: Selection change event for lists/dropdowns

Supported Actions

  • MSG: Show message box with text
  • OPENAPP: Launch application (Notepad, Calculator, Paint, etc.)
  • CLOSE: Close the current window

Advanced Example

WINDOW|App Launcher|400|350 LABEL|Select an application to launch:|16|16 LIST|1|16|50|350|150|Notepad;Calculator;Paint;Console;Clock;Monitor ONCHANGE|1|MSG|Selected: $VALUE LABEL|Or use quick buttons:|16|210 BUTTON|10|→ Notepad|16|240|110|32 BUTTON|11|→ Calculator|136|240|110|32 BUTTON|12|→ Paint|256|240|110|32 ONCLICK|10|OPENAPP|Notepad ONCLICK|11|OPENAPP|Calculator ONCLICK|12|OPENAPP|Paint BUTTON|99|Close|16|290|350|32 ONCLICK|99|CLOSE|

Networking

Network Configuration

guideXOS includes a full TCP/IP network stack with support for:

  • Ethernet: Low-level frame handling
  • ARP: Address Resolution Protocol
  • IPv4: Internet Protocol version 4
  • ICMP: Ping functionality
  • UDP: User Datagram Protocol
  • TCP: Transmission Control Protocol
  • DHCP: Dynamic IP configuration
  • DNS: Domain name resolution

Supported Network Cards

  • Intel 825xx series
  • Realtek RTL8111

Using Network Applications

Launch the web browser to access websites:

> WebBrowser // Automatically connects via DHCP // Enter URL in the address bar // Example: http://team-nexgen.com/

Connect to IRC networks:

> nexIRC // Configure network settings // Connect to servers like irc.libera.chat // Join channels and chat in real-time

File System

Directory Structure

guideXOS uses a custom file system with support for directories and files:

/ # Root directory → Apps/ # Application executables → Programs/ # Additional programs → Documents/ # User documents → System/ # System files

File Operations

Use the File Manager (Computer Files) to:

  • Navigate directories
  • Open files by double-clicking
  • Create new files and folders
  • Delete files and folders
  • View file properties

Ready to Get Started?

Download guideXOS now and start exploring the features!

Download Now View Source Code