Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sergioribera/sss
SSS (Super ScreenShot) is a WIP: CLI/Lib to take amazing screenshot of code or screen
https://github.com/sergioribera/sss
code rust rust-lang screen screenshot
Last synced: 1 day ago
JSON representation
SSS (Super ScreenShot) is a WIP: CLI/Lib to take amazing screenshot of code or screen
- Host: GitHub
- URL: https://github.com/sergioribera/sss
- Owner: SergioRibera
- License: apache-2.0
- Created: 2023-12-07T21:00:06.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-18T00:32:05.000Z (2 months ago)
- Last Synced: 2025-01-13T01:19:34.547Z (9 days ago)
- Topics: code, rust, rust-lang, screen, screenshot
- Language: Rust
- Homepage: https://sergioribera.github.io/sss/
- Size: 5 MB
- Stars: 116
- Watchers: 2
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Super ScreenShot
Super ScreenShot is a set of libraries and tools for building screenshots in a standardized, high-performance image format made in rust.
## 🧩 Libraries
It provides different options depending on your needs.
- [sss_lib](./crates/sss_lib): The base library for screenshot generation, providing the core functionality for the other tools.
- [sss_code](./crates/sss_code): A terminal tool specifically designed to take screenshots of your code, making it easy to share and showcase your snippets.
- [sss](./crates/sss_cli): A versatile terminal tool that allows you to capture screenshots of your entire screen or specific regions.
## 🚀 Installation
> [!IMPORTANT]
> At the moment the tool is not available in any store. Please redirect to [releases](https://github.com/SergioRibera/sss/releases) section in order to download.
### Nix
sss packages are built and cached automatically. To avoid unnecessary recompilations, you may use the binary cache.
```nix
nix.settings = {
builders-use-substitutes = true;
extra-substituters = [ "https://sss.cachix.org" ];
extra-trusted-public-keys = [ "sss.cachix.org-1:YI2JMG95LEu62PC7VMz75N7bypEdUz9Z/Il1hkGH4AA=" ];
};
```
> [!WARNING]
> While using the sss flake, overriding the nixpkgs input for sss will cause cache hits, i.e., you will have to build from source every time. To use the cache, do not override the Nixpkgs input.
On nix you can use the provided flake:
```nix
# flake.nix
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
sss = {
url = "github:SergioRibera/sss";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = { self, nixpkgs }: {
nixosConfigurations."" = nixpkgs.lib.nixosSystem {
# ...
modules = [
# Add sss to modules to make it available
inputs.sss.nixosModules.default
{
programs.sss {
enable = true; # Enable principal cli to take screenshots
code = true; # Enable sss_code to capture code
}
}
];
# ...
};
};
}
```
### Nix Home-Manager
> [!INFO]
> You can find more details about the available options at [here](./nix/hm-module.nix)
```nix
home-manager.users."yourusername" = ({
imports = [
inputs.sss.nixosModules.home-manager
];
programs.sss = {
enable = true;
code = {
enable = true;
line-numbers = true;
};
general = {
shadow = true;
shadow-image = true;
author = "@SergioRibera";
colors = {
background = "#FFFFFF";
author = "#000000";
};
};
};
};
```
## ⚙️ Configuration
> [!NOTE]
> To know how to configure it from a file, you can review the [default.toml](./examples/default_config.toml) file.
>
All cli arguments can be set from a single file in the path `~/.config/sss/config.toml`, right here you can place the configuration for `sss_code` and `sss`.
## 💻 Usage
You can find examples and options in the following links.
- [sss_cli](https://sergioribera.rustlang-es.org/sss/sss/): Screenshots of your screen.
- [sss_code](https://sergioribera.rustlang-es.org/sss/sss_code/): Screenshots of your code.
## 💡 Acknowledgments
- [syntect](https://github.com/trishume/syntect): Rust library for syntax highlighting using Sublime Text syntax definitions.
- I use this library for code highlighting and parsing.
- [djanho](https://github.com/viniciusmuller/djanho): Convert VSCode themes to (Neo)Vim colorschemes
- Use this project to understand how to import (Neo)vim themes.
## 🏁 Other Goals
- [silicon](https://github.com/Aloxaf/silicon): Create beautiful image of your source code.
- I used it as a basis for my code screenshot project.