Skip to content

Commit 85269d2

Browse files
committed
Added brand-neutral help file, credits and assets to Boxer Standalone to avoid build errors.
1 parent 41ab689 commit 85269d2

40 files changed

Lines changed: 1846 additions & 6 deletions

.gitignore

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,3 @@ build
1313
*.mode2v3
1414
xcuserdata
1515
project.xcworkspace
16-
17-
#Ignore standalone assets that are meant to be provided downstream
18-
Standalone/Resources/StandaloneLogo.png
19-
Standalone/Resources/StandaloneLogo@2x.png
20-
Standalone/Resources/English.lproj/Credits.html
21-
Standalone/Resources/Help.help
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title></title>
6+
<style type="text/css">
7+
html
8+
{
9+
margin: 0 20px;
10+
padding: 0;
11+
}
12+
13+
p
14+
{
15+
color: rgba(255, 255, 255, 0.6);
16+
text-shadow: rgba(0, 0, 0, 0.75) 0 1px 3px;
17+
font: 13px/20px "Lucida Grande";
18+
text-align: center;
19+
margin: 0 0 10px;
20+
}
21+
22+
p.copyright
23+
{
24+
color: white;
25+
}
26+
27+
a
28+
{
29+
text-decoration: underline;
30+
color: rgba(255, 255, 255, 0.7);
31+
}
32+
33+
a:hover, a:focus
34+
{
35+
color: white;
36+
}
37+
38+
hr
39+
{
40+
margin: 0 0 10px;
41+
width: 100%;
42+
height: 0;
43+
border: 0;
44+
border-top: 1px solid rgba(0, 0, 0, 0.25);
45+
border-bottom: 1px solid rgba(255, 255, 255, 0.1);
46+
background: transparent;
47+
display: block;
48+
}
49+
</style>
50+
</head>
51+
<body>
52+
<hr>
53+
<p>Brought to you with the help of <a href="http://boxerapp.com">Boxer</a> and <a href="http://www.dosbox.com">DOSBox</a>.</p>
54+
</body>
55+
</html>
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3+
<plist version="1.0">
4+
<dict>
5+
<key>CFBundleDevelopmentRegion</key>
6+
<string>en-us</string>
7+
<key>CFBundleIdentifier</key>
8+
<string>{{BUNDLE_IDENTIFIER}}.help</string>
9+
<key>CFBundleInfoDictionaryVersion</key>
10+
<string>6.0</string>
11+
<key>CFBundleName</key>
12+
<string>{{APPLICATION_NAME}} Help</string>
13+
<key>CFBundlePackageType</key>
14+
<string>BNDL</string>
15+
<key>CFBundleShortVersionString</key>
16+
<string>1</string>
17+
<key>CFBundleSignature</key>
18+
<string>hbwr</string>
19+
<key>CFBundleVersion</key>
20+
<string>1</string>
21+
<key>HPDBookAccessPath</key>
22+
<string>index.html</string>
23+
<key>HPDBookIndexPath</key>
24+
<string>search.helpindex</string>
25+
<key>HPDBookKBProduct</key>
26+
<string>{{BUNDLE_IDENTIFIER}}.help</string>
27+
<key>HPDBookIconPath</key>
28+
<string>shared/images/icon.png</string>
29+
<key>HPDBookTitle</key>
30+
<string>{{APPLICATION_NAME}} Help</string>
31+
<key>HPDBookType</key>
32+
<string>3</string>
33+
</dict>
34+
</plist>
79.9 KB
Loading
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5+
<title>Help Topics</title>
6+
<meta name="robots" content="anchors">
7+
8+
<link rel="stylesheet" type="text/css" href="../shared/styles/main.css">
9+
<link rel="stylesheet" type="text/css" href="../shared/styles/index.css">
10+
</head>
11+
<body>
12+
<a name="homepage"></a>
13+
<h1>Help Topics</h1>
14+
15+
<ul id="main-topics">
16+
<li id="keyboard-and-mouse-tips"><a href="pages/keyboard-and-mouse.html" rel="topic">
17+
<img src="../shared/images/keyboard.png" alt="">
18+
<h3>Keyboard and mouse tips</h3>
19+
<p>Useful shortcuts for trackpads and compact Mac keyboards.</p>
20+
</a></li>
21+
22+
<li id="joysticks"><a href="pages/joysticks.html" rel="topic">
23+
<img src="../shared/images/standard-joystick-128.png" alt="">
24+
<h3>Play with a joystick or gamepad</h3>
25+
<p>How to connect a USB controller or an iPhone running Joypad.</p>
26+
</a></li>
27+
</ul>
28+
29+
<aside id="side-topics">
30+
<p>
31+
<a href="pages/acknowledgements.html" rel="topic">Acknowledgements</a> |
32+
<a href="pages/legalese.html" rel="topic">Licenses</a>
33+
</p>
34+
</aside>
35+
36+
<script type="text/javascript" src="shared/scripts/zepto.min.js"></script>
37+
<script type="text/javascript" src="shared/scripts/linkhandlers.js"></script>
38+
</body>
39+
</html>
40+
41+
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5+
<title>Acknowledgements</title>
6+
<meta name="description" content="Boxer wouldn’t be possible without the support of many lovely people.">
7+
<meta name="keywords" content="credits, sources, thankyou">
8+
9+
<link rel="stylesheet" type="text/css" href="../../shared/styles/main.css">
10+
<link rel="stylesheet" type="text/css" href="../../shared/styles/acknowledgements.css">
11+
</head>
12+
<body>
13+
<a name="acknowledgements"></a>
14+
15+
<h1>Acknowledgements</h1>
16+
17+
<p>This game is powered by <a href="http://boxerapp.com/" rel="external">Boxer</a>: a DOS emulator for OS&nbsp;X, based on the cross-platform <a href="http://www.dosbox.com/" rel="external">DOSBox</a> project.</p>
18+
19+
<p>Boxer is &copy; 2013 by <a href="mailto:abestor@boxerapp.com" rel="email">Alun Bestor</a>. DOSBox is &copy; 2002-2010 by The DOSBox Team and contributors.</p>
20+
21+
<section>
22+
<a name="contributing-projects"></a>
23+
<h2>Contributing projects</h2>
24+
25+
<p>Boxer includes code and utilities from the following people:</p>
26+
27+
<ul class="project-list">
28+
<li><a href="http://dosbox.com/" rel="external">DOSBox</a> by the DOSBox Team
29+
<a href="legalese.html#legalese-dosbox" class="license-link">license…</a></li>
30+
31+
<li><a href="http://www.libsdl.org/" rel="external">SDL and SDL_net</a> by Sam Lantinga
32+
<a href="legalese.html#legalese-sdl" class="license-link">license…</a></li>
33+
34+
<li><a href="http://icculus.org/SDL_sound/" rel="external">SDL_sound</a> by Ryan C. Gordon and Eric Wing
35+
<a href="legalese.html#legalese-sdlsound" class="license-link">license…</a></li>
36+
37+
<li><a href="http://sourceforge.net/projects/munt/" rel="external">Munt</a> by Dean Beeler, Jerome Fisher, Sergey V. Mikayev et. al.
38+
<a href="legalese.html#legalese-munt" class="license-link">license…</a></li>
39+
40+
<li><a href="http://www.dribin.org/dave/software/" rel="external">DDHIDLib</a> by Dave Dribin
41+
<a href="legalese.html#legalese-ddhidlib" class="license-link">license…</a></li>
42+
43+
<li><a href="https://github.com/binarygod/BGHUDAppKit" rel="external">BGHUDAppKit</a> by Tim Davis
44+
<a href="legalese.html#legalese-bghudappkit" class="license-link">license…</a></li>
45+
46+
<li><a href="http://regexkit.sourceforge.net/RegexKitLite/" rel="external">RegExKitLite</a> by John Engelhart
47+
<a href="legalese.html#legalese-regexkitlite" class="license-link">license…</a></li>
48+
49+
<li><a href="http://www.seanpatrickobrien.com/downloads" rel="external">NSBezierPath+MCAdditions</a> by Sean Patrick O'Brien
50+
<a href="legalese.html#legalese-mcadditions" class="license-link">license…</a></li>
51+
52+
<li><a href="https://github.com/kelan/yrk-spinning-progress-indicator" rel="external">YRKSpinningProgressIndicator</a> by Kelan Champagne
53+
<a href="legalese.html#legalese-yrkspinningprogressindicator" class="license-link">license…</a></li>
54+
55+
<li><a href="http://zeptojs.com/" rel="external">Zepto.js</a> by Thomas Fuchs
56+
<a href="legalese.html#legalese-zeptojs" class="license-link">license…</a></li>
57+
58+
<li>5xBR shader by Hyllian, adapted to GLSL by crazy46guy
59+
<a href="legalese.html#legalese-xbr" class="license-link">license…</a></li>
60+
61+
<li>CRT-geom shader by cgwg, Themaister and DOLLS
62+
<a href="legalese.html#legalese-crt-geom" class="license-link">license…</a></li>
63+
</ul>
64+
<ul>
65+
<li><a href="http://www.freedos.org/" rel="external">FreeDOS utilities</a> by Eric Auer, Joe Cosentino, Matthew Stanford and Rene Ableidinger
66+
<a href="legalese.html#legalese-gpl" class="license-link">license…</a></li>
67+
68+
<li><a href="http://home.mnet-online.de/horst.muc/ui.htm" rel="external">WBAT.COM</a> by Horst Schaeffer, released as freeware</li>
69+
70+
<li>LOCATE.COM and DELTREE.COM by Charles Dye, released as freeware</li>
71+
72+
<li>UNIVBE.EXE 4.0 by Kendall Bennett (pre-SciTech), released as freeware</li>
73+
74+
<li><a href="http://vogons.zetafleet.com/viewtopic.php?t=10786&amp;start=20" rel="external">ABSTRACT.COM</a> thanks to ripsaw8080 and the VOGONS community, distributed with permission</li>
75+
</ul>
76+
</section>
77+
78+
<section>
79+
<a name="source-code"></a>
80+
<h2>Share and Share Alike:</h2>
81+
82+
<p>Boxer is <a href="legalese.html#legalese-boxer">open-source licensed</a> under the <a href="legalese.html#legalese-gpl">GPL 2.0</a>. The complete source code for Boxer, its graphics and its supporting frameworks are hosted at <a href="https://github.com/alunbestor/" rel="external">GitHub</a>.</p>
83+
</section>
84+
85+
<script type="text/javascript" src="../shared/scripts/zepto.min.js"></script>
86+
<script type="text/javascript" src="../shared/scripts/linkhandlers.js"></script>
87+
</body>
88+
</html>
89+
90+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5+
<title>Playing with your joystick</title>
6+
<meta name="description" content="Connecting a USB joystick or gamepad.">
7+
<meta name="keywords" content="flight stick, steering wheel, d-pad, dpad, hatswitch, coolie hat, pov switch, sixaxis, gameport, xbox360, ps3, playstation">
8+
9+
<link rel="stylesheet" type="text/css" href="../../shared/styles/main.css">
10+
<link rel="stylesheet" type="text/css" href="../../shared/styles/joysticks.css">
11+
</head>
12+
<body>
13+
<a name="joysticks"></a>
14+
<h1>Playing with a joystick</h1>
15+
16+
<p>If the game supports joystick control, you can play it with a USB joystick, gamepad or racing wheel—or even with an iPhone. There are two ways to get started:</p>
17+
18+
<section>
19+
<a name="joystick-connecting-hid"></a>
20+
<h2><span class="step">Option A</span> Connect a USB or Bluetooth game controller</h2>
21+
22+
<img src="../../shared/images/360-controller.png" alt="" class="floated-right">
23+
24+
<p><strong>Connect the controller to your Mac and then relaunch the game</strong>. The game should find the joystick automatically — if not, make sure that joystick control is enabled in the game’s options screen.</p>
25+
26+
<p class="note">Most USB controllers will work in OS X, but some may require additional drivers before OS X will recognise them. Consult the device manufacturer if you have trouble getting OS X to recognise it.</p>
27+
28+
<p class="tip">To get OS&nbsp;X to recognise an <strong>XBOX 360 controller</strong>, you need to install third-party drivers. <a href="http://tattiebogle.net/index.php/ProjectRoot/Xbox360Controller/OsxDriver" rel="external">Get the drivers here</a></p>
29+
</section>
30+
31+
<section>
32+
<a name="joystick-connecting-joypad"></a>
33+
<h2><span class="step">Option B</span> Connect an iPhone or iPod Touch running Joypad</h2>
34+
35+
<a href="http://getjoypad.com/"><img src="../../shared/images/joypad-logo.png" alt="Get Joypad" class="floated-left"></a>
36+
<p><a href="http://getjoypad.com/" rel="external">Joypad</a> is a free iOS app that makes your iPhone or iPod&nbsp;Touch into a game controller for your Mac.</p>
37+
38+
<p><a href="http://getjoypad.com/" rel="external">Get Joypad from the iOS App Store.</a> Once you have it, <strong>start up Joypad on your iOS device</strong> and then <strong>relaunch the game</strong>. After a short delay, a virtual gamepad or joystick will appear on the iOS device: then you can begin controlling the game.</p>
39+
40+
<p class="note cleared">If Joypad does not connect initially, try closing and relaunching Joypad on your iOS device. Consult <a href="http://getjoypad.com/faqs.html" rel="external">Joypad’s Support FAQ</a> for more tips.</p>
41+
</section>
42+
</body>
43+
</html>
Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5+
<title>Keyboard and mouse tips</title>
6+
<meta name="description" content="Keyboard shortcuts, mouse-button modifiers, and tweaks for keyboard behaviour.">
7+
<meta name="keywords" content="hotkeys, mousebutton, touchpad, fullscreen, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, screen shot, media key">
8+
9+
<link rel="stylesheet" type="text/css" href="../../shared/styles/main.css">
10+
</head>
11+
<body>
12+
<a name="shortcuts"></a>
13+
<h1>Keyboard and mouse tips</h1>
14+
15+
<section>
16+
<a name="keyboard-shortcuts"></a>
17+
18+
<table class="wide shortcuts">
19+
<col class="action">
20+
<col class="shortcut">
21+
<thead>
22+
<tr>
23+
<th>Action</th>
24+
<th>Shortcut</th>
25+
</tr>
26+
</thead>
27+
28+
<tbody>
29+
<tr>
30+
<td>Click the right mouse button</td>
31+
<td><kbd>Ctrl ⌃</kbd>+<kbd>click</kbd></td>
32+
</tr>
33+
<tr>
34+
<td>Click the left and right mouse buttons at once</td>
35+
<td><kbd>Ctrl ⌃</kbd>+<kbd>Opt ⌥</kbd>+<kbd>click</kbd><br>
36+
or <strong>three-finger tap</strong> on trackpad
37+
</td>
38+
</tr>
39+
<tr>
40+
<td>Lock/unlock the mouse from the window</td>
41+
<td><kbd>Cmd ⌘</kbd>+<kbd>click</kbd></td>
42+
</tr>
43+
<tr>
44+
<td>Send a function key to the game</td>
45+
<td><kbd>Fn</kbd>+<kbd>F1–F12</kbd></td>
46+
</tr>
47+
<tr>
48+
<td>Toggle the <a href="#simulated-numpad">numeric keypad</a></td>
49+
<td><kbd>Cmd</kbd>+<kbd>U</kbd><br> or hold <kbd>Fn</kbd></td>
50+
</tr>
51+
<tr>
52+
<td>Switch to/from full screen mode</td>
53+
<td><kbd>Cmd ⌘</kbd>+<kbd>F</kbd></td>
54+
</tr>
55+
<tr>
56+
<td>Pause the game</td>
57+
<td><kbd>Cmd ⌘</kbd>+<kbd>P</kbd></td>
58+
</tr>
59+
<tr>
60+
<td>Fast-forward the game</td>
61+
<td>Hold <kbd>Cmd ⌘</kbd>+<kbd>Opt ⌥</kbd>+<kbd></kbd></td>
62+
</tr>
63+
<tr>
64+
<td>Take a screenshot</td>
65+
<td><kbd>Cmd ⌘</kbd>+<kbd>Shift ⇧</kbd>+<kbd>S</kbd></td>
66+
</tr>
67+
<tr>
68+
<td>Choose a different launch option</td>
69+
<td>Hold <kbd>Opt ⌥</kbd> while the game is starting up</td>
70+
</tr>
71+
</tbody>
72+
</table>
73+
</section>
74+
75+
<section>
76+
<a name="simulated-numpad"></a>
77+
<h2>Accessing numpad keys on a compact Mac keyboard</h2>
78+
79+
<p>If the game needs you to press a key on the numeric keypad, but your Mac’s keyboard doesn’t have one, then you can <strong>hold down <kbd>Fn</kbd> to make part of the keyboard act as a numpad:</strong></p>
80+
81+
<p>
82+
<img src="../images/numeric-keypad.png" class="fit-to-width" alt="While Fn is held down the 789, UIO and JKL keys act as the 9 numpad keys, the “M” and “,” keys act as 0 and period, the “.” key acts as Enter and the 6 key acts as Num Lock. The column of keys to the right of these acts as /, *, + and - on the numpad.">
83+
</p>
84+
85+
<p class="note">The 7-8-9 numpad keys match up to the same numbers on the regular keyboard: you can use this to orient your fingers to the simulated numpad.</p>
86+
87+
<p class="tip">If you don’t want to keep <kbd>Fn</kbd> held down to access the numpad, you can also <strong>turn the numpad behaviour on or off</strong> with the <span class="menu">Emulation ▸ Simulate numeric keypad</span> menu option. This will take effect until you toggle the option again.</p>
88+
</section>
89+
90+
<section>
91+
<a name="function-keys"></a>
92+
<h3>Accessing the function keys on a Mac keyboard</h3>
93+
94+
<p>Mac keyboards adopt the <kbd>F1</kbd><kbd>F12</kbd> keys as hotkeys to control volume, screen brightness and other system functions. To send those keys to the game instead, <strong>hold down <kbd>fn</kbd> when you press the function key.</strong></p>
95+
96+
<p class="tip">You can toggle this behaviour by turning on <strong class="ui-label">“Use all F1, F2 etc. keys as standard function keys”</strong> in OS&nbsp;X’s Keyboard Preferences.</p>
97+
</section>
98+
99+
<section>
100+
<a name="spaces-shortcuts"></a>
101+
<h3>Avoiding OS&nbsp;X’s own hotkeys</h3>
102+
103+
<p>Some OS&nbsp;X system hotkeys (like the <kbd>Ctrl ⌃</kbd>+<kbd></kbd>/<kbd></kbd> shortcuts to switch Spaces) may overlap with the game’s control scheme and get in the way when playing.</p>
104+
105+
<p>To avoid such problems, turn on <strong class="ui-label">“Enable access for assistive devices”</strong> in OS&nbsp;X’s Universal Access preferences. When this option is enabled, the game will disable any conflicting hotkeys while you’re playing.</p>
106+
</section>
107+
108+
<section>
109+
<a name="keyboard-layout"></a>
110+
<h3>Can’t find a key?</h3>
111+
112+
<p>DOS games were designed for PC keyboards, and sometimes require special keys (such as <kbd>Scroll Lock</kbd> or <kbd>Num Lock</kbd>) that aren’t present on your Mac’s keyboard.</p>
113+
114+
<p>If the game needs you to press a key that’s not on your Mac’s keyboard, you can send it from the <span class="menu">Emulation ▸ Send Key</span> menu instead.</p>
115+
</section>
116+
</body>
117+
</html>

0 commit comments

Comments
 (0)