Skip to content

Latest commit

 

History

History
57 lines (47 loc) · 2.47 KB

Manual.org

File metadata and controls

57 lines (47 loc) · 2.47 KB

User and Deployment Manual

Welcome to the Jungle

A JavaScript pixel art RPG

Group 7

  • Max Ornik
  • Marcel Sziener
  • Skyler Mayfield

Deployment

  1. Clone the repository
    • $ git clone https://github.com/skyler544/it-project
  2. Navigate to the repository application directory with your shell or file browser.
    • $ cd it-project/SourceCode
  3. Open index.html with the web browser of your choice
    • $ firefox index.html

Usage

  1. Play the game! Controls:
    • w, a, s, d or arrow keys for movement
    • enter to attack

    Combat controls:

    • Combat automatically begins when you encounter a monster; use the menu to select your action. Try not to die!

    Use doors to move between levels.

Motivation

As gamers ourselves, we were inspired by pixel art aesthetics and fond memories of playing pixel art games. Furthermore, since JavaScript is a very widely used language, we considered that making a large project in JavaScript would be a great way to sharpen our skills.

Technology Used

JavaScript (obviously)

Some of the code makes use of jQuery as well.

Git

Using git effectively is a hard requirement of collaborative development. Version control not only makes developing code safer, it provides a form of documentation as well. Writing a commit message to explain what one did and why is an important consideration when working with others, especially if what the code does is not immediately obvious to everyone involved. Plus it’s fun!

Trello

Having this project planning tool made keeping track of what exactly we were doing and how we wanted to do it much easier.

Discord

As a communications platform, Discord is hard to beat when it comes to staying connected and keeping each other in the loop.

Google Drive

Realtime collaborative editing.

Emacs Org-Mode

Writing documentation and planning deadlines, org-mode does it all.

Project Status

The game “engine” is finished. Everything needed to make the game possible is there. However, the project is still in what we would call “alpha.” There’s enough to show that the game works, but it needs more levels and variety. The framework can easily be expanded to make this happen.


A note about this document

Both the Open Document and Latex versions of the document were generated using the free and open source tool pandoc.