From 5b30a8cbeb5ee0036a1b9d7b515abae03a9e1a83 Mon Sep 17 00:00:00 2001 From: Gregg Tavares Date: Mon, 1 Jun 2015 15:51:56 +0900 Subject: [PATCH] update docs --- README.md | 4 +- docs/changelist.html | 225 +++++++++++++++++++++++++++++++++++++++++++ docs/changelist.md | 70 ++++++++++++++ docs/commands.html | 27 +++++- docs/commands.md | 41 +++++++- docs/network.html | 8 +- docs/network.md | 8 +- todo.md | 6 ++ 8 files changed, 374 insertions(+), 15 deletions(-) create mode 100644 docs/changelist.html create mode 100644 docs/changelist.md diff --git a/README.md b/README.md index 116dc246..028daad5 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,14 @@ HappyFunTimes * [Home Page](http://greggman.github.io/HappyFunTimes/) * [Developer Mailing List](https://groups.google.com/d/forum/hft-dev) * [Blog](http://blog.happyfuntimes.net) +* [Facebook Group](https://www.facebook.com/groups/timesfunhappy/) * [Making Games](docs/makinggames.md) -* [Making Games in Unity3D](docs/unitydocs.md) +* [Making Games in Unity3D](docs/unity/) * [Inspiring Ideas for Games](docs/ideas.md) * [Dev Tips](docs/tips.md) * [API Docs](http://greggman.github.io/HappyFunTimes/docs/hft/) * [API Versions](docs/api-versions.md) +* [Changelist](docs/changelist.md) * [Example Descriptions](docs/examples.md) * [Setting Up for a Museum or Installation](docs/network.md) * [Notes](#notes) diff --git a/docs/changelist.html b/docs/changelist.html new file mode 100644 index 00000000..2b35d589 --- /dev/null +++ b/docs/changelist.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

HappyFunTimes Docs

+
+ + +
+
+

+
+
+
+

Changelist

+
    +

  • 0.0.30

    +
      +

    • added --no-check-for-app

      +
      • +

    • added hft/0.x.x/scripts/runtime/live-settings.js so HFT can deliver live setttings easily.

      +

      a little worried there's too many ways to deliver options. As in code is not organized. +To games data comes in index.html through a template. Maybe that should change to +/game/<gameid>/scripts/runtime/live-game-settings.js? One difference is we allow +minifying on game but minifying is at runtime so that doesn't seem like it would matter.

      +
      • +

    • added changelist.md

      +
      • +
    +
    • +
+
    +

  • 0.0.29

    +
      +

    • fixed touch pad code.

      +

      Issue was it was possible for button to get stuck down because we don't always +get pointerup events. Also didn't handle pointerout then sliding back on to button.

      +
      • +

    • added GameClient.log and GameClient.error

      +

      allows the controller to send debug messages that make it to game.

      +
      • +

    • added way for game to supply files for controller.

      +

      This allows games to participate in HappyFunTimes without being registered. +So for example http://greggman.github.io/hft-gamepad-api/

      +
      • +
    +
    • +

  • 0.0.28

    +
      +

    • CommonUI now handles orientation.

      +

      Pass orientation to CommonUI.setupStandardControllerUI and if it can +force the orientation it will. If it can't it will add the appropriate +HTML/CSS so a message appears to turn the phone in the wrong orientation.

      +
      • +

    • Added app suppport.

      +

      HFT tries to redirect to native mobile app.

      +
      • +

    • NetPlayer.name, NetPlayer.busy and NetPlayer.hft_namechange and NetPlayer.hft_busy events.

      +
      • +

    • added code to disablecontext menus.

      +

      Wondering if I should just always do this.

      +
      • +
    +
    • +

  • 0.0.27

    +
      +

    • make hft-publish optionally use HFT_PUBLISH_USER for user:pass

      +
      • +

    • send headers so hopefully browser never caches.

      +
      • +

    • switch to node 0.12

      +
      • +

    • made "Install" message pop to front

      +
      • +
    +
    • +

  • 0.0.26

    +
      +

    • Add session ids. See Netplayer.sessionId

      +
      • +

    • switch docs to use handlebars

      +
      • +

    • add docs.happyfuntimes.net

      +
      • +
    +
    • +
+ +
+
+ + + +
+ + + comments powered by Disqus +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/changelist.md b/docs/changelist.md new file mode 100644 index 00000000..6cccdbd0 --- /dev/null +++ b/docs/changelist.md @@ -0,0 +1,70 @@ +Changelist +========== + +* 0.0.30 + + * added `--no-check-for-app` + + * added `hft/0.x.x/scripts/runtime/live-settings.js` so HFT can deliver live setttings easily. + + a little worried there's too many ways to deliver options. As in code is not organized. + To games data comes in index.html through a template. Maybe that should change to + `/game//scripts/runtime/live-game-settings.js`? One difference is we allow + minifying on game but minifying is at runtime so that doesn't seem like it would matter. + + * added changelist.md + + +* 0.0.29 + + * fixed touch pad code. + + Issue was it was possible for button to get stuck down because we don't always + get pointerup events. Also didn't handle pointerout then sliding back on to button. + + * added `GameClient.log` and `GameClient.error` + + allows the controller to send debug messages that make it to game. + + * added way for game to supply files for controller. + + This allows games to participate in HappyFunTimes without being registered. + So for example http://greggman.github.io/hft-gamepad-api/ + +* 0.0.28 + + * CommonUI now handles orientation. + + Pass orientation to `CommonUI.setupStandardControllerUI` and if it can + force the orientation it will. If it can't it will add the appropriate + HTML/CSS so a message appears to turn the phone in the wrong orientation. + + * Added app suppport. + + HFT tries to redirect to native mobile app. + + * `NetPlayer.name`, `NetPlayer.busy` and `NetPlayer.hft_namechange` and `NetPlayer.hft_busy` events. + + * added code to disablecontext menus. + + Wondering if I should just always do this. + +* 0.0.27 + + * make hft-publish optionally use HFT_PUBLISH_USER for user:pass + + * send headers so hopefully browser never caches. + + * switch to node 0.12 + + * made "Install" message pop to front + +* 0.0.26 + + * Add session ids. See `Netplayer.sessionId` + + * switch docs to use handlebars + + * add docs.happyfuntimes.net + + diff --git a/docs/commands.html b/docs/commands.html index 259e8773..f8af7245 100644 --- a/docs/commands.html +++ b/docs/commands.html @@ -129,7 +129,32 @@

hft remove

This is the opposite of hft add. It removes the game in the current folder from happyFunTimes. No files are deleted.

hft start

-

starts happyFunTimes`

+

starts happyFunTimes.

+

--app-mode

+

launches the browser to http://localhost:18679/games.html. This is the same way HappyFunTimes +is started when you launch by clicking the HappyFunTimes program icon.

+

--system-name=<somename>

+

If you're at a gamejam or some other place where there are multiple happyfuntimes +games running on the same network, then when users connect to happyfuntimes.net they'll +be given a list of game to join. The list will say the name of the computer followed +by the name of the game. By default happyfuntimes user the name of your computer. You +can set a specific name with this option.

+

--no-ask-name

+

If you're running a single game in installation mode and you don't need users to enter +a name this option will skip asking the user for a name

+

--no-menu

+

If you're running in installation mode and you don't need users to be able to change their +name this option turns off the gear icon on the controller

+

--kiosk

+

Normally controllers start at http://localhost:18679. There the controller waits for +a game to start. If multiple games are running users are given a list to choose from. +If you're running in an installation where there's only 1 game you can have controller +go directly to the game with this option.

+

--no-check-for-app

+

Controllers normally try to launch the native mobile app. This check takes 3 seconds. +Use this switch to skip that check.

+

--dns

+

Tells happyfuntimes to implement a DNS server. This is for installation mode.

hft uninstall gameId

Un-installs a game from happyfuntimes. WARNING!!! this DELETES FILES!!!

diff --git a/docs/commands.md b/docs/commands.md index acd03e0a..11cb5aa3 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -87,7 +87,46 @@ happyFunTimes. No files are deleted. ### `hft start` -starts happyFunTimes` +starts happyFunTimes. + +`--app-mode` + +launches the browser to `http://localhost:18679/games.html`. This is the same way HappyFunTimes +is started when you launch by clicking the HappyFunTimes program icon. + +`--system-name=` + +If you're at a gamejam or some other place where there are multiple happyfuntimes +games running on the same network, then when users connect to happyfuntimes.net they'll +be given a list of game to join. The list will say the name of the computer followed +by the name of the game. By default happyfuntimes user the name of your computer. You +can set a specific name with this option. + +`--no-ask-name` + +If you're running a single game in [installation mode](network.md) and you don't need users to enter +a name this option will skip asking the user for a name + +`--no-menu` + +If you're running in [installation mode](network.md) and you don't need users to be able to change their +name this option turns off the gear icon on the controller + +`--kiosk` + +Normally controllers start at `http://localhost:18679`. There the controller waits for +a game to start. If multiple games are running users are given a list to choose from. +If you're running in an [installation](network.md) where there's only 1 game you can have controller +go directly to the game with this option. + +`--no-check-for-app` + +Controllers normally try to launch the native mobile app. This check takes 3 seconds. +Use this switch to skip that check. + +`--dns` + +Tells happyfuntimes to implement a DNS server. This is for [installation mode](network.md). ### `hft uninstall gameId` diff --git a/docs/network.html b/docs/network.html index eebbf7b3..fe4124ab 100644 --- a/docs/network.html +++ b/docs/network.html @@ -177,13 +177,9 @@

Starting HappyFunTimes in i automatcally come up with a page that says "Start". If it's an Android device open the browser and go to hft.com or any http:// url.

If you're planning on running one game on your installation you might want to use -these one or more of these options to start

+these one or more of these options to start

hft start --dns --no-ask-name --no-menu --kiosk
-

--no-menu removes the gear icon on the contollers. --no-ask-name says to skip -asking the user for a name. If your game doesn't need names or if you're getting -the name some other way then this will skip the enter-name screen. Finally --kiosk -says to send players directly to the currently running game. Normally users go -to the /index.html where they wait for a game to be selected.

+

See the start command for details.

Setting Up an Airport Extreme

Unlike every other router in existence the Airport Extreme requires custom software to configure it. If you're on Windows or Linux you'll need to diff --git a/docs/network.md b/docs/network.md index 0a59d846..61aad66d 100644 --- a/docs/network.md +++ b/docs/network.md @@ -154,15 +154,11 @@ automatcally come up with a page that says "Start". If it's an Android device open the browser and go to `hft.com` or any `http://` url. If you're planning on running one game on your installation you might want to use -these one or more of these options to start +these one or more of these [options](commands.md#hft-start) to start hft start --dns --no-ask-name --no-menu --kiosk -`--no-menu` removes the gear icon on the contollers. `--no-ask-name` says to skip -asking the user for a name. If your game doesn't need names or if you're getting -the name some other way then this will skip the enter-name screen. Finally `--kiosk` -says to send players directly to the currently running game. Normally users go -to the `/index.html` where they wait for a game to be selected. +[See the start command for details](commands.md#hft-start). Setting Up an Airport Extreme ----------------------------- diff --git a/todo.md b/todo.md index 81d8507e..bcd2b471 100644 --- a/todo.md +++ b/todo.md @@ -1,6 +1,12 @@ To Do ===== +* make LR +* make LR + 1 +* make LR + 2 +* make touch +* make orientation +* make accel * fix controller that incorrectly asked for orientation * need a way for game to send binary files (how about a .zip) for controller so you can have image files and sounds. That sounds