https://github.com/decomoji/decomoji

Custom icon collection for slack reaction
https://github.com/decomoji/decomoji

Last synced: 6 days ago
JSON representation

Custom icon collection for slack reaction

• Host: GitHub
• URL: https://github.com/decomoji/decomoji
• Owner: decomoji
• License: mit
• Created: 2015-10-19T11:00:42.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-03-30T12:58:27.000Z (3 months ago)
• Last Synced: 2024-03-30T13:46:42.403Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 70 MB
• Stars: 778
• Watchers: 20
• Forks: 80
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Lists

• awesome-stars - decomoji/decomoji - Custom icon collection for slack reaction (JavaScript)
• awesome-stars - decomoji

README

        
# decomoji v5

「デコモジ（decomoji）」は Slack のリアクション機能で使える最強カスタム絵文字セットです。このプロジェクトではそれら一つ一つを「デコモジ」と呼んでいます。

![デコモジ v5 の基本セットの一覧画像](docs/images/ss_basic.png)

## デコモジの特徴



🎨カラフルなテキスト画像

見やすい 12 のカラーパレットで Slack に彩を添えます！

🌓ダークモード対応

調整を重ねたカラーパレットで背景が暗くてもデコモジなら見えます！

🍱職人による割中レイアウト

2 行取りを基本に、文字数が多いものは 3 〜 5 行でレイアウトしました！

📦圧倒的な物量

まさに数の暴力！ 全体で 20000 個あるデコモジなら使いたいリアクションが必ず見つかります！

🤖登録と削除の自動化スクリプト

膨大なデコモジもコマンドラインから自動でインストールできます！



デコモジはテキストを書き込んだ画像ファイルです。略語、字詰め、ワクワク感にこだわりました。

ハイコンテキスト！　だから使って楽しい！

デコモジはあなたのワークスペースに**カルチャーとベロシティを提供**します！

![Slack の発言にデコモジでリアクションをした様子。楽しそう！](docs/images/ss_using.png)

## まずは基本セットから始めましょう

デコモジには 3 つのカテゴリがあります。まずは基本セットの 300 個をあなたのワークスペースに登録してしばらく使ってみてください。

物足りなさを感じたら拡張セットも登録しましょう。Slack がもっと楽しくなります！

デコモジ一覧は下記ドキュメントで確認できますが、リンク先のドキュメントにアクセスすると**超大量に画像ファイルを通信する**のでご注意ください。

- [基本セット](docs/LIST-basic.md): すぐに使えて Slack が楽しくなるセットです。

- [拡張セット](docs/LIST-extra.md): 基本セットと合わせるとさらに Slack が便利で楽しくなるセットです。

- 露骨セット: 性的なもの、暴力的なもの、露骨な表現で使用には注意が必要なものを隔離したセットです。多くの場合、使わない方が良いです。

## デコモジを探す

「この言葉ってデコモジにあったっけ？」デコモジが多すぎでわからなくなりますよね。

そんな時は[デコモジファインダー](https://finder.decomoji.dev/?size=ll&category=basic)を使ってみてください。正規表現でも検索できます！

![デコモジファインダーで「tarou」を含むデコモジを検索した様子。いっぱいあるね！](docs/images/ss_finder.png)

## ワークスペースへの登録方法

**カスタム絵文字の登録・削除には権限が必要です。**

デコモジをあなたのワークスペースに登録する方法は 3 つあります。

1. 絵文字登録ページのフォームから一つずつ登録する

2. Chrome 用のエクステンション [Slack Custom Emoji Manager](https://chrome.google.com/webstore/detail/slack-custom-emoji-manage/cgipifjpcbhdppbjjphmgkmmgbeaggpc) で Drag&Drop で登録する

3. スクリプトでコマンドラインから一括登録・削除する

次のセクションで 3 つ目の方法について解説しています。

### スクリプトでコマンドラインから一括登録・削除する

この操作はエンジニア向けです。実行には Node.js v18.16.0 が必要です。

プロジェクトルートで依存パッケージをインストールしてからターミナル等で Node コマンドを実行してください。

```bash

git clone [email protected]:decomoji/decomoji.git

cd decomoji

npm ci

node scripts/manager/index.mjs

```

### スクリプトでできること

- 基本処理モードの選択

  - 追加

  - 削除

  - エイリアス登録

  - v4 から v5 への以降

  - v5 最新版への更新

- 処理する対象タイプの選択

  - カテゴリーごと（基本セット、拡張セット、露骨セット）

  - バージョンごと（v5.x.y ごとにそれぞれ選択可能）

- 処理の強さの選択（削除、移行、更新の場合のみ）

  - 強（権限の限り対象を削除する）

  - 弱（自分が追加したデコモジのみ削除する）

![](docs/images/ss_demo.gif)

対話式でワークスペース、アカウント、パスワード、登録か削除、対象タイプを入力すると、自動で処理が始まります。

2FA ログインを利用している場合は数時間かかる可能性があります。できれば 2FA を解除してから実行してください。

### v4 から v5 への移行

`git pull` でリポジトリを最新版にしてください。



「移行（v4 を v5 に置換）」モードを実行すると v4 のデコモジを v5 に置き換えるため、以下の処理を自動で行います。

1. v4 時代の古いデコモジを全て削除する

2. v5 の新しいデコモジを登録する

3. 古いファイル名から新しいファイル名へのエイリアスを登録する

このモードでは基本セットと拡張セットが登録されます。v4 時代の露骨なデコモジは削除され、**v5 の露骨セットは登録されません。**

### v5 の差分更新

**最低でも v5.0.0 を登録済みのユーザー向けです。**

`git pull` でリポジトリを最新版にしてください。



「更新」モードを実行すると以下の処理を自動で行います。

1. v5.0.0 以降でミスあったデコモジを全て削除する

2. 選択した対象タイプのデコモジを登録する

3. v5.0.0 以降でファイル名の修正があったデコモジのエイリアスを登録する

選択した対象タイプによって動作が異なります。



- 「カテゴリーごと」を選択した場合、カテゴリーに属する全てのデコモジを一括に処理します

- 「バージョンごと」を選択した場合、選択したバージョンで修正、追加、ファイル名変更があったデコモジを抽出し、処理します

例えば、自分が v5.9.0 まで登録したことをわかっている場合は、対象タイプを「バージョンごと」にして、v5.9.1 以降を選択し、実行してください。

これにより v5.9.0 以前に修正、追加されたデコモジは処理しなくなり、カテゴリーを一括に処理するより高速です。

詳しくは実装を確認してください。

## フー・ユーズ・デコモジ？

あなたの所属する組織のチームやコミュニティでデコモジが使われていたら、ぜひ「Who use decomoji?」リポジトリに追加して教えてください！

[who-use-decomoji](https://github.com/decomoji/who-use-decomoji)

## サポートするには

Patreon で支援を受け付けています。



## その他のドキュメント

- [高度な管理方法](docs/ADVANCED.md)

- [コントリビューティングガイドライン](docs/CONTRIBUTING.md)

- [デコモジファイルの命名規則](docs/NOTATIONS.md)

- [チェンジログ](docs/CHANGES.md)

## スペシャルサンクス！

これらのデコモジは、imaz 氏が作成した`:naruhodo:`に影響を受け生み出されました。改めて深く感謝を申し上げます。

[@imaz](https://github.com/imaz/), [@geckotang](https://github.com/geckotang/), [@ginpei](https://github.com/ginpei/), [@watilde](https://github.com/watilde/), [@matori](https://github.com/matori/), [@fukayatsu](https://github.com/fukayatsu/), [@maiha2](https://github.com/maiha2/), [@webcre8](https://github.com/webcre8/), [@masuP9](https://github.com/masuP9/), [@yuheiy](https://github.com/yuheiy), [@kubosho](https://github.com/kubosho) and All Contributors!

## ライセンス

Copyright (c) 2015 decomoji consortium and other contributors.

Under the [MIT License](LICENSE).