Mobile

TL;DR

Use ebitenmobile command to create a shared library. The generated library includes a complete and easy-to-use view (or view controller) class.

Creating a shared library with ebitenmobile bind

Installing ebitenmobile

Install ebitenmobile command first.

cd ./path/to/your/game
go install github.com/hajimehoshi/ebiten/cmd/ebitenmobile

# With Ebiten 1.10, Ebitenmobile cannot treat Go modules.
# You need to install Ebiten and Ebitenmobile with GO111MODULE=off.
#
# env GO111MODULE=off go get github.com/hajimehoshi/ebiten
# cd $(go env GOPATH)/go/src/github.com/hajimehoshi/ebiten
# git checkout v1.10.5
# go install ./cmd/ebitenmobile

As ebitenmobile of Ebiten 1.10 cannot treat Go modules, your project also has to be under GOPATH.

Creating a binding

Create a package for mobiles to use github.com/hajimehoshi/ebiten/mobile:

package yourgamemobile

import (
    "github.com/hajimehoshi/ebiten"
    "github.com/hajimehoshi/ebiten/mobile"

    "github.com/yourname/yourgame"
)

func init() {
    // yourgame.Game must implement mobile.Game (= ebiten.Game) interface.
    // For more details, see
    // * https://pkg.go.dev/github.com/hajimehoshi/ebiten?tab=doc#Game
    mobile.SetGame(&yourgame.Game{})
}

// Dummy is a dummy exported function.
//
// gomobile doesn't compile a package that doesn't include any exported function.
// Dummy forces gomobile to compile this package.
func Dummy() {}

The key function is SetGame, and you can ignore the other functions in the mobile package.

Android

Run ebitenmobile bind command for your package:

cd /path/to/yourgame
ebitenmobile bind -target android -javapkg [your.domain] -o [path/to/yourgame.aar] .

# With Ebiten 1.10, you need to disable Go modules.
#
# env GO111MODULE=off ebitenmobile bind -target android -javapkg [your.domain] -o [path/to/yourgame.aar] \
#   [github.com/yourname/yourgame/yourgamemobile]

Then your can get a .aar file. This .aar file defines a view class named EbitenView under the specified Java package (-javapkg option + your package name). You can put it on your screen. That's it!

The view class is defined like this:

package your.domain.yourgamemobile;

import android.view.ViewGroup;

public class EbitenView extends ViewGroup {
    // onErrorOnGameUpdate is called on the main thread when an error happens when updating a game.
    // You can define your own error handler, e.g., using Crashlytics, by overwriting this method.
    protected void onErrorOnGameUpdate(Exception e) {
        // Default error handling implementation.
    }

    // suspendGame suspends the game.
    // It is recommended to call this when the application is being suspended e.g.,
    // Activity's onPause is called.
    public void suspendGame() {
        // ...
    }

    // resumeGame resumes the game.
    // It is recommended to call this when the application is being resumed e.g.,
    // Activity's onResume is called.
    public void resumeGame() {
        // ...
    }
}

iOS

Run ebitenmobile bind command for your package:

cd /path/to/yourgame
ebitenmobile bind -target ios -o [path/to/yourgame.framework] .

# With Ebiten 1.10, you need to disable Go modules.
#
# env GO111MODULE=off ebitenmobile bind -target ios -o [path/to/yourgame.framework] \
#   [github.com/yourname/yourgame/yourgamemobile]

Then your can get a .framework file. This .framework defines a view controller class named (Package Name)EbitenViewController. You can put it on your screen by connecting with any UIView. That's it!

The view controller class is defined like this:

#import <UIKit/UIKit.h>

@interface YourgamemobileEbitenViewController : UIViewController

// onErrorOnGameUpdate is called on the main thread when an error happens when updating a game.
// You can define your own error handler, e.g., using Crashlytics, by overwriting this method.
- (void)onErrorOnGameUpdate:(NSError*)err;

// suspendGame suspends the game.
// It is recommended to call this when the application is being suspended e.g.,
// UIApplicationDelegate's applicationWillResignActive is called.
- (void)suspendGame;

// resumeGame resumes the game.
// It is recommended to call this when the application is being resumed e.g.,
// UIApplicationDelegate's applicationDidBecomeActive is called.
- (void)resumeGame;

@end

Example

go-inovation is a complete example to use ebitenmobile bind.

Why ebitenmobile bind?

Why not a complete application instead of a shared library?

It is because it is not feasible to write a mobile application only in Go yet.

Creating an application with gomobile build (For testing only)

NOTICE: Now gomobile build does not work for iOS. See the Go issue.

Ebiten application also works with gomobile build. This is useful for testing, but not suitable for actual applications in the stores.

Install gomobile command first.

go install golang.org/x/mobile/cmd/...

Then, run gomobile build

gomobile build [github.com/yourname/yourpackage]

That's it!

You can install an Ebiten's example directly with gomobile install on your Android device:

gomobile install -tags=example github.com/hajimehoshi/ebiten/examples/paint

For more details, see the official Wiki page about gomobile.