Skip to content

Commit 5b30a8c

Browse files
greggmangreggman
committed
update docs
1 parent a9bcccd commit 5b30a8c

File tree

8 files changed

+374
-15
lines changed

8 files changed

+374
-15
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ HappyFunTimes
66
* [Home Page](http://greggman.github.io/HappyFunTimes/)
77
* [Developer Mailing List](https://groups.google.com/d/forum/hft-dev)
88
* [Blog](http://blog.happyfuntimes.net)
9+
* [Facebook Group](https://www.facebook.com/groups/timesfunhappy/)
910
* [Making Games](docs/makinggames.md)
10-
* [Making Games in Unity3D](docs/unitydocs.md)
11+
* [Making Games in Unity3D](docs/unity/)
1112
* [Inspiring Ideas for Games](docs/ideas.md)
1213
* [Dev Tips](docs/tips.md)
1314
* [API Docs](http://greggman.github.io/HappyFunTimes/docs/hft/)
1415
* [API Versions](docs/api-versions.md)
16+
* [Changelist](docs/changelist.md)
1517
* [Example Descriptions](docs/examples.md)
1618
* [Setting Up for a Museum or Installation](docs/network.md)
1719
* [Notes](#notes)

‎docs/changelist.html‎

Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
<!DOCTYPE html>
2+
<!-- this file is auto-generated from docs/changelist.md. Do not edited directly -->
3+
<!--
4+
Copyright 2012, Gregg Tavares.
5+
All rights reserved.
6+
7+
Redistribution and use in source and binary forms, with or without
8+
modification, are permitted provided that the following conditions are
9+
met:
10+
11+
* Redistributions of source code must retain the above copyright
12+
notice, this list of conditions and the following disclaimer.
13+
* Redistributions in binary form must reproduce the above
14+
copyright notice, this list of conditions and the following disclaimer
15+
in the documentation and/or other materials provided with the
16+
distribution.
17+
* Neither the name of Gregg Tavares. nor the names of his
18+
contributors may be used to endorse or promote products derived from
19+
this software without specific prior written permission.
20+
21+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32+
-->
33+
<html>
34+
<head>
35+
<meta charset="utf-8">
36+
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0, user-scalable=yes">
37+
<meta property="og:title" content="" />
38+
<meta property="og:type" content="website" />
39+
<meta property="og:image" content="http://docs.happyfuntimes.net/docs/images/happyfuntimes.jpg" />
40+
<meta property="og:description" content="" />
41+
<meta property="og:url" content="http://docs.happyfuntimes.net/docs/changelist.html" />
42+
43+
<meta name="twitter:card" content="summary_large_image" />
44+
<meta name="twitter:site" content="@greggman" />
45+
<meta name="twitter:creator" content="@greggman" />
46+
<meta name="twitter:domain" content="docs.happyfuntimes.net" />
47+
<meta name="twitter:title" content="" />
48+
<meta name="twitter:url" content="http://docs.happyfuntimes.net/docs/changelist.html" />
49+
<meta name="twitter:description" content="" />
50+
<meta name="twitter:image:src" content="http://docs.happyfuntimes.net/docs/images/happyfuntimes.jpg" />
51+
52+
<title></title>
53+
<link href="/public/hft-icon.png" rel="shortcut icon" type="image/png">
54+
<link rel="stylesheet" href="/docs/css/base.css" type="text/css" />
55+
<link rel="stylesheet" href="/docs/css/lesson.css" type="text/css" />
56+
</head>
57+
<body>
58+
<div class="header">
59+
<h1><a href="/docs">HappyFunTimes Docs</a></h1>
60+
</div>
61+
62+
63+
<div class="container">
64+
<div class="lesson-title">
65+
<h1></h1>
66+
</div>
67+
<div class="row">
68+
<div class="col-sm-8 lesson-main">
69+
<h1 id="changelist">Changelist</h1>
70+
<ul>
71+
<li><p>0.0.30</p>
72+
<ul>
73+
<li><p>added <code>--no-check-for-app</code></p>
74+
</li>
75+
<li><p>added <code>hft/0.x.x/scripts/runtime/live-settings.js</code> so HFT can deliver live setttings easily.</p>
76+
<p>a little worried there&#39;s too many ways to deliver options. As in code is not organized.
77+
To games data comes in index.html through a template. Maybe that should change to
78+
<code>/game/&lt;gameid&gt;/scripts/runtime/live-game-settings.js</code>? One difference is we allow
79+
minifying on game but minifying is at runtime so that doesn&#39;t seem like it would matter.</p>
80+
</li>
81+
<li><p>added changelist.md</p>
82+
</li>
83+
</ul>
84+
</li>
85+
</ul>
86+
<ul>
87+
<li><p>0.0.29</p>
88+
<ul>
89+
<li><p>fixed touch pad code.</p>
90+
<p>Issue was it was possible for button to get stuck down because we don&#39;t always
91+
get pointerup events. Also didn&#39;t handle pointerout then sliding back on to button.</p>
92+
</li>
93+
<li><p>added <code>GameClient.log</code> and <code>GameClient.error</code></p>
94+
<p>allows the controller to send debug messages that make it to game.</p>
95+
</li>
96+
<li><p>added way for game to supply files for controller.</p>
97+
<p>This allows games to participate in HappyFunTimes without being registered.
98+
So for example <a href="http://greggman.github.io/hft-gamepad-api/">http://greggman.github.io/hft-gamepad-api/</a></p>
99+
</li>
100+
</ul>
101+
</li>
102+
<li><p>0.0.28</p>
103+
<ul>
104+
<li><p>CommonUI now handles orientation.</p>
105+
<p>Pass orientation to <code>CommonUI.setupStandardControllerUI</code> and if it can
106+
force the orientation it will. If it can&#39;t it will add the appropriate
107+
HTML/CSS so a message appears to turn the phone in the wrong orientation.</p>
108+
</li>
109+
<li><p>Added app suppport.</p>
110+
<p>HFT tries to redirect to native mobile app.</p>
111+
</li>
112+
<li><p><code>NetPlayer.name</code>, <code>NetPlayer.busy</code> and <code>NetPlayer.hft_namechange</code> and <code>NetPlayer.hft_busy</code> events.</p>
113+
</li>
114+
<li><p>added code to disablecontext menus.</p>
115+
<p>Wondering if I should just always do this.</p>
116+
</li>
117+
</ul>
118+
</li>
119+
<li><p>0.0.27</p>
120+
<ul>
121+
<li><p>make hft-publish optionally use HFT_PUBLISH_USER for user:pass</p>
122+
</li>
123+
<li><p>send headers so hopefully browser never caches.</p>
124+
</li>
125+
<li><p>switch to node 0.12</p>
126+
</li>
127+
<li><p>made &quot;Install&quot; message pop to front</p>
128+
</li>
129+
</ul>
130+
</li>
131+
<li><p>0.0.26</p>
132+
<ul>
133+
<li><p>Add session ids. See <code>Netplayer.sessionId</code></p>
134+
</li>
135+
<li><p>switch docs to use handlebars</p>
136+
</li>
137+
<li><p>add docs.happyfuntimes.net</p>
138+
</li>
139+
</ul>
140+
</li>
141+
</ul>
142+
143+
<hr/>
144+
<div>
145+
<div>Questions? <a href="http://stackoverflow.com/questions/tagged/happyfuntimes">Ask on stackoverflow</a>.</div>
146+
<div>Issue/Bug? <a href="http://github.com/greggman/happyfuntimes/issues">Create an issue on github</a>.</div>
147+
148+
<div id="disqus_thread"></div>
149+
<script type="text/javascript">
150+
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
151+
var disqus_shortname = 'happyfuntimes'; // required: replace example with your forum shortname
152+
var disqus_identifier = '';
153+
var disqus_title = '';
154+
155+
/* * * DON'T EDIT BELOW THIS LINE * * */
156+
(function() {
157+
if (window.location.hostname.indexOf("happyfuntimes") < 0) {
158+
return;
159+
}
160+
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
161+
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
162+
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
163+
})();
164+
</script>
165+
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
166+
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
167+
</div>
168+
</div>
169+
<div class="col-sm-3 col-sm-offset-1 lesson-sidebar">
170+
<ul>
171+
<li>Setup
172+
<ul>
173+
<li><a href="osx.html">OSX</a></li>
174+
<li><a href="windows.html">Windows</a></li>
175+
<li><a href="linux.html">Linux</a></li>
176+
</ul>
177+
</li>
178+
<li>Making Games
179+
<ul>
180+
<li><a href="makinggames.html">Making games in HTML5</a></li>
181+
<li><a href="unity">Making games in Unity3D</a></li>
182+
<li><a href="ideas.html">Ideas</a></li>
183+
<li><a href="tips.html">Tips</a></li>
184+
<li><a href="examples.html">Examples</a></li>
185+
<li><a href="api-versions.html">API Versions</a></li>
186+
<li><a href="commands.html">hft command</a></li>
187+
</ul>
188+
</li>
189+
<li>Special Stuff
190+
<ul>
191+
<li><a href="network.html">Museums & Installations</a></li>
192+
<li><a href="migration.html">Migrating from older APIs</a></li>
193+
</ul>
194+
</li>
195+
<li>Contributing
196+
<ul>
197+
<li><a href="contributing.html">Contributing</a></li>
198+
<li><a href="future.html">Future Features</a></li>
199+
</ul>
200+
</li>
201+
</ul>
202+
203+
</div>
204+
</div>
205+
</div>
206+
</body>
207+
<script src="/docs/3rdparty/jquery-1.11.2.min.js"></script>
208+
<script src="/docs/3rdparty/prettify.js"></script>
209+
<script src="/docs/js/lesson.js"></script>
210+
<script>
211+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
212+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
213+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
214+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
215+
216+
ga('create', 'UA-51764205-4', 'auto');
217+
ga('send', 'pageview');
218+
219+
</script>
220+
221+
222+
</html>
223+
224+
225+

‎docs/changelist.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
Changelist
2+
==========
3+
4+
* 0.0.30
5+
6+
* added `--no-check-for-app`
7+
8+
* added `hft/0.x.x/scripts/runtime/live-settings.js` so HFT can deliver live setttings easily.
9+
10+
a little worried there's too many ways to deliver options. As in code is not organized.
11+
To games data comes in index.html through a template. Maybe that should change to
12+
`/game/<gameid>/scripts/runtime/live-game-settings.js`? One difference is we allow
13+
minifying on game but minifying is at runtime so that doesn't seem like it would matter.
14+
15+
* added changelist.md
16+
17+
18+
* 0.0.29
19+
20+
* fixed touch pad code.
21+
22+
Issue was it was possible for button to get stuck down because we don't always
23+
get pointerup events. Also didn't handle pointerout then sliding back on to button.
24+
25+
* added `GameClient.log` and `GameClient.error`
26+
27+
allows the controller to send debug messages that make it to game.
28+
29+
* added way for game to supply files for controller.
30+
31+
This allows games to participate in HappyFunTimes without being registered.
32+
So for example http://greggman.github.io/hft-gamepad-api/
33+
34+
* 0.0.28
35+
36+
* CommonUI now handles orientation.
37+
38+
Pass orientation to `CommonUI.setupStandardControllerUI` and if it can
39+
force the orientation it will. If it can't it will add the appropriate
40+
HTML/CSS so a message appears to turn the phone in the wrong orientation.
41+
42+
* Added app suppport.
43+
44+
HFT tries to redirect to native mobile app.
45+
46+
* `NetPlayer.name`, `NetPlayer.busy` and `NetPlayer.hft_namechange` and `NetPlayer.hft_busy` events.
47+
48+
* added code to disablecontext menus.
49+
50+
Wondering if I should just always do this.
51+
52+
* 0.0.27
53+
54+
* make hft-publish optionally use HFT_PUBLISH_USER for user:pass
55+
56+
* send headers so hopefully browser never caches.
57+
58+
* switch to node 0.12
59+
60+
* made "Install" message pop to front
61+
62+
* 0.0.26
63+
64+
* Add session ids. See `Netplayer.sessionId`
65+
66+
* switch docs to use handlebars
67+
68+
* add docs.happyfuntimes.net
69+
70+

‎docs/commands.html‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,32 @@ <h3 id="-hft-remove-"><code>hft remove</code></h3>
129129
<p>This is the opposite of <code>hft add</code>. It removes the game in the current folder from
130130
happyFunTimes. No files are deleted.</p>
131131
<h3 id="-hft-start-"><code>hft start</code></h3>
132-
<p>starts happyFunTimes`</p>
132+
<p>starts happyFunTimes.</p>
133+
<p><code>--app-mode</code></p>
134+
<p>launches the browser to <code>http://localhost:18679/games.html</code>. This is the same way HappyFunTimes
135+
is started when you launch by clicking the HappyFunTimes program icon.</p>
136+
<p><code>--system-name=&lt;somename&gt;</code></p>
137+
<p>If you&#39;re at a gamejam or some other place where there are multiple happyfuntimes
138+
games running on the same network, then when users connect to happyfuntimes.net they&#39;ll
139+
be given a list of game to join. The list will say the name of the computer followed
140+
by the name of the game. By default happyfuntimes user the name of your computer. You
141+
can set a specific name with this option.</p>
142+
<p><code>--no-ask-name</code></p>
143+
<p>If you&#39;re running a single game in <a href="network.html">installation mode</a> and you don&#39;t need users to enter
144+
a name this option will skip asking the user for a name</p>
145+
<p><code>--no-menu</code></p>
146+
<p>If you&#39;re running in <a href="network.html">installation mode</a> and you don&#39;t need users to be able to change their
147+
name this option turns off the gear icon on the controller</p>
148+
<p><code>--kiosk</code></p>
149+
<p>Normally controllers start at <code>http://localhost:18679</code>. There the controller waits for
150+
a game to start. If multiple games are running users are given a list to choose from.
151+
If you&#39;re running in an <a href="network.html">installation</a> where there&#39;s only 1 game you can have controller
152+
go directly to the game with this option.</p>
153+
<p><code>--no-check-for-app</code></p>
154+
<p>Controllers normally try to launch the native mobile app. This check takes 3 seconds.
155+
Use this switch to skip that check.</p>
156+
<p><code>--dns</code></p>
157+
<p>Tells happyfuntimes to implement a DNS server. This is for <a href="network.html">installation mode</a>.</p>
133158
<h3 id="-hft-uninstall-gameid-"><code>hft uninstall gameId</code></h3>
134159
<p>Un-installs a game from happyfuntimes. <strong>WARNING!!! this DELETES FILES!!!</strong></p>
135160

‎docs/commands.md‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,46 @@ happyFunTimes. No files are deleted.
8787

8888
### `hft start`
8989

90-
starts happyFunTimes`
90+
starts happyFunTimes.
91+
92+
`--app-mode`
93+
94+
launches the browser to `http://localhost:18679/games.html`. This is the same way HappyFunTimes
95+
is started when you launch by clicking the HappyFunTimes program icon.
96+
97+
`--system-name=<somename>`
98+
99+
If you're at a gamejam or some other place where there are multiple happyfuntimes
100+
games running on the same network, then when users connect to happyfuntimes.net they'll
101+
be given a list of game to join. The list will say the name of the computer followed
102+
by the name of the game. By default happyfuntimes user the name of your computer. You
103+
can set a specific name with this option.
104+
105+
`--no-ask-name`
106+
107+
If you're running a single game in [installation mode](network.md) and you don't need users to enter
108+
a name this option will skip asking the user for a name
109+
110+
`--no-menu`
111+
112+
If you're running in [installation mode](network.md) and you don't need users to be able to change their
113+
name this option turns off the gear icon on the controller
114+
115+
`--kiosk`
116+
117+
Normally controllers start at `http://localhost:18679`. There the controller waits for
118+
a game to start. If multiple games are running users are given a list to choose from.
119+
If you're running in an [installation](network.md) where there's only 1 game you can have controller
120+
go directly to the game with this option.
121+
122+
`--no-check-for-app`
123+
124+
Controllers normally try to launch the native mobile app. This check takes 3 seconds.
125+
Use this switch to skip that check.
126+
127+
`--dns`
128+
129+
Tells happyfuntimes to implement a DNS server. This is for [installation mode](network.md).
91130

92131
### `hft uninstall gameId`
93132

0 commit comments

Comments
 (0)