ebiten/_docs/index.tmpl.html

219 lines
6.6 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>
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>
2016-02-23 20:17:57 +01:00
<li>Linux</li>
2016-02-25 19:57:36 +01:00
<li>Windows</li>
2014-12-27 22:18:23 +01:00
</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>
2014-12-27 22:18:23 +01:00
</ul>
<h2>Features</h2>
<ul>
<li>2D Graphics</li>
<li>Input (Mouse, Keyboard, Gamepad)</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>
<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>
2016-04-13 17:12:33 +02:00
<h3>2016-04-14</h3>
<ul>
<li>v1.3.0-rc1 released.
<ul>
<li>Added new platforms
<ul>
<li>Windows</li>
<li>Linux</li>
</ul>
</li>
<li>Drawing
<ul>
<li>Added CompositeMode to change composite mode (e.g. masking or additive drawing)</li>
</ul>
</li>
<li>Audio
<ul>
<li>Changed APIs (almost fixed)</li>
<li>Added exp/audio/vorbis to decode Ogg/Vorbis stream</li>
<li>Added exp/audio/wav to decode Wav stream</li>
</ul>
</li>
<li>Others
<ul>
<li>Made most of functions concurrent-safe</li>
<li>Bug fix</li>
</ul>
</li>
</ul>
</li>
</ul>
2016-02-28 05:58:41 +01:00
<h3>2016-02-28</h3>
<ul>
<li>v1.2.0 released.
<ul>
<li>Fixed some bugs.</li>
</ul>
</li>
</ul>
2016-02-16 17:34:30 +01:00
<h3>2016-02-17</h3>
<ul>
<li>v1.2.0-rc1 released.
<ul>
2016-02-15 19:04:44 +01:00
<li>Added support for gamepads on desktops and browsers</li>
<li>Added support for touch events on browsers</li>
<li>Added new functions for image rendering:
2015-01-20 16:51:55 +01:00
<ul>
<li>Image.ReplacePixels</li>
2016-02-15 19:04:44 +01:00
<li>GeoM.Rotate</li>
<li>ColorM.RotateHue</li>
2015-01-20 16:51:55 +01:00
</ul>
</li>
2016-02-15 19:04:44 +01:00
<li>Added some experimental packages:
2015-01-24 18:07:39 +01:00
<ul>
<li>exp/audio: Play music and sound</li>
<li>exp/gamepad: Useful functions to configure gamepads</li>
<li>These packages are experimental and we don't guarantee backward compatibility.</li>
</ul>
</li>
2016-02-15 19:04:44 +01:00
<li>Deprecated some APIs:
2016-02-07 09:48:52 +01:00
<ul>
<li>TranslateGeo (Use GeoM's Translate instead)</li>
<li>ScaleGeo (Use GoeM's Scale instead)</li>
<li>RotateGeo (Use GoeM's Rotate instead)</li>
<li>TranslateColor (Use ColorM's Translate instead)</li>
<li>ScaleColor (Use ColorM's Scale instead)</li>
<li>RotateHue (Use ColorM's RotateHue instead)</li>
</ul>
</li>
2016-02-15 19:04:44 +01:00
<li>Fixed some bugs</li>
<li>Performance optimization</li>
2015-01-20 16:51:55 +01:00
</ul>
</li>
</ul>
2015-01-25 12:16:53 +01:00
<h3>2015-01-25</h3>
2015-01-20 16:51:55 +01:00
<ul>
<li>v1.1.0 released.
<ul>
2015-01-25 12:16:53 +01:00
<li>Fixed some bugs.</li>
</ul>
</li>
</ul>
2015-01-09 17:04:08 +01:00
<h3>2015-01-10</h3>
2015-01-05 17:56:58 +01:00
<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>
2015-01-08 15:45:30 +01:00
<footer>{{.Copyright}}</footer>