mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-09-20 13:22:19 +02:00
Code Issues Packages Projects Releases Wiki Activity
ab269c621b
ebiten/docs/index.html
Hajime Hoshi ab269c621b doc: Update bootstrap version to 4
2017-08-18 01:22:19 +09:00

144 lines
8.9 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<script src="./scripts/force-https.js"></script>
<meta name="description" content="Ebiten - A simple 2D game library in Go">
<link rel="shortcut icon" href="./favicon.png" type="image/png">
<link rel="icon" href="./favicon.png" type="image/png">
<title>Ebiten - A simple 2D game library in Go</title>
<link rel="stylesheet" href="./stylesheets/bootstrap.min.css">
<link rel="stylesheet" href="./stylesheets/highlight-github.css">
<link rel="stylesheet" href="./stylesheets/ebiten.css">
<script src="./scripts/googleanalytics.js"></script>
<header class="navbar"><div class="container">
<nav class="d-flex flex-row" style="width: 100%;">
<div>
<a class="navbar-brand" href="./">Ebiten</a>
</div>
<ul class="nav mr-auto">
<li class="nav-item"><a class="nav-link" href="#platforms">Platforms</a></li>
<li class="nav-item"><a class="nav-link" href="#features">Features</a></li>
<li class="nav-item"><a class="nav-link" href="#examples">Examples</a></li>
<li class="nav-item"><a class="nav-link" href="#getting-started">Getting Started</a></li>
</ul>
<ul class="nav">
<li class="nav-item"><a class="nav-link" href="https://github.com/hajimehoshi/ebiten">GitHub</a></li>
<li class="nav-item"><a class="nav-link" href="https://godoc.org/github.com/hajimehoshi/ebiten">GoDoc</a></li>
<li class="nav-item"><a class="nav-link" href="https://github.com/hajimehoshi/ebiten/wiki">Wiki</a>
</ul>
</nav>
</div></header>
<main><div class="container">
<h1>Ebiten</h1>
<p class="lead">A simple 2D game library in Go</p>
<p>Stable version: v1.5.1 / Development version: v1.6.0-alpha</p>
<h2 id="platforms">Platforms</h2>
<dl class="row">
<dt class="col-2 text-right">Desktops</dt>
<dd class="col-10"><a href="https://github.com/hajimehoshi/ebiten/wiki/Windows">Windows</a>, <a href="https://github.com/hajimehoshi/ebiten/wiki/macOS">macOS</a>, <a href="https://github.com/hajimehoshi/ebiten/wiki/Linux">Linux</a>, <a href="https://github.com/hajimehoshi/ebiten/wiki/FreeBSD">FreeBSD</a></dd>
<dt class="col-2 text-right">Mobiles</dt>
<dd class="col-10"><a href="https://github.com/hajimehoshi/ebiten/wiki/Android">Android</a>, <a href="https://github.com/hajimehoshi/ebiten/wiki/iOS">iOS</a></dd>
<dt class="col-2 text-right">Web browsers</dt>
<dd class="col-10"><a href="https://github.com/hajimehoshi/ebiten/wiki/Web-Browsers">Chrome, Firefox and Safari on desktops</a> (powered by <a href="http://gopherjs.org/">GopherJS</a>)</dd>
</dl>
<p><small>Note: Gamepads is not available on Safari/Android/iOS. Keyboard is not available on Android/iOS.</small></p>
<h2 id="features">Features</h2>
<dl class="row">
<dt class="col-2 text-right">2D Graphics</dt>
<dd class="col-10">Geometry/Color matrix transformation, Various composition modes, Offscreen rendering, Fullscreen, Text rendering</dd>
<dt class="col-2 text-right">Input</dt>
<dd class="col-10">Mouse, Keyboard, Gamepads, Touches</dd>
<dt class="col-2 text-right">Audio</dt>
<dd class="col-10">MP3, Ogg/Vorbis, WAV, PCM, Syncing with game progress</dd>
</dl>
<h2 id="examples">Examples</h2>
<div class="row">
<div class="col-3">
<a scrolling="no" href="examples/alphablending.html"><img src="images/examples/alphablending.png" width="320" height="240" alt="Ebiten example: alphablending" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/audio.html"><img src="images/examples/audio.png" width="320" height="240" alt="Ebiten example: audio" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/font.html"><img src="images/examples/font.png" width="320" height="240" alt="Ebiten example: font" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/hsv.html"><img src="images/examples/hsv.png" width="320" height="240" alt="Ebiten example: hsv" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/hue.html"><img src="images/examples/hue.png" width="320" height="240" alt="Ebiten example: hue" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/gamepad.html"><img src="images/examples/gamepad.png" width="320" height="240" alt="Ebiten example: gamepad" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/infinitescroll.html"><img src="images/examples/infinitescroll.png" width="320" height="240" alt="Ebiten example: infinitescroll" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/keyboard.html"><img src="images/examples/keyboard.png" width="320" height="240" alt="Ebiten example: keyboard" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/life.html"><img src="images/examples/life.png" width="320" height="240" alt="Ebiten example: life" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/masking.html"><img src="images/examples/masking.png" width="320" height="240" alt="Ebiten example: masking" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/mosaic.html"><img src="images/examples/mosaic.png" width="320" height="240" alt="Ebiten example: mosaic" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/noise.html"><img src="images/examples/noise.png" width="320" height="240" alt="Ebiten example: noise" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/paint.html"><img src="images/examples/paint.png" width="320" height="240" alt="Ebiten example: paint" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/perspective.html"><img src="images/examples/perspective.png" width="320" height="240" alt="Ebiten example: perspective" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/piano.html"><img src="images/examples/piano.png" width="320" height="240" alt="Ebiten example: piano" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/rotate.html"><img src="images/examples/rotate.png" width="320" height="240" alt="Ebiten example: rotate" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/sprites.html"><img src="images/examples/sprites.png" width="320" height="240" alt="Ebiten example: sprites" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/2048.html"><img src="images/examples/2048.png" width="210" height="300" alt="Ebiten example: 2048" class="img-thumbnail example"></a>
</div><div class="col-3">
<a scrolling="no" href="examples/blocks.html"><img src="images/examples/blocks.png" width="256" height="240" alt="Ebiten example: blocks" class="img-thumbnail example"></a>
</div>
</div>
<p><a href="https://blog.golang.org/go-programming-language-turns-two">The Gopher photographs by Chris Nokleberg</a> are licensed under <a href="https://creativecommons.org/licenses/by/3.0/">the Creative Commons 3.0 Attributions License</a>.</p>
<h3>Execute the examples</h2>
<pre class="card"><div class="card-body"><code class="language-bash">go get github.com/hajimehoshi/ebiten/...
cd $GOPATH/src/github.com/hajimehoshi/ebiten/examples
go run -tags=example rotate/main.go</div></code></pre>
<p>Note that you need to add <code>-tags=example</code> to run examples.</p>
<h2 id="getting-started">Getting Started</h2>
<p>Let's build a simple "Hello world!" game to get started with Ebiten.
First create a new directory (<code>mkdir hello_world</code>), and change
into it (<code>cd hello_world</code>). Type the following code into
the <code>main.go</code> file:</p>
<pre class="card"><div class="card-body"><code class="language-go">package main
import (
"github.com/hajimehoshi/ebiten"
"github.com/hajimehoshi/ebiten/ebitenutil"
)
func update(screen *ebiten.Image) error {
ebitenutil.DebugPrint(screen, "Hello world!")
return nil
}
func main() {
ebiten.Run(update, 320, 240, 2, "Hello world!")
}
</div></code></pre>
<p>Run the <code>go run</code> command to start the
game. There you have it, your first Ebiten game!</p>
</div></main>
<footer><div class="container">
<p>© 2013 Hajime Hoshi</p>
<p>Code is licensed under <a href="https://github.com/hajimehoshi/ebiten/blob/master/LICENSE">the Apache License 2.0</a>.</p>
<p>The content of this page is licensed under <a href="https://creativecommons.org/licenses/by/4.0/">the Creative Commons Attribution 4.0 License</a>.</p>
</div></footer>
<script src="./scripts/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
Reference in New Issue View Git Blame Copy Permalink