englercj/lttp-old

[DEPRECATED] A remake of The Legend of Zelda - A Link to the Past using WebGL and the browser.

DEPRECATED, SEE: https://github.com/englercj/lttp

The Legend of Zelda: A Link to the Past (WebGL Edition)

This is a recreation of Nintendo's The Legend of Zelda: A Link to the Past. This is not a port of the game, this is not code conversion, this is not the ROM running in an emulator. This is a complete, written from scratch, recreation of one of my favorite classic games using WebGL in the browser. While I will try my hardest to preserve the spirit of the game, and to come as close to the original as I can; expect slight differences in gameplay, mechanics, and graphics.

This project is in no way endorsed by Nintendo. Most images, logos, characters, dialog, plot, and other assets taken from the original Link to the Past are copyrights of Nintendo; I claim no ownership of any of the assets taken from the original game.

Running the Game

The current state of the game is highly in flux, but you can always run the current state of master by installing Node.js, and running the server.js file:

cd lttp-webgl
npm install express
node server.js

Then point your browser to http://localhost:3001. If you wish to use a gamepad you will need to be running Chrome 24+ or a special build of Firefox.

Dependencies

Here is a list of external dependencies and what they are used for. Each is released under its own respective license:

• jQuery v1.8.2 - For animation utility methods
• jQuery UI v1.8.23 - Custom build with only easing functions
• GrapeFruit - The GameEngine used for all game logic and rendering
• require.js - For logical code seperation and dependency management

All of these dependencies are included in this repository and there is no need to download or add them individually. Note that jQuery and jQuery-UI attempt to load from Google CDN, and fallback to the local files if that fails.

Resources

Below is a list of resources I used for game content. This including sprites, sounds, technical data, walkthroughs, mob information, and misc details of the game:

• Return of Ganon Font - For dialog and other text
• The Spriter's Resource - Used a couple sprites from here
• LTTP Maps - maps of all the dungeons
• SNES Maps - maps of all the dungeons
• Zelda Wiki - Great source of information on game content and mechanics
• Zelda Elements - Another good wiki-like source
• nes-snes-sprites.com - Used for some character sprites

Roadmap

Below is the current TODO list for the project:

• Enemies (generic npc loading from tmx)
• Dialog
• Cutscenes
• First Dungeon (palace)

License and Legal

This code-base is released under the MIT License.

All dependencies are released under their own respective licenses.

Most images, logos, characters, dialog, plot, and other assets taken from the original The Legend of Zelda: A Link to the Past are copyrights of Nintendo; I claim no ownership of any of the assets taken from the original game.

lttp-old's Issues

Screen Tearing

The current shader causes some screen tearing at certain positions. The issue occurs more often on Linux, and it is more prominent when moving along the Y axis.

Here is a screenshot of the issue:

InvalidStateError on xhr

Using 2ca8c1c on Firefox 24

InvalidStateError: An attempt was made to use an object that is not, or is no longer, usable    

xhr.responseType = "text";

gf.js (line 1135)

Map collision clips

Map collision detection will allow clipping through certain 16x16 blocks if the player is moving along both the X axis and Y axis. When moving along only a single axis it works fine.

To Do

Needed to get this off my whiteboard.

First: Upgrade to latest engine version

Then:

• Fall animation is terrible
• Dialogs cover link at some positions
• When taking damage while charging, throw, also throw on fall
• Item bounce when dropped
• Water walk animations
• Small grass walk animations
• Swim animations
• Water moving (waves) animations
• Jumps should go diagonal on sloped sollisions
• Camera jumping on some movement (grapefruit issue?)
• Enemies
  • Spawn/Patrol locations (use Tiled object)
• Item effects and abilities
  • Add each in as needed (not all at once)
• Heart Pieces
  • Need collection support
  • Need to save a persistent state of items on zone
  • Need to be placed on the maps
• Refactor different selection menus into their own objects.

Can't play in Linux

Distro - Kubuntu 13.10

Hangs Google Chrome

• Have to kill process

Crashes in Firefox

• Console says: "InvalidStateError: An attempt was made to use an object that is not, or is no longer, usable"