============================================================
 TikEnjoy Desktop 0.1.0-beta.11  はじめかた
============================================================

TikTok LIVE のギフト・コメントに合わせて、OBS の画面演出を
自動で出すツールです。
TikTok への接続も集計もあなたの PC の中で動きます。


■ 1. 必要なもの
------------------------------------------------------------
 ・Windows 10 または 11 (64bit)
 ・OBS Studio または TikTok LIVE Studio (演出を画面に出すために使います)
 ・インターネット接続
 ※ Node.js のインストールは不要です (この zip に同梱しています)。


■ 2. インストール (最初の 1 回だけ)
------------------------------------------------------------
 1) この zip を、日本語やスペースを含まない浅いフォルダに展開します。
      おすすめ: C:\TikEnjoy\
    ★「TikEnjoy.exe」と「resources」フォルダは必ず同じ場所に
      置いてください。exe だけを取り出すと動きません。

 2) 「TikEnjoy.exe」をダブルクリックします。

 3) 「Windows によって PC が保護されました」と青い画面が出たら
      「詳細情報」→「実行」
    の順にクリックしてください。
    これは、このアプリが新しくて署名がまだ無いために出る警告です
    (ウイルスが見つかったという意味ではありません)。
    2 回目からは出ません。

 4) 10 秒ほどでブラウザが自動で開き、
      http://localhost:8787
    が表示されます。開かないときは、ブラウザに自分で入力してください。
    ★「127.0.0.1」ではなく「localhost」で開いてください (ログインに必要です)。

 5) 画面の案内に従ってログインします。
      ・メールアドレスを入れる → 届いたメールのリンクを同じ PC で開く
      ・または Google アカウントでログイン
    最初にログインした人がこの PC の管理者になります。

 6) ファイアウォールの確認が出たら「許可」を選んでください。


■ 3. 動いているかの確認と止めかた
------------------------------------------------------------
 ・動作中は、画面右下の通知領域 (時計の左) に TikEnjoy のアイコンが出ます。
   隠れているときは「^」をクリックすると出てきます。
 ・アイコンを右クリックすると
      ダッシュボードを開く / ログフォルダを開く / 終了
   が選べます。
 ・止めるときは「終了」を選びます。
 ★黒い画面 (コマンドプロンプト) は出ません。出ないのが正常です。


■ 4. 配信のたびにやること
------------------------------------------------------------
 1) TikEnjoy.exe を起動する (すでに動いていればそのままで OK)
 2) ブラウザのダッシュボードで TikTok の接続を開始する
 3) OBS の場合: 「ブラウザ」ソースを追加し、ダッシュボードの
    「OBS のブラウザソース用」URL を貼り付ける (幅 1920 / 高さ 1080 を推奨)
    TikTok LIVE Studio の場合: 「リンク」ソースを追加し、ダッシュボードの
    「TikTok LIVE Studio 用」URL を貼り付ける (localhost の URL は
    受け付けないため、自分の PC を指す別名 127.0.0.1.nip.io を使います)


■ 5. パソコンの起動と同時に立ち上げる (おすすめ)
------------------------------------------------------------
 1) TikEnjoy.exe を右クリック →「ショートカットの作成」
 2) キーボードの Windows キー + R を押して、
      shell:startup
    と入力して Enter (スタートアップ フォルダが開きます)
 3) 1) で作ったショートカットをそのフォルダに入れる
 これで PC を起動すると自動で立ち上がります。


■ 6. 配信中にスリープさせない
------------------------------------------------------------
 PC がスリープすると TikTok との接続が切れ、その間のギフトは
 記録されません。配信前に以下を設定してください。
   設定 → システム → 電源とバッテリー → 画面とスリープ
     →「次の時間が経過後、デバイスをスリープ状態にする」を「なし」


■ 7. データの保存場所
------------------------------------------------------------
   %LOCALAPPDATA%\TikEnjoy
 (エクスプローラーのアドレス欄に上の 1 行を貼って Enter で開きます。
  トレイアイコンの右クリック →「ログフォルダを開く」でも開けます)
   data.db       … 設定・ルール・集計データ
   backup\       … 起動時に自動で取る data.db の控え
   launcher.log  … 起動まわりの記録
   server.log    … アプリ本体の記録
   crash.log     … 不具合が起きたときの記録
 このフォルダは zip の外にあるので、更新してもデータは消えません。


■ 8. 更新のしかた
------------------------------------------------------------
 1) トレイアイコンを右クリック →「終了」で止める
 2) 新しい zip を展開し、今のフォルダに上書きする
 3) TikEnjoy.exe をもう一度起動する
 設定・ルール・集計データはそのまま引き継がれます。


■ 9. うまくいかないときは
------------------------------------------------------------
 1) 中身のメッセージを見る
      resources\bin\TikEnjoy-console.bat
    をダブルクリックすると、黒い画面に途中経過がそのまま出ます
    (普段は使いません。原因を調べるときだけ使ってください)。
 2) それでも分からないときは、次の 3 つのファイルを
    support@tikenjoy.xyz までメールに添付して送ってください。
      %LOCALAPPDATA%\TikEnjoy\launcher.log
      %LOCALAPPDATA%\TikEnjoy\server.log
      %LOCALAPPDATA%\TikEnjoy\crash.log

 よくある原因:
   ・8787 番ポートが他のアプリと衝突 → .env の PORT を変更してください
   ・ログイン画面が出ない → 「localhost」で開いているか確認してください
   ・起動しない → exe と resources フォルダが同じ場所にあるか確認してください


■ 10. 取り扱いの注意
------------------------------------------------------------
 ・同梱の .env に署名キー (TIKTOK_SIGN_API_KEY) を設定した場合、
   その内容を他人に見せたり配信画面に映したりしないでください。
 ・data.db と各種ログには視聴者名やコメントが含まれます。
   この PC の外に出さないでください。

------------------------------------------------------------
 TikEnjoy Desktop 0.1.0-beta.11 / 同梱 Node v22.23.2
============================================================
