ebiten/_docs/index.tmpl.html

140 lines
4.4 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}}
2014-12-28 08:59:04 +01:00
<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-06 03:34:54 +01:00
table.examples {
border-collapse: separate;
border-spacing: 0 1em;
}
2014-12-28 07:37:51 +01:00
table.examples td {
2015-01-06 03:34:54 +01:00
padding: 0;
2014-12-28 07:37:51 +01:00
vertical-align: top;
}
table.examples td.code pre {
height: 240px;
2015-01-06 03:34:54 +01:00
margin: 0;
2014-12-28 07:37:51 +01:00
overflow: auto;
}
2015-01-06 03:34:54 +01:00
table.examples td.screen {
padding-left: 1em;
}
table.examples iframe, table.examples img {
2015-01-05 16:44:39 +01:00
border-color: #999;
border-style: solid;
border-width: 1px;
overflow: hidden;
}
2015-01-06 03:34:54 +01:00
pre {
background: #eee;
padding: 1em;
}
2014-12-28 07:37:51 +01:00
</style>
2014-12-29 15:16:02 +01:00
<h1>Ebiten (海老天)</h1>
2014-12-29 15:52:37 +01:00
<p>v{{.StableVersion}}</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>
<li>Supported browsers: Chrome, Firefox, Safari on desktops</li>
</ul>
</li>
2014-12-27 22:18:23 +01:00
<li>Mac OS X</li>
<li>Linux (maybe)</li>
<li>Windows (possibly)</li>
</ul>
</li>
<li><a href="http://godoc.org/github.com/hajimehoshi/ebiten">API Docs</a></li>
2014-12-29 15:52:37 +01:00
<li><a href="http://github.com/hajimehoshi/ebiten">Source Code</a> (Development version: v{{.DevVersion}})</li>
2014-12-27 22:18:23 +01:00
</ul>
<h2>Features</h2>
<ul>
<li>2D Graphics</li>
<li>Input (Mouse, Keyboard)</li>
</ul>
<h2>Example</h2>
2014-12-28 07:37:51 +01:00
<table class="examples">
2014-12-27 22:18:23 +01:00
{{range .Examples}}
<tr>
2014-12-28 07:37:51 +01:00
<td class="code"><pre><code>// <b>{{.Name}}</b>
{{.Source}}</code></pre></td>
2015-01-05 16:57:58 +01:00
{{if eq .Name "blocks"}}
2015-01-06 03:34:54 +01:00
<td class="screen">Click to play!<br><a href="example/blocks.html"><img src="blocks.png" width="{{.Width}}" height="{{.Height}}"></a></td>
2015-01-05 16:44:39 +01:00
{{else}}
2015-01-06 03:34:54 +01:00
<td class="screen"><iframe src="example/{{.Name}}.html" width="{{.Width}}" height="{{.Height}}"></iframe></td>
2015-01-05 16:44:39 +01:00
{{end}}
2014-12-27 22:18:23 +01:00
</tr>
{{end}}
</table>
<h2>Install on Mac OS X</h2>
<pre><code>:; brew install glew
:; brew install glfw3 # or homebrew/versions/glfw3
:; 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
<h2>Execute the example</h2>
<pre><code>:; cd $GOHOME/src/github.com/hajimehoshi/ebiten/example
:; go run rotate/main.go</code></pre>
<h2>Execute the example on a web browser</h2>
2015-01-05 17:56:58 +01:00
<p>If you can the example screens above, Ebiten is working on your browser! Each example above works as an independent html in an iframe. If you want to execute the examples apart from this site, execute this:</p>
<pre><code>:; go run $GOPATH/src/github.com/hajimehoshi/ebiten/example/server/main.go</code></pre>
<p>Then, open <code>localhost:8000</code> on your browser.</p>
<p><code>localhost:8000/?EXAMPLE_NAME</code> shows other examples (e.g. <code>localhost:8000/?rotate</code>).</p>
2015-01-05 17:56:58 +01:00
<p>Of cource, you can execute gopherjs yourself. Please see <a href="http://gopherjs.org/">GopherJS site</a> for more detail.</p>
<h2>Run your game on a web browser</h2>
<p>Compile your game with GopherJS:</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-05 17:56:58 +01:00
<h2>Change Log</h2>
<h3>2015-??-??</h3>
<ul>
<li>v1.1.0-rc1 released.
<ul>
<li>Support for web browsers: Ebiten now includes support for web browsers with GopherJS.</li>
<li>Some API has changed:
<ul>
<li>ImagePart is deprecated. Use ImageParts interface instead.</li>
<li>ColorM.Element and GeoM.Element's recievers changed from structs to pointers.</li>
2015-01-07 16:04:26 +01:00
<li>A lot of keyboard keys have been added. KeyMax and MouseButtonMax were removed.</li>
2015-01-05 17:56:58 +01:00
</ul>
</li>
<li>The game is stopped when the window is not active.</li>
2015-01-05 17:56:58 +01:00
</ul>
</li>
</ul>
<h3>2015-01-04</h3>
<ul>
<li>v1.0.0 released.
<ul>
<li>Nothing has changed from v1.0.0-rc1.</li>
</ul>
</li>
</ul>
<h3>2014-12-29</h3>
<ul>
<li>v1.0.0-rc1 released.</li>
</ul>
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>