ebiten/_docs/index.tmpl.html

140 lines
5.0 KiB
HTML
Raw Normal View History

2014-12-27 16:26:33 +01:00
<!DOCTYPE html>
2014-12-27 22:18:23 +01:00
{{comment .License}}
2015-01-10 11:18:43 +01:00
<meta name="description" content="Ebiten - A simple SNES-like 2D game library in Go">
<link rel="shortcut icon" href="./favicon.png" type="image/png">
<link rel="icon" href="./favicon.png" type="image/png">
2014-12-28 09:14:56 +01:00
<title>Ebiten - A simple SNES-like 2D game library in Go</title>
2014-12-28 07:37:51 +01:00
<style>
2014-12-28 08:54:13 +01:00
body {
font-family: sans-serif;
}
2015-01-08 15:45:30 +01:00
img.example {
background-color: #000;
2015-01-05 16:44:39 +01:00
border-color: #999;
border-style: solid;
border-width: 1px;
2016-02-15 17:27:43 +01:00
image-rendering: crisp-edges;
image-rendering: pixelated;
2015-01-05 16:44:39 +01:00
}
2015-01-06 03:34:54 +01:00
pre {
background: #eee;
padding: 1em;
}
2014-12-28 07:37:51 +01:00
</style>
2016-04-21 19:31:26 +02:00
<a href="https://github.com/hajimehoshi/ebiten"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/365986a132ccd6a44c23a9169022c0b5c890c387/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"></a>
2014-12-29 15:16:02 +01:00
<h1>Ebiten (海老天)</h1>
2016-04-21 19:31:26 +02:00
<p>Stable version: v{{.StableVersion}} / Development version: v{{.DevVersion}}</p>
2014-12-27 22:18:23 +01:00
<ul>
2014-12-28 09:09:50 +01:00
<li>A simple SNES-like 2D game library in Go</li>
2014-12-27 22:18:23 +01:00
<li>Works on
<ul>
<li>Web browsers (powered by <a href="http://gopherjs.org/">GopherJS</a>)
<ul>
2016-04-21 16:58:33 +02:00
<li>Supported browsers: Chrome and Firefox on desktops</li>
</ul>
</li>
2016-04-21 18:16:58 +02:00
<li>Windows</li>
2014-12-27 22:18:23 +01:00
<li>Mac OS X</li>
2016-02-23 20:17:57 +01:00
<li>Linux</li>
<li>Android (WIP)</li>
<li>iOS (WIP)</li>
2014-12-27 22:18:23 +01:00
</ul>
</li>
2016-04-21 18:16:58 +02:00
<li><a href="http://godoc.org/github.com/hajimehoshi/ebiten"><img src="https://godoc.org/github.com/hajimehoshi/ebiten?status.svg" alt="GoDoc Reference"></a></li>
2014-12-27 22:18:23 +01:00
</ul>
<h2>Features</h2>
<ul>
<li>2D Graphics</li>
<li>Input (Mouse, Keyboard, Gamepad)</li>
2016-04-21 18:16:58 +02:00
<li>Audio (Ogg/Vorbis, WAV, and PCM)</li>
2014-12-27 22:18:23 +01:00
</ul>
<h2>Example</h2>
2015-01-08 15:45:30 +01:00
<p>
2016-02-28 06:23:46 +01:00
{{range .Examples -}}
2016-02-10 19:07:14 +01:00
<a href="examples/{{.Name}}.html"><img src="images/examples/{{.Name}}.png" width="{{.ThumbWidth}}" height="{{.ThumbHeight}}" alt="Ebiten example: {{.Name}}" class="example"></a>
2016-02-28 06:23:46 +01:00
{{- end}}
2015-01-08 15:45:30 +01:00
</p>
2014-12-27 22:18:23 +01:00
2016-02-28 06:10:41 +01:00
<h2>Install on Mac OS X or Windows</h2>
2016-04-13 17:12:33 +02:00
<p>Compilation requires a C compiler like GCC to compile third party libaries used by Ebiten. You would need <a href="http://www.mingw.org/">MinGW</a> on Windows, and would need Xcode on Mac OS X.</p>
<p>Let's get the Ebiten source code and compile it.</p>
2015-06-20 11:56:37 +02:00
<pre><code>:; go get github.com/hajimehoshi/ebiten</code></pre>
<p>If you want to run your game on a web browser, execute this:</p>
<pre><code>:; go get github.com/gopherjs/gopherjs
:; go get github.com/gopherjs/webgl</code></pre>
2014-12-27 22:18:23 +01:00
2016-02-23 20:17:57 +01:00
<h2>Install on Linux</h2>
2016-02-20 21:06:04 +01:00
<p>Before installing Ebiten, you might need these libraries:</p>
<ul>
<li>libglu1-mesa-dev</li>
<li>libgles2-mesa-dev</li>
<li>libxrandr-dev</li>
<li>libxcursor-dev</li>
<li>libxinerama-dev</li>
<li>libxi-dev</li>
</ul>
2016-02-23 20:17:57 +01:00
<p>Ebiten is tested on Ubuntu Linux x64.</p>
2016-02-20 21:06:04 +01:00
2014-12-27 22:18:23 +01:00
<h2>Execute the example</h2>
2016-02-13 15:02:54 +01:00
<pre><code>:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/examples
2014-12-27 22:18:23 +01:00
:; go run rotate/main.go</code></pre>
2015-01-08 15:45:30 +01:00
<h2>Run your game on a desktop</h2>
<p>Just execute your Go program. That's it!</p>
2015-01-05 17:56:58 +01:00
<h2>Run your game on a web browser</h2>
2015-01-08 15:45:30 +01:00
<p>Compile your game with <a href="http://gopherjs.org/">GopherJS</a>:</p>
<pre><code>:; gopherjs build -o yourgame.js path/to/yourgame</code></pre>
<p>Then, open the below HTML on your HTTP server:</p>
<pre><code>&lt;!DOCTYPE html&gt;
&lt;script src="yourgame.js"&gt;&lt;/script&gt;</code></pre>
2015-01-08 15:45:30 +01:00
<p>NOTE: <code>file://</code> URL may not work with Ebiten. Execute your game on a HTTP server.</p>
2016-06-23 05:15:34 +02:00
<h2>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><code>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!")
}
</code></pre>
<p>Run the <code>go run</code> command to start the
game. There you have it, your first Ebiten game!</p>
<h2>Apps created with Ebiten</h2>
<ul>
<li><a href="https://github.com/peterhellberg/plasma">Plasma</a> by Peter Hellberg</li>
2016-04-13 17:12:33 +02:00
<li><a href="https://github.com/hajimehoshi/go-inovation">go-inovation</a> by Hajime Hoshi</li>
2016-02-14 08:18:04 +01:00
<li><a href="https://github.com/martinkirsche/wired-logic">Wired Logic</a> by Martin Kirsche</li>
2016-04-13 17:12:33 +02:00
<li><a href="https://github.com/DrJosh9000/awakengine">AwakEngine</a> by Josh Deprez</li>
</ul>
2015-01-05 17:56:58 +01:00
<h2>Change Log</h2>
<p>See <a href="https://github.com/hajimehoshi/ebiten/releases">GitHub releases page</a>.</p>
2014-12-27 22:18:23 +01:00
<h2>License</h2>
<h3>Ebiten</h3>
<pre>{{.License}}</pre>
<h3>Go Gopher photograph</h3>
<p><a href="http://blog.golang.org/go-programming-language-turns-two">The original photograph of Go gophers by Chris Nokleberg</a> is licensed under the Creative Commons 3.0 Attributions license.</p>
2015-01-08 15:45:30 +01:00
<footer>{{.Copyright}}</footer>