Skip to content

Latest commit

 

History

History
145 lines (113 loc) · 5.57 KB

README.md

File metadata and controls

145 lines (113 loc) · 5.57 KB
Raw

Link To The Repository

https://github.com/michellelynne/LTC_game_jam

Our Slack

https://learnteachcode.org/slack
#game-dev channel

Phaser JS!

https://phaser.io

How to install the game

  • Install git
    • Here's an installion guide for git
  • Install github (optional)
    • Here's a link to installing the desktop version of github
  • Install nodeJs
  • Inside commandline navigate to "eansPhaserBoilerPlate" folder
    • This should be achieved by entering cd eanPhaserBoilerPlate
  • In command line run npm install
    • Our backend uses nodejs so this will install the resources our projects needs to run independently

How to run the game

  • Inside commandline navigate to "eansPhaserBoilerPlate" folder (if you're not already there)
    • This should be achieved by entering cd eanPhaserBoilerPlate
  • In command line run npm start
    • This script actually starts up our server (which means our game is running)
  • Open up a web browser and go to this address http://localhost:7777
    • http://127.0.0.1:7777 also works because these are representations of the "home" address
  • From here you'll be able to play the game!

Latest stable build of the game that's playable:

        https://websitename.io

Naming Convention

  • camel casing
    • applies to coding, files, and folders
    • example: var name = "eanCharacter"
  • no capitalizing 1st letters

Basic Source Control (using git)

  • When submitting a change ALWAYS commit then pull, before you push!
    • git add -A (tracks files and adds them to staging)
    • git commit -m "adding my file msg" (timestamps your changes and comments to the repository)
    • git pull origin master (pulls latest changes from repository)
    • git push origin master (pushes your updated changes to repository for other people to pull)
    • Sometimes a push or pull may result in a merge conflict, when this happens just make resolve to the conflict by adjusting files to their correct version manually.

Asset Pipeline

Pipeline

  • Adding Game States

    • Create new javascript file in javascript directory.
    • Declare state name inside of a new js file.
      • var gameState = {};
    • Go to index.html and add it to the script BEFORE stateManager.
      • <script type="text/javascript" src="javascript/gameState.js"></script>
      • <script type="text/javascript" src="javascript/stateManager.js"></script>
    • Inside the stateManager add the state
      • game.state.add("gameStateKey",gameState);
    • To access use game.state.start from any point in the game
      • game.state.start("gameStateKey");

  • Deploying

    • Bump the build number in buildVersion.txt
      • Build number convention is Version.Major.Minor Example: 1.5.11

Config Information

  • settings.js
    • stage contains default width and height parameters of game

Hosts

Current Project Roles

Init Logic

  • Ean
  • Init Logic creates the game itself, and ensures that all dependencies exist.

Boot Logic

  • Hong

  • Ean
  • Boot Logic Dictates how we start the game and the context in which we start the game.

Loader Logic

  • Ean
  • Loader Logic is decides how and when we manage the including of resources in the game

Game Start Logic

  • Kiron
  • Game Start Logic determines how we start the game (a main menu for example) and should ideally only happen once

Game Loop

  • Arthur, Jansen, Ean, Eric, Hong
  • Game Loop is where movement, physics, game play logic, etc is implemented

Game Over Logic

  • Michael, Jydon
  • This logic occurs when the game loop has ended

Finite State Machine

  • Julie, Roman
  • FSMs control the transitions, initation, and referencing of various game states.