https://github.com/hikari-no-yume/lib3ds

A tiny JavaScript library to help you write games and applications that run on the Nintendo 3DS Web Browser.
https://github.com/hikari-no-yume/lib3ds

Last synced: 2 months ago
JSON representation

A tiny JavaScript library to help you write games and applications that run on the Nintendo 3DS Web Browser.

• Host: GitHub
• URL: https://github.com/hikari-no-yume/lib3ds
• Owner: hikari-no-yume
• Created: 2013-12-25T19:05:55.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-12-27T22:26:15.000Z (about 11 years ago)
• Last Synced: 2024-04-14T15:09:28.153Z (9 months ago)
• Language: JavaScript
• Size: 117 KB
• Stars: 8
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
About

=====

What's this?

------------

lib3DS is a tiny JavaScript library to help you write games and applications that run on the Nintendo 3DS Web Browser. It can set up three different display modes and handle D-pad and A button input.

Who made it?

------------

Me, [Andrea Faulds](http://ajf.me/). I admittedly took some ideas on how to deal with positioning from Andy Smith's [jFox demo](http://3ds.andysmith.co.uk/jFox.html) and the 3DSPlaza [Sidescroller Demo](http://www.3dsplaza.com/apps/sidescroller/). However all the code contained within this library was written by me.

What license is it under?

-------------------------

The MIT license, see the header of lib3DS.js

How do I use it?

----------------

There are three display mode functions, and the intention is that only one is called. Your page's `body` should be entirely empty except for your script includes. The mode function will set things up for you, returning one or two DOM elements (depending on the mode). You should display everything inside those one or two elements and not append anything to the body yourself.

The button handling will overwrite existing `.onkeydown` and `.onkeyup` handlers for `document.body`, if any, but you can otherwise use it in any page.

API

===

The "bouncing" mentioned is due to the left, right, up or down keys moving the page. In some modes, due to the page's size and positioning, the browser will not let the page move in that direction. However, in the cases where it will, lib3DS will move the page back. This is unfortunately not always instant, leading to the page shifting briefly while it "bounces" back. It won't break your button event handlers or anything like that, but it will be annoying, so if you wish to use a mode where pressing a certain button causes "bouncing", you should probably avoid using that button in your control scheme.

* **lib3DS.initMode320**()

  

  Sets up display mode and returns object containing one key:

  * **bottomScreen** - DOM element of div showing on bottom screen of 3DS

  In this mode, there is no top screen. The bottom screen is 320x212px.

  No keys cause bouncing by being pressed in this mode.

  

* **lib3DS.initModeDual320**()

  

  Sets up display mode and returns object containing two keys:

  * **topScreen** - DOM element of div showing on top screen of 3DS

  * **bottomScreen** - DOM element of div showing on bottom screen of 3DS

  In this mode, top screen is 320x214px and the bottom screen is 320x212px.

  Pressing the up key may cause bouncing.

* **lib3DS.handleButtons**([*onkeydown*[, *onkeyup*]])

  

  Registers event handlers for buttons. onkeydown and onkeyup will be

  called when a button is depressed or released, respectively. The name of

  the button ("A", "left", "up", "right" or "down") will be passed as the

  first parameter when calling them. Both parameters are optional and if

  a falsey value (null, false, undefined, etc.) is passed instead, the

  function will not be called.