Pew-Pew

Table of Contents

• Pew-Pew
  • Table of Contents
  • Description
  • Play Game
    • Links
    • Controls
  • Development
    • Docs
    • Gulp Commands
    • Size
  • Build From Source
  • Contributing
    • Workflow
    • Code Style (JavaScript)
  • Changelog
  • License

Description

Meet Koko! Your average girl with the power to make a barrier around her and absorb bullet's energy when it hits the barrier. She can also use the adsorbed energy to fire back at the enemies.

Play Game

Links

• Web (Hosted in GitHub pages).
• Download zip of the latest release.
• Build from source.

Controls

Button	Description
Space	Start / Play Again
Arrow Keys	Movement
z	Barrier
x	Pew

Development

Docs

Click here to see docs.

Gulp Commands

• gulp watch
  1. Watch files for changes.
  2. Shows lint errors and builds on change.
• gulp lint
  1. Shows lint errors.
• gulp jsLintNoConcat
  1. Shows JS lint errors without minifying and concatenating code.
• gulp build
  1. Shows HTML, CSS and JS lint errors.
  2. Build will fail if there are any JS lint errors.
  3. Minifies the code and images from src directory.
  4. Concat files after minification.
  5. Puts the output files in build directory.
  6. Zips build directory and puts the zip in zip directory.
  7. Generates docs to build/docs/.

Size

This game was originally developed as a prototype for Js13kGames.

Js13kGames is a JavaScript coding competition for HTML5 Game Developers. The fun part of the competition is the file size limit set to 13 kilobytes.

So make sure the zip size is below 13 kilobytes. The gulp build command will show warning when zip size exceeds 13 kilobytes.

Build From Source

Install Node.js and git then run the following commands:

git clone https://github.com/FR0ST1N/Pew-Pew.git
cd Pew-Pew
npm install
npx gulp build

• Open build/index.html and play.
• Zipped game can be found in zip directory.

Contributing

Workflow

1. Fork the repo.
2. Create a branch (use develop as parent).
3. Make changes.
4. Submit a pull request.

Open an issue if you want to discuss something and check for lint errors before making a pull request.

Code Style (JavaScript)

Follow Google JavaScript Style Guide.

Changelog

See CHANGELOG.md.

License

• All Code is licensed under GPL-3.0-or-later.
• Images are licensed under CC-BY-SA-4.0.