開発環境の構築・ビルド手順

1. 環境構築
2. ビルド手順 (Quick Start)
   1. ソースコードのチェックアウト
   2. ビルド
3. ビルド手順 (詳説)
   1. ソースコードの clone
   2. ライブラリのビルド
   3. Tera Termのビルド
   4. TTSSHのビルド
   5. TTProxyのビルド
   6. TTXKanjiMenuのビルド
   7. TTXSamplesのビルド
   8. TeraTerm Menuのビルド
   9. CygTerm+のビルド
   10. Cyglaunchのビルド
   11. ヘルプファイルのビルド
   12. インストーラの作成

環境構築

• Visual Studio Community 2022 のインストール
  • C++ によるデスクトップ開発
  • 最新の v143 ビルドツール用 C++ MFC (x86 および x64)
    HTML Help Compiler (hhc.exe) がインストールされます。
• Cygwin のインストール
  CygTerm+ コンパイル専用の Cygwin 環境を構築するには、buildtools\install_cygwin.bat を実行します。
  既存の環境を利用する場合には、こちらを参照してください。
• Perl をインストールします。
• Git for Windows をインストールします。
• CMake をインストールします。
• Inno Setup をインストールします。

Tera Term をビルドするために上記のツールを新規導入するのではなく、すでにインストール済みのツールを使うこともできます。
installer\release.bat がインストール済みのツールを見つけられない場合は、installer\toolinfo_sample.bat を installer\toolinfo.bat にコピーし、適宜編集してください。
また、必要であれば buildtools\svnrev\toolinfo_sample.txt を buildtools\svnrev\toolinfo.txt にコピーし、適宜編集してください。

ビルド手順 (Quick Start)

ソースコードのチェックアウト

ソースコードを GitHub (https://github.com/TeraTermProject/teraterm) から clone します。

ビルド

installer\release.bat を実行し、3を選択します。

ビルド手順 (詳説)

ソースコードの clone

ソースコードを GitHub (https://github.com/TeraTermProject/teraterm) から clone します。

ライブラリのビルド

"x86 Native Tools Command Prompt for VS 2022" を立ち上げるか、適切な PATH を通しておく必要があります。
* の bat を個別に実行するかわりに、libs\buildall.bat を実行することでまとめてビルドすることができます。

• Oniguruma
  1. oniguruma のソースを libs/oniguruma の中に展開する。
  2. libs\buildoniguruma6.bat を実行する。*
• SFMT
  1. SFMT のソースを libs/SFMT の中に展開する。
  2. libs\buildSFMT.bat を実行する。*
  3. 必要に応じて libs/SFMT/SFMT_version_for_teraterm.h のバージョン番号を修正する。
• LibreSSL
  1. LibreSSL のソースを libs/libressl の中に展開する。
  2. buildlibressl.bat を実行する。*
• Zlib
  1. zlib のソースを libs/zlib の中に展開する。
  2. buildzlib.bat を実行する。*
• The reference C implementation of Argon2
  1. argon2 のソースを libs/argon2 の中に展開する。
     argon2 リファレンス実装には静的ライブラリを生成するプロジェクトファイルが含まれていない。
     ttssh ソリューション配下の argon2 プロジェクトにより静的ライブラリが生成され、ttxssh.dll にリンクされるため、展開するだけでよい。
• cJSON
  1. cJSON のソースを libs/cJSON の中に展開する。

Tera Termのビルド

1. teraterm\ttermpro.sln をVisual Studioで開く。
   .slnファイルの改行コードが"LF"になっていると、Visual Studioが起動しないので注意願います。
2. ソリューションをビルドする。
3. ビルドに成功すると teraterm\Debug / teraterm\Release ディレクトリに実行プログラムが生成される。

TTSSHのビルド

1. ttssh2\ttssh.sln をVisual Studioで開く。
2. ソリューションをビルドする。
3. ビルドに成功すると ttssh2\ttxssh\Debug / ttssh2\ttxssh\Release ディレクトリにDLLが生成される。

TTProxyのビルド

1. TTProxy\TTProxy.sln をVisual Studioで開く。
2. ソリューションをビルドする。
3. ビルドに成功すると TTProxy\Debug / TTProxy\Release ディレクトリにDLLが生成される。

TTXKanjiMenuのビルド

1. TTXKanjiMenu\ttxkanjimenu.sln をVisual Studioで開く。
2. ソリューションをビルドする。
3. ビルドに成功すると TTXKanjiMenu\Debug / TTXKanjiMenu\Release ディレクトリに ttxkanjimenu.dll が生成される。

TTXSamplesのビルド

リポジトリのTTXSamplesに Tera Term Extension (TTX)のサンプルがあります。TTXを作る際の参考にしてください。

1. TTXSamples\TTXSamples.sln をVisual Studioで開く。
2. ソリューションをビルドする。
3. ビルドに成功すると TTXSamples\Debug / TTXSamples\Release ディレクトリにDLLが生成される。

各TTXの詳細については、プロジェクト内のReadMe-ja.txtを参照してください。

TeraTerm Menuのビルド

1. ttpmenu\ttpmenu.sln をVisual Studioで開く。
2. ソリューションをビルドする。
3. ビルドに成功すると ttpmenu\Debug / ttpmenu\Release ディレクトリに ttpmenu.exe が生成される。

CygTerm+のビルド

1. Cygwinのシェルを起動し、cygterm ディレクトリへ移動する。

   # cd cygterm
   

2. CygTerm+をコンパイルする。

   # make
   

3. cygterm.exe が生成される。

Cyglaunchのビルド

1. cygwin\cygwin.sln をVisual Studioで開く。
2. ソリューションをビルドする。
3. ビルドに成功すると cygwin\Debug / cygwin\Release ディレクトリに cyglaunch.exe が生成される。

ヘルプファイルのビルド

1. doc\makechm.bat を実行する。

インストーラの作成

AppVeyor を使用する場合

AppVeyor で "NEW BUILD" を実行します。
内部では installer\release.bat が呼ばれています。

installer\release.bat を使用する場合

installer\release.bat を実行して、インストーラー、zipを作成します。
作成されるファイル名は buildtool\svnrev\sourcetree_info.bat の値から生成されます。このファイルは buildtools\svnrev\svnrev.bat が teraterm\common\tt-version.h などをもとに生成します。

• installer\release.bat を実行します。
  インストーラーは installer\release.bat から呼び出される installer\iscc.bat で作成されます。
• インストーラー、ポータブル版の zip ファイル が installer\Output フォルダに出力されます。

Inno Script Studio を使う場合

RC,リリースを作成する場合は、installer\release.batを使用するほうが便利ですが、 インストーラーのデバグなどInno Script Studioを使用すると便利です。
作成されるファイル名は、インストーラは installer\teraterm.iss の定義により、ポータブル版は buildtool\svnrev\sourcetree_info.bat に書き込まれたものから生成されます。

• Inno Script Studio で installer\teraterm.iss を開き、"Project"-"Compile" でインストーラを作成する
• インストーラーとポータブル版が installer\Output フォルダに出力されます。
• 作成されたポータブル版を zip で圧縮する