Skip to content

A Stream Deck plugin inspired by streamdeck-starcitizen

License

Unknown and 2 other licenses found

Licenses found

Unknown
LICENSE
Unknown
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

VeeLume/streamdeck-sc-mapper

Repository files navigation

Contributors Forks Stargazers Issues project_license


Stream Deck SC Mapper

Helps manage Star Citizen keybinds
Download · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Support

About The Project

Stream Deck SC Mapper helps manage Star Citizen keybinds:

  • Stream Deck plugin — browse, trigger, and manage actions directly from your deck.
  • CLI tool (scmap-gen) — generate mappings.xml from the game’s defaultProfile.xml and optional custom profile.
  • Core crate — parsing, bind generation, translations, and profile I/O shared by both.

Workspace layout:

crates/
  core/     # streamdeck-sc-core: shared logic
  plugin/   # streamdeck-sc-mapper: Stream Deck plugin
  cli/      # scmap-gen: CLI tool

(back to top)

Built With

(back to top)

Getting Started

There are two ways to use this project:

  • Normal users — install the Stream Deck plugin from Releases (recommended).
  • Advanced users — use the CLI tool (scmap-gen) or build from source.

Recommended Install

  1. Go to the Releases page.
  2. Download the latest .streamDeckPlugin file (e.g. icu.veelume.sc-mapper.streamDeckPlugin).
  3. Double-click it — the Stream Deck app will automatically install or update the plugin.
  4. Restart the Stream Deck software if it doesn’t appear right away.
  5. Open the Stream Deck app → look for the SC Mapper category → drag actions onto your keys.

Optional CLI Tool

The CLI lets you generate or rebuild Star Citizen keybinding profiles outside the plugin.

Windows example:

  1. Download scmap-gen.exe from the release assets.
  2. Open Command Prompt (Win+R → cmd).
  3. Run:
scmap-gen.exe --default "./defaultProfile.xml" --include-custom

Options:

  • --default -> required, points to the defaultProfile.xml extracted from the game files. You can find the current shipped one here here (i try to keep that up to date until i have extraction solution ready).
  • --include-custom -> also merges you current keybinds
  • Result: generates mappings-generated.xml profile with missing binds filled in

To see all possible options run:

scmap-gen.exe --default "./defaultProfile.xml" --help

Advanced Build

If you want to develop or build your own binaries:

git clone https://github.com/veelume/streamdeck-sc-mapper.git
cd streamdeck-sc-mapper
cargo build --release

The built plugin will be under target/release/, and you can repackage or link it with the Elgato CLI.

(back to top)

Usage

CLI

scmap-gen --default "path/to/defaultProfile.xml" --include-custom

Generates mappings-generated.xml with missing binds filled in.

Plugin

After installation, add SC Mapper actions to your Stream Deck.

(back to top)

Roadmap

  • Automatically extract the defaultProfile.xml and globals.ini from the game files
  • Power setup action
  • MFD setup action
  • Expand cli options
  • Profile export/import UI

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:

contrib.rocks image

License

This project is licensed under either of

(back to top)

Contact

Project Link: https://github.com/veelume/streamdeck-sc-mapper

(back to top)

Support

  • Open an Issue for bugs or feature requests
  • Discussions for questions or any other input

About

A Stream Deck plugin inspired by streamdeck-starcitizen

Topics

Resources

License

Unknown and 2 other licenses found

Licenses found

Unknown
LICENSE
Unknown
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks