You've already forked FullScreenPokemon
mirror of
https://github.com/FullScreenShenanigans/FullScreenPokemon.git
synced 2026-04-28 12:58:40 -07:00
Josh Goldberg
39 lines
2.4 KiB
Markdown
39 lines
2.4 KiB
Markdown
## FullScreenPokemon [](https://travis-ci.org/FullScreenShenanigans/FullScreenPokemon)
|
|
|
|
#### A free HTML5 remake of Nintendo's original Pokemon, expanded for the modern web.
|
|
|
|
|
|
## How to Play
|
|
|
|
Although you may no longer play on [fullscreenpokemon.com](http://www.fullscreenpokemon.com), it is easy to play your own copy.
|
|
|
|
#### Newcomers (non-coders)
|
|
|
|
[Download the latest release .zip](https://github.com/FullScreenShenanigans/FullScreenPokemon/releases) of this project, extract that onto your computer, and open **index.html** in a browser (preferably Google Chrome). That's it!
|
|
|
|
#### In your own site
|
|
|
|
Upload the latest release of FullScreenPokemon (or your built version) to your FTP server.
|
|
|
|
|
|
## Developing
|
|
|
|
#### Build Process
|
|
|
|
FullScreenPokemon uses [Grunt](http://gruntjs.com/) to automate building, which requires [Node.js](http://node.js.org). The process is straightforward; see [Grunt's help page](http://gruntjs.com/getting-started).
|
|
|
|
#### Coding
|
|
|
|
FullScreenPokemon is built on a modular framework called GameStartr. The [FullScreenShenanigans](https://github.com/FullScreenShenanigans/) organization contains GameStartr, its parent class EightBittr, and the 22 modules used by the GameStartr framework. These all (theoretically) have their own README files, which you should skim before developing for FullScreenPokemon itself.
|
|
|
|
All source code is in the [Source](Source/) directory.
|
|
|
|
The FullScreenPokemon.ts class declaration contains class functions and some constants, while static settings to be added to the FullScreenPokemon prototype, such as map layouts and object attributes, are stored in files under [Source/settings](Source/settings), such as audio.js and collisions.js.
|
|
|
|
|
|
## Legal
|
|
|
|
This is released under the [MIT License](http://mit-license.org/) (see [License.txt](LICENSE.txt)).
|
|
|
|
The FullScreenMario project started October 21st, 2012. The initial beta release in October 2013 saw the [primary host website](http://www.fullscreenmario.com) receive approximately 2.68 million unique visitors within a month, after which Nintendo shut the site down with a DMCA complaint (no action was taken against the authors, GitHub, or other hosting websites). The coding project then underwent an extensive rewrite and architecture change to become a modular project centered on the GameStartr platform, followed by a complete conversion to TypeScript.
|