Skip to content

Home

Jump to bottom
Ankesh edited this page Jun 23, 2025 · 1 revision

🖥️ Vitals Wiki

Welcome to the official wiki for Vitals – a modern, intuitive system monitoring application for Windows, built with JavaFX. Vitals provides real-time insights into your system's performance with beautiful visuals and a smooth user experience.

📚 Table of Contents

🔧 Installation Guide

System Requirements

  • Windows 10 or later (64-bit)
  • 4 GB RAM or more
  • ~500 MB free disk space

Installing Vitals

  1. Download the .msi installer from the Releases page.
  2. Double-click the installer and follow the setup wizard.
  3. Launch the app from the Start Menu or desktop shortcut.

✅ Includes JDK, JavaFX, and all dependencies — no additional setup required.

🚀 Getting Started

  1. Launch Vitals from your desktop or Start Menu.
  2. View real-time stats across four key areas:
    • CPU Usage
    • Memory Usage
    • Disk I/O
    • Network Traffic
  3. Use the top menu to access logging and export options.

✨ Features Overview

  • Live CPU Monitoring
    • Dynamic line graph showing current CPU load.
  • Memory Tracking
    • Circular dial visualization with detailed stats.
  • Disk Activity
    • Real-time reads/writes with I/O rate graphs.
  • Network Usage
    • Upload/download stats with bandwidth tracking.
  • Historical Logging
    • Track system performance over time.
  • Export to PDF/CSV
    • One-click export of live system data.

🎨 Customization Options

Vitals currently supports the following UI and data options:

  • Theme Sync: Adapts to system theme.
  • Resizable Dashboard: Responsive layout adjusts to window size.
  • Log Directory: Customize log output location from settings file.

Future releases will include theme switching, graph smoothing, and layout presets.

🐞 Troubleshooting

Issue: App doesn't open after installation
Solution: Make sure your system meets the minimum requirements. Try reinstalling the app.

Issue: Graphs not updating
Solution: Ensure background services (like WMI) are running correctly on Windows.

Issue: Export feature not working
Solution: Check file permissions and ensure the output directory is writable.

For more help, visit the Issues page.

📦 Building from Source

Requirements

  • Java 21+ (preferably Java 24)
  • Maven 3.6+
  • Git

Build Steps

1. Clone the Repository

git clone https://github.com/AnkeshGG/VitalsSystemMonitor.git
cd VitalsSystemMonitor

2. Build the Project

mvn clean install

3. Run the Application

mvn javafx:run

Or run the packaged JAR:

java -jar target/vitals-1.0.0-jar-with-dependencies.jar

🤝 Contributing

We welcome contributions of all kinds—bug fixes, feature suggestions, or documentation improvements.

  1. Fork the repository
  2. Create a feature branch
  3. Submit a pull request with a clear description

📧 Support & Contact

Clone this wiki locally