Getting Started

⚠️ This is the documentation for older version. Please see the new documentation Getting Started instead.

Clone the repo with Git

git clone https://github.com/mogemimi/pomdog.git

Create a new project

python pomdog/tools/quickstart.py

e.g.

$ git clone https://github.com/mogemimi/pomdog.git
$ python pomdog/tools/quickstart.py
Configure your new project

> Where do you want to create your new gamedev project? [.] .
> What is your project name? (e.g. MyGame) HelloWorld
> What is your project URL? [com.example.HelloWorld]
HelloWorld: Create a new directory.
Create a new project at 'HelloWorld'.
Done.

$ cd HelloWorld

Build using Makefiles on Linux

• Setting Up Development Environment on Ubuntu

1. Generate Makefiles

python Tools/gyp/gyp_main.py examples/QuickStart/QuickStart.gyp --depth=. \
  -f make --generator-output=build.makefiles -Dcomponent=static_library

2. Build

export CC=clang
export CXX=clang++
export LINK=clang++
export CXXFLAGS="-std=c++14 -stdlib=libc++"
export LDFLAGS="-stdlib=libc++"
make -C build.makefiles

To choose build mode, use the BUILDTYPE="Debug" or BUILDTYPE="Release" option:

make -C build.makefiles BUILDTYPE="Debug"
make -C build.makefiles BUILDTYPE="Release"

3. Run

# Copy asset files to output directory
cp -R examples/QuickStart/Content/ build.makefiles/out/Release/Content

# Run
build.makefiles/out/Release/QuickStart

Build with Xcode on Mac OS X

1. Generate the Xcode project file

python Tools/gyp/gyp_main.py QuickStart.gyp --depth=. -f xcode --generator-output=Build.xcodefiles

2. Build with Xcode

xcodebuild -project Build.xcodefiles/QuickStart.xcodeproj

To build in release mode, use -configuration option:

xcodebuild -project Build.xcodefiles/QuickStart.xcodeproj -configuration Release

3. Run

open build/Release/QuickStart.app

Build with Visual Studio 2017 on Windows

1. Generate Visual Studio project files

PowerShell:

python Tools/gyp/gyp_main.py QuickStart.gyp --depth=. -f msvs `
    -G msvs_version=2017 --generator-output=Build.msvs

Git Bash (MinGW):

python Tools/gyp/gyp_main.py QuickStart.gyp --depth=. -f msvs \
    -G msvs_version=2017 --generator-output=Build.msvs

2. Setup Working Directory in Visual Studio

Open Build.msvs/QuickStart.sln in Visual Studio and build your app. To run your app, change QuickStart project property to the following at Configuration Properties > Debugging > Working Directory in Visual Studio:

Working Directory	$(ProjectDir)..

3. Build and Run

Press the F5 key to build and run the project.

If you intend to use MSBuild to build your game, run the following commands.

PowerShell:

$env:Path += ";C:\Program Files (x86)\MSBuild\14.0\Bin"
MSBuild build.msvs\test\TestApp\TestApp.sln /t:Build /p:Configuration=Release

Git Bash (MinGW):

export PATH="$PATH:/c/Program Files (x86)/MSBuild/14.0/Bin"
MSBuild.exe build.msvs/test/TestApp/TestApp.sln -t:Build -p:Configuration=Release