Screencaster

A GTK application built with Rust that allows you to cast your screen to another computer or view someone else's screen sharing."
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A GTK application written in Rust that enables screen casting between computers, allowing you to share your screen or view someone else's.
This application was developed as part of an optional project for the 'Programmazione di Sistema' course at Politecnico di Torino.

Features

• 🎯 Multi-Platform Support: Works on Windows, macOS, and Linux.
• 🖥️ User-Friendly Interface: Simple GTK-based UI for easy navigation.
• 🔄 Casting & Receiving Modes: Users can act as casters (sharing their screen) or receivers (viewing someone else’s).
• 📏 Selective Area Streaming: Choose to stream the full screen or only a specific region.
• ⌨️ Hotkey Support: Customizable shortcuts for casting, pausing, resuming, blanking the screen, connecting, disconnecting.
• 🖥️ Multi-Monitor Support: Select which display to share if multiple monitors are connected.
• 🎥 Recording Support: Receivers can record the streamed session to a mp4 video file.
• ✏️ Annotation Tool: Casters can draw over their screen using their mouse. (see this branch)

(back to top)

Built With

• Rust
• GTK4
• GStreamer

(back to top)

Getting Started

Prerequisites

Linux (Fedora)

• Rust Install guide

• gtk4

sudo dnf install gtk4-devel

• gstreamer: Install guide

Windows

MacOS

Installation

1. Clone the repo

   git clone https://github.com/andreabuon/screencaster.git

2. Enter the project folder

   cd screencaster/screencaster

3. Build the project

   cargo build --release

4. Run the app

   cargo run
   

(back to top)

Usage

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

WIP

(back to top)

Contact

• Andrea Buonaurio - Github
• Carmine Francesco Benvenuto - Github
• Salvatore Cimmino - Github

Project Link: https://github.com/andreabuon/screencaster

(back to top)

Acknowledgments

WIP

(back to top)