https://github.com/pqrs-org/Tinkle

https://github.com/pqrs-org/Tinkle

macos

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pqrs-org/Tinkle
• Owner: pqrs-org
• License: unlicense
• Created: 2020-01-26T12:49:35.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-11T22:52:01.000Z (7 months ago)
• Last Synced: 2024-08-01T16:56:09.761Z (5 months ago)
• Topics: macos
• Language: Swift
• Homepage: https://tinkle.pqrs.org
• Size: 25.9 MB
• Stars: 82
• Watchers: 5
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-starred-test - pqrs-org/Tinkle - (Swift)

README

        
[![Build Status](https://github.com/pqrs-org/Tinkle/workflows/CI/badge.svg)](https://github.com/pqrs-org/Tinkle/actions)

[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://github.com/pqrs-org/Tinkle/blob/main/LICENSE.md)

# Tinkle

Tinkle is a macOS app which appends a visual effect for the focused window changes.


It helps finding the focused window when you switched it by keyboard shortcuts.

![Tinkle](docs/Tinkle.gif)

## Download

You can download from .

## Supported systems

macOS 11 Big Sur or later.

### Required privilege

Tinkle requires accessibility features in order to detect the focused window changes.



---

## For developers

### How to build

System requirements to build Tinkle:

-   macOS 11.0+

-   Xcode 13+

-   Command Line Tools for Xcode

-   [XcodeGen](https://github.com/yonaskolb/XcodeGen)

-   [create-dmg](https://github.com/sindresorhus/create-dmg)

#### Steps

1.  Get source code by executing a following command in Terminal.app.

    ```shell

    git clone --depth 1 https://github.com/pqrs-org/Tinkle.git

    cd Tinkle

    git submodule update --init --recursive --depth 1

    ```

2.  Find your codesign identity if you have one.


    (Skip this step if you don't have your codesign identity.)

    ```shell

    security find-identity -p codesigning -v | grep 'Developer ID Application'

    ```

    The result is as follows.

    ```text

    1) 8D660191481C98F5C56630847A6C39D95C166F22 "Developer ID Application: Fumihiko Takayama (G43BCU2T37)"

    ```

    Your codesign identity is `8D660191481C98F5C56630847A6C39D95C166F22` in the above case.

3.  Set environment variable to use your codesign identity.


    (Skip this step if you don't have your codesign identity.)

    ```shell

    export PQRS_ORG_CODE_SIGN_IDENTITY=8D660191481C98F5C56630847A6C39D95C166F22

    ```

4.  Build a package by executing a following command in Terminal.app.

    ```shell

    make package

    ```

    `Tinkle-*.dmg` will be generated.

    Note: If you don't have codesign identity, the dmg works only on your machine.

### Update/Add effects

The project uses Metal's compute shaders to create effects, which are stored in `src/Share/metal`.

To preview these effects, the project includes a tool called ShaderViewer.

This tool allows you to conveniently review and modify the shaders.