Giter Club home page Giter Club logo

this-is-the-way's Introduction

This is the Way Game

THIS IS THE WAY

Team Livin' La Vida Yoda's Game entry for the May the Force be with you Code Institute Hackathon, May 2023.

'This Is The Way' is a one-player game for large screens (not currently available for mobile devices - Patience, my young Padawan!) You play Grogu from 'The Mandalorian', facing off against Jawas and collecting frogs before reuniting with The Mandalorian. Click 'Play Music' to get the full 'Mandalorian' experience!

GitHub last commit GitHub contributors GitHub language count GitHub top language


USER EXPERIENCE

User Stories

As a user I would like:

  • Clear and concise instructions for the game
  • To have consistent feedback on my progress throughout the game (e.g. lives remaining)
  • To be able to move Grogu intuitively through the map
  • A fun and original game experience with Mandalorian music and imagery
  • Functionality to turn the music on/off

Design

Colour Scheme

We took inspiration for our colour scheme from the planet Tatooine (specifically its iconic binary sunset!). Using Adobe Color we extracted a theme based on this image:

Movie still from the movie Star Wars IV: A New Hope

The following colours were selected:

  • #8C6175 Purple
  • #40342d Brown
  • #ef554b Orange
  • #a6695b Camel
  • #a66868 Dusty Pink

We cross referenced the colors using Eight Shapes to test the contrast and made sure we used readable combinations throughout the website.

Results from the Eight Shapes test

Typography

The Mandalorian font is well recognised for its distinctive strong angles and cutout of the Mandalorian in the character A.

We sourced the font Mandalore from dafonts and then converted the font to a WebFont Kit to allow the font to be used on our site using transfonter.

To make the heading 'pop' we have styled it using the text-shadow attribute in the css which gives the font a bit more depth, and also added text-stroke to provide an outline around the text.

Mandalore Font Preview

Space Mono is an original fixed-width type family designed by Colophon Foundry for Google Design. It supports a Latin Extended glyph set, enabling typesetting for English and other Western European languages.

'Monospace' is the back-up font for this site.

Imagery

Imagery used throughout the site is based on Star Wars and the Mandalorian.

Grogu appears in his floating crib in the game.

Grogu Sprite

As the game is based on the planet of Tattoine, the enemies chosen are the Jawa. (Alamite sprites were also created and may appear in future versions of the game)

Jawa Sprite Alamite Sprite

Grogu's health boost is his favourite snack - a frog.

Frog Sprite

The Mandalorian who appears at the end of the level.

Mandalorian Sprite

The background for the game was designed to reflect the inside of a sandcrawler vehicle.

Sandcrawler

Wireframes

Balsamiq was used to create our wireframes in the planning stage.

With Loading Screen

Without Loading Screen

FEATURES

The site is comprised of two pages, the index page and the 404 page.

Start Overlay

When the site is loaded the user will be shown the start overlay which gives the user the option of learning how to play, and a start button to start playing.

Start Overlay

Game Instructions

Game instructions

Game Won

Once the player has completed the game, a message is displayed to let them know they were successful!

Game completed

Game Lost

If the player loses the game, a message will be displayed to let them know the game is over.

Game over

Favicon

Our favicon is an image of Grogu and he is displayed within the browser tabs and bookmarks bar.

Favicon

TECHNOLOGIES USED

Languages Used

  • HTML
  • CSS
  • JavaScript

Frameworks, Libraries & Programs Used

DEPLOYMENT & DEVELOPMENT

Deployment

The site is deployed at GitHub Pages - This is the Way.

To Deploy the site using GitHub Pages:

  1. Login (or signup) to Github.
  2. Go to the repository for this project, kera-cudmore/this-is-the-way.
  3. Click the settings button.
  4. Select pages in the left hand navigation menu.
  5. From the source dropdown select main branch and press save.
  6. The site has now been deployed, please note that this process may take a few minutes before the site goes live.

Local Development

How To Fork & Clone

A wiki page was created on the repository with instructions on how to fork and clone the project. View Wiki Page Here

These instructions were slightly amended from the amazing instructions on the Hackathon Git Labs Project.

TESTING

Testing was ongoing throughout the entire build. We utilised Chrome developer tools whilst building to pinpoint and troubleshoot any issues as we went along.

During development we made use of google developer tools to ensure everything was working correctly and to assist with troubleshooting when things were not working as expected.

we utilised the console in the developer tools to work through small sections of JavaScript and ensure that the code was working, and also to troubleshoot where issues were.

W3C Validator

W3C was used to validate the HTML on all pages of the website. It was also used to validate the CSS.

JavaScript Validator

jshint was used to validate the JavaScript.

CREDITS

Media

Acknowledgements

Thank you to the Code Institute and their Hackteam for putting on these amazing events, and to our families who put up with us disappearing for a few days to code like mad!

Team Livin' La Vida Yoda

this-is-the-way's People

Contributors

christiangoran avatar jodymurray avatar kera-cudmore avatar modonohoe avatar sooryageorge7 avatar tlalexandre avatar

Stargazers

 avatar

Watchers

 avatar

this-is-the-way's Issues

Deploy Project

DOCUMENTATION NEEDED

  • Deployed using GitHub Pages - instructions on how to deploy
  • Link to live site to be added to the readme

Navbar/Progress bar

Design a navbar displaying the game's name and score/progress through game

User: View score and Progress

As a user, I want to be able to see my score and progress, so that I can track my achievements and aim to beat my high score.

Game music

Add simple game-style music as a user is playing the game, with an option to turn on or off

Game levels

Create game levels so players can progress in the game

Testing

Developer: Test thoroughly, so bugs and issues can be identified before submitting this project.

User: Responsive on every device

As a user, I want to be able to play the game on different devices, so that I can enjoy the game wherever and whenever I want.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.