羽衣 - Hagoromo -

(English follows Japanese.)

概要

マルチカラム対応のBlueskyクライアントです。

動作確認環境

• Windows 11 Profesional
• Ubuntu 22.04
• Mac 15.0.1(x86 on ARM)

使用ソフトウェア

• Qt 6.8.1
• OpenSSL 3.4.0
• cpp-httplib 0.18.1
• zlib 1.3.1
• Hugo 0.92.2

ダウンロード

ビルド済みの実行ファイルはReleasesよりダウンロードしてください。

インストール

アーカイブを解凍して任意のフォルダに保存してください。

使用方法

ユーザーマニュアルを参照してください。

ビルド方法

共通

ビルドするプラットフォームのQt 6.8.1をインストールしてください。

Official site : Qt

Windows

Microsoft Visual Studio 2022をインストールしてください（Community Edition も利用可能です）。

CRLF（Windows のデフォルト）の改行コードでリポジトリを確認してください。

注意: 以下のコマンドはコマンドプロンプト（cmd）用です。PowerShell を使用する場合は、コメントの REM を # に置き換えてください。

REM checkout repo
>git clone git@github.com:ioriayane/Hagoromo.git
>cd Hagoromo
>git submodule update -i
REM copy and edit encryption seed
>copy lib\tools\encryption_seed_template.h lib\tools\encryption_seed.h
REM build Hagoromo
>.\scripts\build.bat path\to\Qt\6.8.1\msvc2022_64\
REM Execute
>deploy-hagoromo\hagoromo\Hagoromo.exe

Ubuntu

build.shでビルドします。

# checkout repo
$ git clone [email protected]:ioriayane/Hagoromo.git
$ cd Hagoromo
$ git submodule update -i
# setup dependent modules
$ sudo apt-get install zlib1g-dev ninja-build
# copy and edit encryption seed
$ cp lib/tools/encryption_seed_template.h lib/tools/encryption_seed.h
$ vi lib/tools/encryption_seed.h
# build Hagoromo
$ ./scripts/build.sh linux path/to/Qt/6.8.1/gcc_64/
# exec hagoromo
$ ./deploy-hagoromo/hagoromo/Hagoromo.sh

Mac

build.shでビルドします。

# checkout repo
$ git clone [email protected]:ioriayane/Hagoromo.git
$ cd Hagoromo
$ git submodule update -i
# copy and edit encryption seed
$ cp lib/tools/encryption_seed_template.h lib/tools/encryption_seed.h
$ vi lib/tools/encryption_seed.h
# build Hagoromo
$ ./scripts/build.sh mac path/to/Qt/6.8.1/gcc_64/
# exec hagoromo
$ open ./deploy-hagoromo/hagoromo/Hagoromo.app

コントリビューション

変更を加えるときはdevからブランチして、devにプルリクエストを提出してください。

また、下記の事項を実施してください。Github Actionsにてチェックしています。

ソースコードの整形

pre-commitを使用しています。

git hookで実行されるように公式サイトを確認してセットアップしてください。

セットアップ例

$ pip install pre-commit
$ pre-commit --version
pre-commit 3.7.1
$ cd path/to/this_repo
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

単体テスト

いづれかの環境で実行してクリアできることを確認してください。

Windows

> .\scripts\unittest.bat path\to\Qt\6.8.1\msvc2022_64\

Ubuntu

$ ./scripts/unittest.sh linux path/to/Qt/6.8.1/gcc_64/

Mac

$ ./scripts/unittest.sh mac path/to/Qt/6.8.1/gcc_64/

---

Overview

This is a multi-column Bluesky client.

System Requirements

• Windows 11 Profesional
• Ubuntu 22.04
• Mac 15.0.1(x86 on ARM)

Software used

• Qt 6.8.1
• OpenSSL 3.4.0
• cpp-httplib 0.18.1
• zlib 1.3.1
• Hugo 0.92.2

Download

Please download the pre-built executable from Releases.

Installation

Unzip the archive and save it in any folder.

How to Use

Please refer to the User's Manual.

How to Build

Common

Install Qt 6.8.1 for the platform you want to build.

Official site : Qt

Windows

Install Microsoft Visual Studio 2022 (Community Edition is also available).

Check out the repository with CRLF (Windows default) line endings.

Note: The following commands are for Command Prompt (cmd). If you use PowerShell, replace REM with # for comments.

REM checkout repo
>git clone git@github.com:ioriayane/Hagoromo.git
>cd Hagoromo
>git submodule update -i
REM copy and edit encryption seed
>copy lib\tools\encryption_seed_template.h lib\tools\encryption_seed.h
REM build Hagoromo
>.\scripts\build.bat path\to\Qt\6.8.1\msvc2022_64\
REM Execute
>deploy-hagoromo\hagoromo\Hagoromo.exe

Ubuntu

It is built with build.sh.

# checkout repo
$ git clone [email protected]:ioriayane/Hagoromo.git
$ cd Hagoromo
$ git submodule update -i
# setup dependent modules
$ sudo apt-get install zlib1g-dev ninja-build
# copy and edit encryption seed
$ cp lib/tools/encryption_seed_template.h lib/tools/encryption_seed.h
$ vi lib/tools/encryption_seed.h
# build Hagoromo
$ ./scripts/build.sh linux path/to/Qt/6.8.1/gcc_64/
# exec hagoromo
$ ./deploy-hagoromo/hagoromo/Hagoromo.sh

Mac

It is built with build.sh.

# checkout repo
$ git clone [email protected]:ioriayane/Hagoromo.git
$ cd Hagoromo
$ git submodule update -i
# copy and edit encryption seed
$ cp lib/tools/encryption_seed_template.h lib/tools/encryption_seed.h
$ vi lib/tools/encryption_seed.h
# build Hagoromo
$ ./scripts/build.sh mac path/to/Qt/6.8.1/gcc_64/
# exec hagoromo
$ open ./deploy-hagoromo/hagoromo/Hagoromo.app

Contribution

If you want to make changes, please branch from dev and submit a pull request to dev.

Also, please make sure your changes pass the checks in Github Actions.

Code formatting

pre-commit is used for source code formatting. Please check the official site and set it up to run with git hook.

Setup Example

$ pip install pre-commit
$ pre-commit --version
pre-commit 3.7.1
$ cd path/to/this_repo
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit

Note: Ensure that .pre-commit-config.yaml exists in the repository root.

Unit Tests

Please confirm that you can clear the tests by running them in one of the environments.

Windows

> .\scripts\unittest.bat path\to\Qt\6.8.1\msvc2022_64\

Ubuntu

$ ./scripts/unittest.sh linux path/to/Qt/6.8.1/gcc_64/

Mac

$ ./scripts/unittest.sh mac path/to/Qt/6.8.1/gcc_64/