README.md

Planet Funk

(In Progress) A just for fun, if "Toejam & Earl" and "Mission Command" had a baby, planet defense game.

---

Intro

Planet Funk is under attack by the Federation of Tone Deaf Worlds. Their leader, Emperor Monotonous IV, in a fit of jealousy, had ordered the total annhilation of your rhythym-loving people.

Seeing as you were the Funkiest of them all, your people have united their ability to jam and chose you to focus their bodacious talents in defense of all that is groovy.

---

Instructions

Touching screen, or clicking the left mouse button on play area will fire nearest working defensive weapon at the place of touch/click

Touching screen, or clicking the left mouse button on Planet Funk will erect a temporary force field of protection if both A) one isn't already up, and B) there is enough energy in reserve. If energy is out, nothing happens. If barrier is already up, it will deactivate the barrier.

Time recharges energy for both defensive weapons and barriers.

Weapons that have been struck are rendered inactive and useless.

Fewer active weapons allows the remaining weapons to charge faster.

Fewer unscathed populated areas on the planet means slower planet shield recharge rate.

---

Endgame

When the planet has lost all four of its populated quadrants, GAME OVER.

Score is determined by a timer, and destroyed enemy units. Every second alive adds a point to total score.

Every 100,000 points will revive a damaged weapon. If all weapons are undamaged, a decimated populated area is rebuilt. If all weapons and populated areas are intact, then it's just points.

---

Classes

Detailed documentation

---

First Steps

1. Navigate to the root folder where you want your project to reside.

2. Run git clone https://github.com/WilliamRADFunk/planet-funk.git.

3. Run npm install. If failure, see Common Gotchas section below.

4. Run npm run start and then simply navigate to http://localhost:8080 in your browser.

---

New to Gulp

-- Make sure to install Gulp at the global level, as this is a necessary step to make the boilerplate's scripts run.

npm install -g gulp

---

Common Gotchas

--Might get a failure to fully install when running npm install

Try running npm install --ignore-scripts

-- Might get the error
"Error: ENOENT: no such file or directory, scandir 'your-path/small-project-boilerplate\node_modules\node-sass\vendor'"

To remedy this, simply run npm rebuild node-sass

-- If you're running the npm run readme command, and your classes are not all present.

Make sure you aren't importing a capitalized version of the name (ie. import { Doug } from './Doug' when it should in fact be import { Doug } from './doug') assuming of course you've name the file with standard camelCase.

Index

External modules

• "index"
• "ts/asteroids/asteroid"
• "ts/asteroids/asteroid-generator"
• "ts/collidable"
• "ts/collisionator"
• "ts/controls/control-exit"
• "ts/controls/control-help"
• "ts/controls/control-mute"
• "ts/controls/control-panel"
• "ts/controls/control-pause"
• "ts/controls/control-play"
• "ts/controls/control-save"
• "ts/controls/control-sound"
• "ts/displays/help-handler"
• "ts/displays/level-handler"
• "ts/displays/load-handler"
• "ts/displays/menu"
• "ts/displays/save-handler"
• "ts/displays/score-handler"
• "ts/enemies/enemy-missile-generator"
• "ts/enemies/saucer"
• "ts/enemies/saucer-generator"
• "ts/init"
• "ts/models/game-load-data"
• "ts/player/base"
• "ts/player/planet"
• "ts/player/satellite"
• "ts/player/shield"
• "ts/sound"
• "ts/soundinator"
• "ts/utils/check-color-brightness"
• "ts/utils/convert-to-hex"
• "ts/utils/convert-to-int"
• "ts/utils/create-save-code"
• "ts/utils/decipher-save-code"
• "ts/weapons/drone"
• "ts/weapons/explosion"
• "ts/weapons/projectile"

---