Skip to content

Repository files navigation

#

#

#

#

#

▒▒████▓▓▒▒██▓▒▒▓▓▒▒████░▒
▓██▓██████▓████████▓█▒██████░░
▓█▒█████▒████▓████▓█████▓███▓███
▓█▓▒▒████▓████▒████████▒██▓▓██▒██████▒███▒██████▒▒
▓█▓▓█▒████▒█████████▒█████▒███████▒████████▒▒▒█████████▒░░░ ░
▓█▓█████▓▒▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░▓▓
▓█▓█▒██▓▓▓▒   ░     ░    ░        ░░░    ░  ░░    ░     ░  ▓▓
▓█▓▒██▓▓▒▒  ██▀███ ░▓█████  ▄████▄   ██ ▄█▀ ██▓░▓▓█████▓░ ▓▒
▓█▓█▒▓▓▓  ▓██ ▒ ██▒▓█   ▀ ▒██▀ ▀█   ██▄█▒ ▓██▒▓  ░██▒ ▓▒ ▓▓
▓█▓▓█▓▓  ▓██ ░▄█░▒▒███   ▒▓█    ▄ ▓███▄░ ▒██▒▒  ▓██░ ▒░░░▓░
▓█▓█▒▓▓ ▒██▀▀█▄  ▒▓█  ▄ ▒▓▓▄ ▄██▒▓██ █▄ ░██░░  ▓██▓ ░  ░▓▓
▓█▒█▓▓ ░██▓ ▒██▒░▒████▒▒ ▓███▀ ░▒██▒ █▄░██░  ░▒██▒ ░  ░▒▓░
▓█▓█▓▓░ ▒▓ ░▒▓░░░ ▒░ ░░ ░▒ ▒  ░▒ ▒▒ ▓▒░▓    ▒ ░░ ▒░ ░░ ▓▓
▓█▓▓▓▒  ░▒ ░ ▒░ ░ ░  ░  ░  ▒░  ░ ░▒ ▒░ ▒ ░    ░  ░▒  ░▓▓
░▒▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░v0.3
Realtime · Edit-free · Capture · Kyonax · Integrated · Toolkit

WHAT IS RECKIT?

An OBS toolkit that does the editing at capture time. RECKIT bundles cyberpunk HUD overlays, scene collections, and WebSocket automation scripts into one per-brand system, scoped for every Kyonax content creation identity (@kyonax_on_tech, @is.kyonax, CCS, and any future channel under the Kyonax umbrella).

reckit/
  @kyonax_on_tech/      <- brand folder (one per content creation identity)
    assets/             <- reference images
    overlays/           <- HTML/CSS/JS browser source overlays
    scripts/            <- OBS WebSocket automation
    config/             <- scene collections & profiles
  @is.kyonax/           <- (planned) same four-component layout
  ...

NOTE: This is a Personal project. RECKIT exists to solve a specific problem for its author. It is not designed as a general-purpose tool, and there are no current plans to make it one. If the idea proves feasible and there is genuine community interest, it may evolve into something broader, but for now the scope is intentionally personal. If you find it useful, feel free to download and adapt it to your own setup.

SETUP

git clone https://github.com/Kyonax/reckit.git
cd reckit
npm ci
cp .env.example .env    # fill in your OBS WebSocket values
npm run dev             # http://localhost:5173/

Requires Node.js >=20 and npm. OBS Studio with WebSocket (port 4455) is only needed for testing overlays live.

ScriptPurpose
npm run devVite dev server on 5173
npm run lintESLint check
npm run testVitest suite
npm run buildProduction bundle

CONTRIBUTING

See CONTRIBUTING.org for the full guide: prerequisites, code conventions, branch workflow, CI pipeline, and PR process.

Quick summary:

  • Code style follows CCS standards, enforced via eslint.config.mjs
  • snake_case variables, camelCase functions, UPPER_CASE constants, PascalCase classes
  • Vue 3 Composition API with <script setup> only
  • Every source file needs the MPL-2.0 license header
  • All changes require review from @Kyonax (CODEOWNERS)
  • Branch model: master <- dev <- feat-* / fix-*
  • All PRs must pass 6 CI checks before merge

Dual-licensed under MPL-2.0 and Apache-2.0. See LICENSING.org for details. Security rules at SECURITY.org. Version history at CHANGELOG.org.

About

Capture-time OBS automation toolkit — Overlays, scenes, and scripts that skip the editing.

Topics

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages