mirror of
https://github.com/hajimehoshi/ebiten.git
synced 2024-12-24 10:48:53 +01:00
doc: Move documents to Wiki
This commit is contained in:
Hajime Hoshi
parent
c1c8ba4d7e
commit
4c611ed4d0
@ -7,11 +7,11 @@
|
||||
|
||||
* A simple SNES-like 2D game library in Go
|
||||
* Works on
|
||||
* Web browsers (powered by [GopherJS](http://gopherjs.org/))
|
||||
* [Web browsers](https://github.com/hajimehoshi/ebiten/wiki/Web-Browsers) (powered by [GopherJS](http://gopherjs.org/))
|
||||
* Supported browsers: Chrome and Firefox on desktops
|
||||
* Windows
|
||||
* Mac OS X
|
||||
* Linux
|
||||
* [Windows](https://github.com/hajimehoshi/ebiten/wiki/Windows)
|
||||
* [Mac OS X](https://github.com/hajimehoshi/ebiten/wiki/Mac-OS-X)
|
||||
* [Linux](https://github.com/hajimehoshi/ebiten/wiki/Linux)
|
||||
* [Android](https://github.com/hajimehoshi/ebiten/wiki/Android)
|
||||
* [iOS](https://github.com/hajimehoshi/ebiten/wiki/iOS)
|
||||
|
||||
|
||||
@ -28,16 +28,16 @@ pre {
|
||||
<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>)
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Web-Browsers">Web browsers</a> (powered by <a href="http://gopherjs.org/">GopherJS</a>)
|
||||
<ul>
|
||||
<li>Supported browsers: Chrome and Firefox on desktops</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Windows</li>
|
||||
<li>Mac OS X</li>
|
||||
<li>Linux</li>
|
||||
<li>Android (WIP)</li>
|
||||
<li>iOS (WIP)</li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Windows">Windows</a></li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Mac-OS-X">Mac OS X</a></li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Linux">Linux</a></li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Android">Android</a></li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/iOS">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
@ -58,41 +58,11 @@ pre {
|
||||
{{- end}}
|
||||
</p>
|
||||
|
||||
<h2>Install on Mac OS X or Windows</h2>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
<h2>Install on Linux</h2>
|
||||
<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>
|
||||
<p>Ebiten is tested on Ubuntu Linux x64.</p>
|
||||
|
||||
<h2>Execute the example</h2>
|
||||
<pre><code>:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/examples
|
||||
<pre><code>:; go get github.com/hajimehoshi/ebiten
|
||||
:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/examples
|
||||
:; 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><!DOCTYPE html>
|
||||
<script src="yourgame.js"></script></code></pre>
|
||||
<p>NOTE: <code>file://</code> URL may not work with Ebiten. Execute your game on a HTTP server.</p>
|
||||
|
||||
<h2>Getting Started</h2>
|
||||
|
||||
<p>Let's build a simple "Hello world!" game to get started with Ebiten.
|
||||
|
||||
@ -42,16 +42,16 @@ pre {
|
||||
<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>)
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Web-Browsers">Web browsers</a> (powered by <a href="http://gopherjs.org/">GopherJS</a>)
|
||||
<ul>
|
||||
<li>Supported browsers: Chrome and Firefox on desktops</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Windows</li>
|
||||
<li>Mac OS X</li>
|
||||
<li>Linux</li>
|
||||
<li>Android (WIP)</li>
|
||||
<li>iOS (WIP)</li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Windows">Windows</a></li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Mac-OS-X">Mac OS X</a></li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Linux">Linux</a></li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/Android">Android</a></li>
|
||||
<li><a href="https://github.com/hajimehoshi/ebiten/wiki/iOS">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
@ -70,41 +70,11 @@ pre {
|
||||
<a href="examples/alphablending.html"><img src="images/examples/alphablending.png" width="320" height="240" alt="Ebiten example: alphablending" class="example"></a><a href="examples/audio.html"><img src="images/examples/audio.png" width="320" height="240" alt="Ebiten example: audio" class="example"></a><a href="examples/font.html"><img src="images/examples/font.png" width="320" height="240" alt="Ebiten example: font" class="example"></a><a href="examples/hsv.html"><img src="images/examples/hsv.png" width="320" height="240" alt="Ebiten example: hsv" class="example"></a><a href="examples/hue.html"><img src="images/examples/hue.png" width="320" height="240" alt="Ebiten example: hue" class="example"></a><a href="examples/gamepad.html"><img src="images/examples/gamepad.png" width="320" height="240" alt="Ebiten example: gamepad" class="example"></a><a href="examples/keyboard.html"><img src="images/examples/keyboard.png" width="320" height="240" alt="Ebiten example: keyboard" class="example"></a><a href="examples/masking.html"><img src="images/examples/masking.png" width="320" height="240" alt="Ebiten example: masking" class="example"></a><a href="examples/mosaic.html"><img src="images/examples/mosaic.png" width="320" height="240" alt="Ebiten example: mosaic" class="example"></a><a href="examples/noise.html"><img src="images/examples/noise.png" width="320" height="240" alt="Ebiten example: noise" class="example"></a><a href="examples/paint.html"><img src="images/examples/paint.png" width="320" height="240" alt="Ebiten example: paint" class="example"></a><a href="examples/perspective.html"><img src="images/examples/perspective.png" width="320" height="240" alt="Ebiten example: perspective" class="example"></a><a href="examples/piano.html"><img src="images/examples/piano.png" width="320" height="240" alt="Ebiten example: piano" class="example"></a><a href="examples/rotate.html"><img src="images/examples/rotate.png" width="320" height="240" alt="Ebiten example: rotate" class="example"></a><a href="examples/sprites.html"><img src="images/examples/sprites.png" width="320" height="240" alt="Ebiten example: sprites" class="example"></a><a href="examples/blocks.html"><img src="images/examples/blocks.png" width="256" height="240" alt="Ebiten example: blocks" class="example"></a>
|
||||
</p>
|
||||
|
||||
<h2>Install on Mac OS X or Windows</h2>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
<h2>Install on Linux</h2>
|
||||
<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>
|
||||
<p>Ebiten is tested on Ubuntu Linux x64.</p>
|
||||
|
||||
<h2>Execute the example</h2>
|
||||
<pre><code>:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/examples
|
||||
<pre><code>:; go get github.com/hajimehoshi/ebiten
|
||||
:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/examples
|
||||
:; 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><!DOCTYPE html>
|
||||
<script src="yourgame.js"></script></code></pre>
|
||||
<p>NOTE: <code>file://</code> URL may not work with Ebiten. Execute your game on a HTTP server.</p>
|
||||
|
||||
<h2>Getting Started</h2>
|
||||
|
||||
<p>Let's build a simple "Hello world!" game to get started with Ebiten.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user