Skip to content

Commit 4755882

Browse files
committed
Update Readme + remove obsolete npm scripts
1 parent 41ddc31 commit 4755882

File tree

5 files changed

+28
-36
lines changed

5 files changed

+28
-36
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
node_modules
22
dist
3-
.idea
3+
.idea
4+
5+
# Ignore Mac files
6+
.DS_Store

InputControl.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# Input Control
2+
<img src="media/manual.png" data-canonical-src="media/manual.png" width="400" height="500" />
23

34
This page contains detailed instructions about the game input control and key mappings.
45
If you like to use game pads or other types of game controllers, please check the corresponding sections below.
56

6-
# Mouse Input
7+
## Mouse Input
78

89
Some levels (WhackABug and PlopARobot) can be played with mouse and keyboard input.
910
Mouse move and click events are triggering the same events as keyboard input.
1011

11-
Uncontrollable and UncontrollableMultiplayer are keyboard-only levels.
12+
The levels Uncontrollable and UncontrollableMultiplayer are keyboard-only levels.
1213

13-
# Keyboard Input
14+
15+
## Keyboard Input
1416

1517
The keyboard setup is a basic game configuration for two players using one shared keyboard.
1618
Player 1 uses WASD and Player 2 uses the ARROW keys to move. Action buttons are configured close to the movement keys for maximum convenience.
@@ -37,7 +39,7 @@ When Game Pads or arcade controllers are used, the input can be mapped to the co
3739
|Player 1/2 start|ESC|Reset|
3840
|Player 1/2 select|3|Switch Game Mode|
3941

40-
# Game Pad Controllers (2 Player Game Lounge Setup)
42+
## Game Pad Controllers (2 Player Game Lounge Setup)
4143

4244
![Game Pad](media/GamePad.jpg)
4345

@@ -56,7 +58,7 @@ When Game Pads or arcade controllers are used, the input can be mapped to the co
5658
> Note: JoyToKey is a shareware and license key (price = $7.00 USD) needs to be purchased for continued use.
5759
5860

59-
# Using an IPAC Arcade Controller (Custom Mame Controller Setup)
61+
## Using an IPAC Arcade Controller (Custom Mame Controller Setup)
6062

6163
![Game Pad](media/ArcadeBoard.jpg)
6264

README.md

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<p align="center"><img src="media/header.jpg" width="300" height="200" /></p>
2+
13
# Flush! Defeat the Evil Render Manager
24

35
An innovative and fun game combining [OpenUI5](https://github.com/SAP/openui5) and [CreateJS](https://createjs.com/) to showcase real-time and interaction capabilities of UI5 technology. Browse the source code to look behind the scenes or play the game to see Flush! in action.
@@ -6,23 +8,7 @@ An innovative and fun game combining [OpenUI5](https://github.com/SAP/openui5) a
68

79
## How to Play
810

9-
![Flush! Manual](media/manual.png)
10-
11-
> **Note:** Follow the in-game instructions or check the [input control](InputControl.md) page for more details. Flush! can also be played with game pads or custom game controllers.
12-
13-
## Requirements
14-
15-
The [git client](https://git-scm.com/) and [Node.js](https://nodejs.org/) must be installed.
16-
17-
## Download and Installation
18-
19-
To run a local instance of the game, follow these simple setup steps:
20-
21-
1. Clone this repository
22-
23-
2. Install npm dependencies with `npm install`
24-
25-
3. Run the game with `npm start`
11+
Follow the in-game instructions or check the [input control](InputControl.md) page for more details. Flush! can also be played with game pads or custom game controllers.
2612

2713
## Background Information
2814

@@ -36,28 +22,32 @@ Flush! is an innovation project that brings together Web app capabilities of Ope
3622

3723
We leverage the enterprise-grade UI5 technology with custom controls, custom theming, sprite effects, game mechanics, and scripted levels to create a unique browser game.
3824

39-
## Support
25+
## How to support & contribute
26+
To report a bug, please open an issue and we also welcome your contributions. Please get in touch with us in the [#flush](https://openui5.slack.com/messages/CHV1YCNG6) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
27+
28+
### Download and Installation
29+
**Requirements**: NodeJS
30+
31+
To run a local instance of the game, follow these simple setup steps:
4032

41-
To report a bug, please open an issue.
33+
1. Clone this repository
4234

43-
## Contributing
35+
2. Install npm dependencies with `npm install`
4436

45-
We welcome your contributions. Please get in touch with us in the [#flush](https://openui5.slack.com/messages/CHV1YCNG6) channel of the [OpenUI5 Community Slack](https://ui5-slack-invite.cfapps.eu10.hana.ondemand.com/).
37+
3. Run the game with `npm start`
4638

47-
## Thirdparty
39+
### Thirdparty
4840

4941
The following media assets and thirdparty libraries were used in this project:
5042

5143
* [Credits and Attribution for sounds used in the game](SoundCredits.md)
5244
* [List of thirdparty libraries and recommended sofware](Thirdparty.md)
5345

54-
## License
46+
### License
5547

5648
Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
5749
This file is licensed under the Apache Software License, v.2 except as noted otherwise in the [LICENSE](/LICENSE) file.
5850

5951
Have fun playing the game!
6052

61-
**The Flush! Team**
62-
63-
53+
**The Flush! Team**

media/header.jpg

160 KB
Loading

package.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@
44
"description": "Flush! Defeat the evil Render Manager",
55
"private": true,
66
"scripts": {
7-
"start": "ui5 serve --open index.html",
8-
"dev": "ui5 serve --open index_local.html",
9-
"start-mac": "open http://localhost:8081/index.html & ui5 serve",
10-
"dev-mac": "open http://localhost:8081/index_local.html & ui5 serve"
7+
"start": "ui5 serve --open index.html"
118
},
129
"dependencies": {
1310
"@openui5/sap.m": "^1",

0 commit comments

Comments
 (0)