Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ali205412/wf-recorder-gui
wf-recorder GUI (GTK)
https://github.com/ali205412/wf-recorder-gui
gtk screen-capture wayland wf-recorder wl-roots
Last synced: about 1 month ago
JSON representation
wf-recorder GUI (GTK)
- Host: GitHub
- URL: https://github.com/ali205412/wf-recorder-gui
- Owner: ali205412
- License: mit
- Created: 2024-11-22T05:20:51.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-22T06:06:12.000Z (about 1 month ago)
- Last Synced: 2024-11-22T06:22:56.669Z (about 1 month ago)
- Topics: gtk, screen-capture, wayland, wf-recorder, wl-roots
- Language: Rust
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WF Recorder GUI
[](https://github.com/ali205412/wf-recorder-gui/actions/workflows/ci.yml)
[](https://github.com/ali205412/wf-recorder-gui/actions/workflows/release.yml)
[](https://aur.archlinux.org/packages/wf-recorder-gui/)
A modern, minimal, and sleek GUI for wf-recorder, the Wayland screen recorder. Built with GTK4 and Rust, featuring an intuitive interface and efficient workflow.
## Features
- Modern GTK4 native interface
- Clean, minimal design
- Full screen and region capture
- Multiple audio source options:
- System audio
- Microphone
- No audio
- Multiple output formats:
- WebM
- MP4
- MKV
- Custom save location
- Hardware acceleration support
- Wayland native
## Installation
### Arch Linux (Recommended)
Install from AUR:
```bash
yay -S wf-recorder-gui
```
or
```bash
paru -S wf-recorder-gui
```
### Other Distributions
Build from source:
1. Install dependencies (package names may vary):
- GTK4
- libadwaita
- wf-recorder
- Rust toolchain
2. Build and install:
```bash
git clone https://github.com/ali205412/wf-recorder-gui.git
cd wf-recorder-gui
cargo build --release
sudo install -Dm755 target/release/wf-recorder-gui /usr/bin/wf-recorder-gui
sudo install -Dm644 wf-recorder-gui.desktop /usr/share/applications/wf-recorder-gui.desktop
```
## Usage
1. Launch the application
2. Choose your recording options:
- Select output format (WebM/MP4/MKV)
- Choose capture mode (Full Screen/Region)
- Select audio source (System/Microphone/None)
- Set save location
3. Click Record to start
4. Click Stop when finished
## Development
### Requirements
- Arch Linux (recommended for development)
- Dependencies:
```bash
sudo pacman -S gtk4 libadwaita wf-recorder base-devel rust
```
### Project Structure
```
src/
├── audio/ # Audio handling
├── config/ # Configuration management
├── recorder/ # Recording functionality
├── ui/ # User interface components
└── main.rs # Application entry point
```
### CI/CD Workflows
The project uses GitHub Actions for:
- Continuous Integration (CI)
- Building and testing on Arch Linux
- Code formatting checks
- Clippy linting
- Security audits
- Release automation
- Building Arch packages
- Creating GitHub releases
- Automated AUR updates
- Publishing and updating the AUR package
### Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
Please make sure to:
- Follow the existing code style
- Add tests if applicable
- Update documentation as needed
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- [wf-recorder](https://github.com/ammen99/wf-recorder) - The underlying screen recording utility
- [GTK](https://gtk.org/) - The GUI toolkit
- All contributors and users of this project
## Support
If you encounter any issues or have suggestions:
1. Check the [Issues](https://github.com/ali205412/wf-recorder-gui/issues) page
2. Open a new issue if needed
3. Provide as much detail as possible:
- System information
- Steps to reproduce
- Expected vs actual behavior