simutrans

Simutrans 開発環境セットアップガイド

概要

このガイドでは、Simutrans の開発環境をセットアップする手順を説明します。

目的

このドキュメントは以下の目的で作成されています：

• プラットフォーム別ガイド: Windows、Linux、macOS での環境構築手順
• ビルドシステム選択: Make、CMake、Visual Studio の使い分け
• IDE 設定: VS Code、Visual Studio、CLion の設定方法
• トラブルシューティング: よくある問題と解決方法

対象読者:

• 開発環境を構築したい開発者
• 初めて Simutrans のビルドに挑戦する方
• ビルドエラーを解決したい方

前提条件

共通要件

• Git または SVN クライアント
• 5GB 以上のディスク空き容量
• インターネット接続（依存ライブラリのダウンロード用）

プラットフォーム別セットアップ

Windows

オプション 1: Visual Studio（推奨：デバッグ向け）

1. Visual Studio のインストール

• Visual Studio 2019 以降をインストール
• 必要なワークロード：
  • C++によるデスクトップ開発
  • CMake ツール（オプション）

2. vcpkg のインストール

# vcpkgをクローン
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg

# vcpkgをビルド
.\bootstrap-vcpkg.bat

# 環境変数を設定（オプション）
setx VCPKG_ROOT "%CD%"

3. 依存ライブラリのインストール

オプション A: vcpkg.json を使用（推奨）

Simutrans のプロジェクトルートには vcpkg.json が含まれており、Visual Studio が自動的に依存関係をインストールします。

オプション B: 手動でインストール

# vcpkgディレクトリに移動
cd [vcpkg-root]

# 必要なライブラリをインストール（vcpkg.jsonと同じ内容）
.\vcpkg install freetype:x64-windows-static
.\vcpkg install miniupnpc:x64-windows-static
.\vcpkg install pthread:x64-windows-static
.\vcpkg install zstd:x64-windows-static
.\vcpkg install sdl2:x64-windows-static
.\vcpkg install zlib:x64-windows-static

注意: tools/install-building-libs-x64.bat スクリプトは古くなっている可能性があります。上記の手動インストールコマンドまたは vcpkg.json の使用を推奨します。

4. プロジェクトを開く

1. Simutrans.slnを Visual Studio で開く
2. スタートアッププロジェクトを選択：
   • Simutrans SDL2: 推奨
   • Simutrans GDI: Windows 専用
   • Simutrans Server: GUI 無し
3. ビルド構成を選択（Debug/Release）
4. F5 キーでビルド＆実行

オプション 2: MSYS2（推奨：ビルドの簡易性）

1. MSYS2 のインストール

1. MSYS2をダウンロードしてインストール
2. MSYS2 MinGW 64-bit ターミナルを起動

2. セットアップスクリプトの実行

cd /c/dev/simutrans
./tools/setup-mingw.sh

このスクリプトは自動的に：

• 必要なパッケージをインストール
• ビルド環境を設定

3. ビルド

# configure（初回のみ）
./configure

# ビルド
make -j$(nproc)

Linux

Ubuntu/Debian 系

1. セットアップスクリプトの実行

cd ~/dev/simutrans
sudo ./tools/setup-debian.sh

このスクリプトは以下をインストール：

• ビルドツール（gcc, g++, make, autoconf）
• 必須ライブラリ（zlib, libpng, freetype, SDL2）
• オプションライブラリ（zstd, miniupnpc, fluidsynth）

2. 手動インストール（代替）

# ビルドツール
sudo apt-get install build-essential autoconf pkg-config

# 必須ライブラリ
sudo apt-get install zlib1g-dev
sudo apt-get install libpng-dev
sudo apt-get install libfreetype6-dev
sudo apt-get install libbz2-dev
sudo apt-get install libsdl2-dev

# オプションライブラリ
sudo apt-get install libzstd-dev
sudo apt-get install libminiupnpc-dev
sudo apt-get install libfluidsynth-dev
sudo apt-get install libfontconfig1-dev

3. ビルド

# configure
autoconf
./configure

# ビルド（コア数に応じて-jを調整）
make -j$(nproc)

# 実行ファイルは build/default/sim に生成される

Arch Linux

# ビルドツール
sudo pacman -S base-devel autoconf pkg-config

# 必須ライブラリ
sudo pacman -S zlib libpng freetype2 bzip2 sdl2

# オプションライブラリ
sudo pacman -S zstd miniupnpc fluidsynth fontconfig

Fedora/RHEL

# ビルドツール
sudo dnf install gcc gcc-c++ make autoconf pkgconfig

# 必須ライブラリ
sudo dnf install zlib-devel libpng-devel freetype-devel bzip2-devel SDL2-devel

# オプションライブラリ
sudo dnf install libzstd-devel miniupnpc-devel fluidsynth-devel fontconfig-devel

macOS

1. Homebrew のインストール

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. 依存ライブラリのインストール

# ビルドツール
xcode-select --install

# 依存ライブラリ
brew install autoconf automake
brew install sdl2
brew install freetype
brew install libpng
brew install zstd
brew install miniupnpc
brew install pkg-config

3. ビルド

cd ~/dev/simutrans

# configure
autoreconf -ivf
./configure

# ビルド
make -j$(sysctl -n hw.ncpu)

# バージョン情報生成
make OSX/getversion

CMake を使用したビルド

Linux/macOS/MinGW

# ビルドディレクトリを作成
mkdir build
cd build

# 設定（ジェネレーターを指定）
cmake -G "Unix Makefiles" ..

# または Ninjaを使用（高速）
# cmake -G "Ninja" ..

# ビルド
cmake --build . -j$(nproc)  # Linux
cmake --build . -j$(sysctl -n hw.ncpu)  # macOS

# 実行ファイルは build/simutrans/ に生成される

Windows (Visual Studio)

# ビルドディレクトリを作成
mkdir build
cd build

# 設定
cmake.exe .. -G "Visual Studio 16 2019" -A x64 `
  -DCMAKE_TOOLCHAIN_FILE=[vcpkg-root]/scripts/buildsystems/vcpkg.cmake

# ビルド
cmake --build . --config Release

# または Visual Studioで開く
# simutrans.slnが生成される

CMake オプション

# バックエンドの選択
cmake .. -DSIMUTRANS_BACKEND=sdl2    # SDL2（デフォルト）
cmake .. -DSIMUTRANS_BACKEND=gdi     # GDI（Windows）
cmake .. -DSIMUTRANS_BACKEND=none    # サーバー

# ビルドタイプ
cmake .. -DCMAKE_BUILD_TYPE=Debug
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo

# リビジョン番号を手動設定
cmake .. -DSIMUTRANS_USE_REVISION=12345

ソースコードの取得

SVN（推奨：公式リポジトリ）

svn checkout svn://servers.simutrans.org/simutrans/trunk simutrans

Git（ミラー）

git clone https://github.com/simutrans/simutrans.git

注意: Git ミラーを使用する場合、ネットワークゲーム参加時は手動でバージョンを設定する必要があります。

ゲームデータの取得

ビルドしても実行ファイルのみが生成されます。ゲームを実行するには、Pakset が必要です。

方法 1: スクリプトを使用（推奨）

Windows (PowerShell)

cd simutrans
.\tools\get_pak.ps1

Linux/macOS

cd simutrans
./tools/get_pak.sh

方法 2: 手動ダウンロード

1. Paksetsから好みの Pakset をダウンロード
2. simutrans/ディレクトリに展開

推奨 Pakset：

• pak64: 標準、軽量
• pak128: 高解像度、詳細
• pak128.britain: イギリステーマ

実行

既存の Simutrans インストールを使用

# -use_workdirで既存のインストールを指定
./build/default/sim -use_workdir /path/to/simutrans

スタンドアロン実行

Pakset をダウンロード後：

cd simutrans
../build/default/sim

IDE の設定

Visual Studio Code

推奨拡張機能

• C/C++ (Microsoft)
• CMake Tools
• clangd (オプション、より良いインテリセンス)

settings.json

{
	"C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools",
	"cmake.buildDirectory": "${workspaceFolder}/build",
	"cmake.configureSettings": {
		"CMAKE_BUILD_TYPE": "Debug",
		"SIMUTRANS_BACKEND": "sdl2"
	}
}

tasks.json (Make 用)

{
	"version": "2.0.0",
	"tasks": [
		{
			"label": "Build Simutrans",
			"type": "shell",
			"command": "make",
			"args": ["-j8"],
			"group": {
				"kind": "build",
				"isDefault": true
			},
			"problemMatcher": ["$gcc"]
		}
	]
}

Visual Studio

• Simutrans.slnを開く
• プロジェクトプロパティは自動設定済み
• vcpkg が正しく設定されていることを確認

CLion

1. プロジェクトを開く（CMakeLists.txt を選択）
2. CMake 設定を調整：
   • Settings > Build, Execution, Deployment > CMake
   • CMake options に追加：

     -DCMAKE_TOOLCHAIN_FILE=[vcpkg-root]/scripts/buildsystems/vcpkg.cmake
     

トラブルシューティング

依存ライブラリが見つからない

Linux/macOS:

# pkg-configのパスを確認
pkg-config --list-all | grep -i sdl2

# パスを追加（必要に応じて）
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:$PKG_CONFIG_PATH

Windows (MSVC):

• vcpkg が正しくインストールされているか確認
• CMAKE_TOOLCHAIN_FILE が正しく設定されているか確認

ビルドエラー: 'SDL.h' file not found

解決方法:

# SDL2が正しくインストールされているか確認
# Linux/macOS
pkg-config --cflags sdl2

# ない場合は再インストール
sudo apt-get install --reinstall libsdl2-dev  # Ubuntu/Debian
brew reinstall sdl2  # macOS

リンクエラー

Linux:

# 不足しているライブラリを確認
ldd build/default/sim

# 必要に応じてライブラリを追加
sudo ldconfig

macOS での権限エラー

# Homebrewのパーミッション修正
sudo chown -R $(whoami) /usr/local/lib /usr/local/include

Windows: 'configure'が見つからない

• MSYS ターミナルを使用していることを確認
• パス区切りは/を使用（\ではなく）

高度な設定

クロスコンパイル（Linux → Windows）

# MinGWツールチェーンをインストール
sudo apt-get install mingw-w64

# configure時にホストを指定
./configure --host=x86_64-w64-mingw32

# ビルド
make -j$(nproc)

詳細: Cross-Compiling Simutrans

マルチスレッドビルド

ビルド時間を短縮：

# CPU コア数を確認
# Linux:
nproc
# macOS:
sysctl -n hw.ncpu

# その数でビルド
make -j8  # 8コアの場合

デバッグビルド

# Makeの場合
make FLAGS="-g -O0"

# CMakeの場合
cmake -DCMAKE_BUILD_TYPE=Debug ..
cmake --build .

リリースビルドの最適化

# Makeの場合
make FLAGS="-O3 -march=native"

# CMakeの場合
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .

---

関連ファイル

ビルド設定

• CMake: CMakeLists.txt, cmake/SimutransCompileOptions.cmake
• Make: Makefile, common.mk
• Visual Studio: Simutrans.sln, *.vcxproj

依存関係

• vcpkg: vcpkg.json
• 設定ファイル: config.default, config.template

セットアップスクリプト

• Debian/Ubuntu: tools/setup-debian.sh
• macOS: setup-development.sh
• Windows: tools/install-building-libs-*.bat

---

まとめ

Simutrans の開発環境セットアップは、プラットフォームごとに最適化されています：

主な特徴:

• 柔軟なビルドシステム: Make、CMake、Visual Studio から選択
• IDE 統合: VS Code、Visual Studio、CLion での開発をサポート
• vcpkg 統合: Windows での依存関係管理が簡単
• クロスプラットフォーム: 一つのコードベースで全プラットフォームに対応
• デバッグサポート: 各 IDE で充実したデバッグ機能

環境を構築したら、次は TECHNICAL_ARCHITECTURE.md でコードベースを理解しましょう。

---

次のステップ

1. PROJECT_OVERVIEW.mdでプロジェクト構造を理解
2. TECHNICAL_ARCHITECTURE.mdでアーキテクチャを学習
3. documentation/coding_styles.txtでコーディング規約を確認
4. Forumでコミュニティに参加

参考リンク

• Compiling Simutrans Wiki
• Development Index
• Technical Documentation Forum

This site is open source. Improve this page.