ebiten/_docs/index.tmpl.html
2015-01-25 02:07:39 +09:00

152 lines
4.5 KiB
HTML

<!DOCTYPE html>
{{comment .License}}
<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">
<title>Ebiten - A simple SNES-like 2D game library in Go</title>
<style>
body {
font-family: sans-serif;
}
img.example {
background-color: #000;
border-color: #999;
border-style: solid;
border-width: 1px;
}
pre {
background: #eee;
padding: 1em;
}
</style>
<h1>Ebiten (海老天)</h1>
<p>v{{.StableVersion}}</p>
<ul>
<li>A simple SNES-like 2D game library in Go</li>
<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>
<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>
<li><a href="http://github.com/hajimehoshi/ebiten">GitHub project page</a> (Development version: v{{.DevVersion}})</li>
</ul>
<h2>Features</h2>
<ul>
<li>2D Graphics</li>
<li>Input (Mouse, Keyboard, Gamepad)</li>
</ul>
<h2>Example</h2>
<p>
{{range .Examples}}
<a href="example/{{.Name}}.html"><img src="images/example/{{.Name}}.png" width="{{.ThumbWidth}}" height="{{.ThumbHeight}}" alt="Ebiten example: {{.Name}}" class="example"></a>
{{end}}
</p>
<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>
<h2>Execute the example</h2>
<pre><code>:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/example
:; go run rotate/main.go</code></pre>
<h2>Run your game on a desktop</h2>
<p>Just execute your Go program. That's it!</p>
<h2>Run your game on a web browser</h2>
<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>
<p>NOTE: <code>file://</code> URL may not work with Ebiten. Execute your game on a HTTP server.</p>
<h2>Change Log</h2>
<h3>2015-??-??</h3>
<ul>
<li>v1.2.0-rc1 released.
<ul>
<li>Support for gamepads</li>
<li>Support for touch events</li>
<li>Added new functions for image rendering:
<ul>
<li>Image.DrawFilledRect</li>
<li>Image.DrawFilledRects</li>
<li>Image.DrawLine</li>
<li>Image.DrawLines</li>
<li>Image.DrawRect</li>
<li>Image.DrawRects</li>
<li>Image.ReplacePixels</li>
</ul>
</li>
<li>Add some experimental packages:
<ul>
<li>exp/audio: Play music and sound</li>
<li>exp/gamepad: Useful functions to configure gamepads</li>
<li>exp/shape: Draw ellipses and arcs</li>
<li>These packages are experimental and we don't guarantee backward compatibility.</li>
</ul>
</li>
<li>Some bug fix</li>
</ul>
</li>
</ul>
<h3>2015-??-??</h3>
<ul>
<li>v1.1.0 released.
<ul>
<li>Some bug fix</li>
</ul>
</li>
</ul>
<h3>2015-01-10</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>
<li>A lot of keyboard keys have been added. KeyMax and MouseButtonMax were removed.</li>
</ul>
</li>
<li>The game is stopped when the window is not active.</li>
</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>
<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>
<footer>{{.Copyright}}</footer>