Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added build and usage instructions to the reademe.md fixes #3
- Loading branch information
Showing
5 changed files
with
77 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,75 @@ | ||
| # pacman | ||
| # Pacman | ||
|
|
||
| [](https://skatiyar.github.io/pacman) | ||
| [](https://goreportcard.com/report/github.com/skatiyar/pacman) | ||
|
|
||
| Classic pacman with procedurally generated infinite vertical maze, written in Golang. | ||
| Classic Pacman with procedurally generated infinite vertical maze. | ||
|
|
||
|  | ||
|
|
||
| ## Motivation | ||
|
|
||
| I came across Eller's algorithm for maze generation, a few months back. Its ability to generate next row with just the knowledge of current row could be used to create an infinite maze. | ||
|
|
||
| Since then I have been toying with idea of creating a game around it. It wasn't until a few days ago that I finally decided to use Pacman as the basis for game. I had experimented with [Ebiten](https://github.com/hajimehoshi/ebiten) 2D game engine a bit and this gave me a good opportunity to use it. | ||
|
|
||
|
|
||
| ## Build | ||
|
|
||
| ``` | ||
| Using `go get` & without go modules. | ||
|
|
||
| ```shell | ||
| $ go get -u github.com/skatiyar/pacman | ||
| $ cd skatiyar/pacman/build/pacman | ||
| $ go run main.go | ||
| ``` | ||
| $ cd skatiyar/pacman | ||
| $ go get ./... | ||
| $ cd build/pacman #goto build dir | ||
| $ go build -o pacman main.go | ||
| $ ./pacman | ||
| ``` | ||
|
|
||
| Using `git clone` & go modules. | ||
|
|
||
| ```shell | ||
| $ git clone https://github.com/skatiyar/pacman.git | ||
| $ cd pacman/build/pacman #goto build dir | ||
| $ go build -o pacman main.go | ||
| $ ./pacman | ||
| ``` | ||
|
|
||
| ## Build gh-pages | ||
|
|
||
| Golang code is converted to JS by using [gopherjs](https://github.com/gopherjs/gopherjs). Ebiten supports browsers by using webgl. | ||
|
|
||
| Note: Setup repo beforehand, as shown above. | ||
|
|
||
| To build just go code. | ||
|
|
||
| ```shell | ||
| $ go get -u github.com/gopherjs/gopherjs | ||
| $ cd pacman/build/pacman | ||
| $ gopherjs build --tags=pacman --output=pacman.js | ||
| ``` | ||
|
|
||
| To build gh-pages. | ||
|
|
||
| ```shell | ||
| $ go get -u github.com/gopherjs/gopherjs | ||
| $ cd pacman/build/pacman-pages | ||
| $ yarn install && yarn build | ||
| ``` | ||
|
|
||
| ## How to play | ||
|
|
||
| - Use `arrow keys` to move pacman. | ||
| - Gain points by eating `dots`. | ||
| - Ghosts try to chase player and on collision player `looses` a life. | ||
| - Player starts with 5 lives and can have upto 7. | ||
| - Collect `diamond` to increase lives. | ||
| - Use `flask` to gain ability to destroy ghosts, ability lasts for `10 Sec` & ghosts try to runaway from player. | ||
| - `Eating` a running away ghost gives a bonus of `200 points`. | ||
|
|
||
| ## Thanks to | ||
|
|
||
| - [Hajimehoshi](https://github.com/hajimehoshi) for Ebiten 2D engine. | ||
| - [Classic Gaming](http://www.classicgaming.cc) for Pacman & Ghost character-art & sounds. | ||
| - [Golang](https://golang.org) community for awesome tools and libraries. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters