Skip to content

Quick Start GuideΒΆ

Your First Eye-Tracking Study in 5 Minutes

Follow this guide to run your first study from start to finish. By the end, you'll have collected real eye-tracking data!

🎯 What You'll Accomplish¢

In this quick start, you'll:

  1. βœ… Set up a simple eye-tracking study
  2. βœ… Test it yourself as a participant
  3. βœ… View beautiful heatmap visualizations
  4. βœ… Export your data

Let's go! πŸš€

Step 1: Launch RemoteGazeUXΒΆ

Open your terminal and start the application:

cd RemoteGazeUX
python run.py

After being asked to modify your configuration, create admin users you should see:

✨ RemoteGazeUX is running!
πŸ”— URL: https://localhost:5001

Keep this terminal window open

The application runs here. You'll see helpful logs as participants connect.

Step 2: Create Your StudyΒΆ

Use the Configuration GUIΒΆ

When running RemoteGazeUX you should see

Do you want to modify configurations before running the application? (y/n):

Inputting yes will open a GUI for setting a new prototype URL, a different port or also change the tasks.

Also, you can open this GUI with:

python src/config.py

A friendly GUI window appears! 🎨

TODO: hacer captura

Configuration GUI

Fill in your study details:

  • Study Name: "My First Eye-Tracking Test"
  • Prototype URL: Use the demo or your own Figma prototype
  • Demo: https://www.figma.com/proto/example (try a real Figma link!)
  • Or upload an image path: /path/to/your/image.png
  • Tasks: Define what participants should do
  • Task 1: "Find the login button"
  • Task 2: "Locate the search feature"

Click Save βœ…

Step 3: Test as a ParticipantΒΆ

Now for the fun part β€” experience what your participants will see!

3.1 Open the StudyΒΆ

Navigate to: http://localhost:5000

3.2 Fill the Entry FormΒΆ

You'll see a clean registration form:

Entry Form

Fill in test data:

  • Name: Test
  • Surname: User
  • Age: 25

Click Submit 🎯

3.3 CalibrationΒΆ

Calibration is Key

Good calibration = accurate eye-tracking data. Take your time here!

You'll see a series of dots on screen:

  1. Sit comfortably - Keep your head relatively still
  2. Click each dot - Look directly at each point when clicking
  3. Click 5 times per dot when prompted
  4. Follow instructions carefully

Calibration

Pro Tip

Room lighting matters! Avoid backlighting (windows behind you) for best results.

3.4 Complete the TasksΒΆ

After calibration, you'll see your prototype with task instructions:

  • Task instructions appear at the top

Just interact naturally! Look around, click things, explore the interface.

Tracking Session

3.5 FinishΒΆ

When all tasks are complete, you'll see a thank you message.

Congratulations! You've just collected your first eye-tracking data! πŸŽ‰

Step 4: View Your ResultsΒΆ

Now for the exciting part β€” see what you tracked!

4.1 Access the Admin PanelΒΆ

Navigate to: http://localhost:5000/sujetos

Login with your admin credentials.

4.2 Explore Your DataΒΆ

Admin Panel

You'll see:

  • Studies tab - All your studies
  • Participants list - Click on "Test User"
  • Session details - Timestamp, duration, task completion

4.3 View the HeatmapΒΆ

Click "View Results" for your test participant.

Heatmap

Wow! 🀯 This heatmap shows:

  • πŸ”₯ Hot spots (red/yellow) - Where you looked most
  • 🧊 Cold spots (blue/green) - Areas you ignored
  • ⚫ Blind spots - Never looked at

4.4 Analyze the DataΒΆ

Toggle through different visualizations:

  • Static Heatmap - Overall attention distribution
  • Gaze Plot - Sequential path of eye movements
  • Mouse Track - Where you clicked and moved

Publication-Ready Graphics

These visualizations are high-quality and ready for presentations or papers!

Step 5: Export Your DataΒΆ

Want to analyze the raw data? Easy!

Export Individual SessionΒΆ

On the results page, click "Download CSV"

You'll get a file with columns:

date,x_mouse,y_mouse,x_gaze,y_gaze
2025-10-16 11:32:36,0.0,0.0,1399.614608374622,485.90008997831643
2025-10-16 11:32:36,0.0,0.0,1173.1436953906164,400.8048705042029
2025-10-16 11:32:36,0.0,0.0,1097.997644500679,373.6929253870312
2025-10-16 11:32:36,0.0,0.0,1908.0,0.0
...

Perfect for analysis in Python, R, Excel, or your favorite tool!

Export Entire StudyΒΆ

From the studies page, click "Download All Data" to get all participants data.

πŸŽ“ You Did It!ΒΆ

In just 10 minutes, you've:

  • βœ… Set up a study
  • βœ… Collected eye-tracking data
  • βœ… Generated professional visualizations
  • βœ… Exported data for analysis

πŸš€ Next StepsΒΆ

Now that you know the basics, level up:

Make it Your Own:

  • Add more tasks
  • Use your own prototypes

Configuration guide β†’

Deep Dive into Data:

  • Statistical analysis
  • Comparison between participants
  • Task performance metrics
  • Attention mapping

Power User Mode:

  • Multiple simultaneous studies
  • Custom databases
  • API integration
  • Automated reporting

Documentation soon...

πŸ’‘ Tips for SuccessΒΆ

Best Practices

For Accurate Data:

  • Ensure good lighting (avoid backlighting)
  • Ask participants to keep their head relatively still
  • Test your calibration process first

For Better Studies:

  • Keep tasks clear and specific
  • Don't have too many tasks
  • Pilot test with 2-3 people first
  • Provide clear instructions to participants

Common Gotchas

  • Calibration skipped? Data quality suffers. Always calibrate!
  • Poor lighting? Tracking accuracy drops
  • Too many browser tabs? Close them for better performance
  • Mobile devices? Eye-tracking works best on desktop/laptop

🎯 Challenge: Run a Real Study!¢

Ready for the real deal?

  1. Design a meaningful study - What do you want to learn?
  2. Recruit 5-10 participants - Friends, colleagues, or users
  3. Collect real data - Run your study!
  4. Analyze and share - What did you discover?

Share your results with the community β€” we'd love to see what you learn! 🌟


Feeling confident? β†’ Learn about all features

Want to go deeper? β†’ Advanced configuration