Git Product home page Git Product logo

ballhalla's Introduction

Ballhalla!

A casual free-for-all king of the hill game with an easy learning curve and no sign up required.

Team

  • Product Owner: David Berry
  • Scrum Master: Sean Brock
  • Developers: James Quillin, Juancarlos Jauregui

Table of Contents

  1. Usage
  2. Tools
    1. Installing Dependencies
    2. Running Locally
  3. Workflow
    1. File Structure

Usage

Just visit the website, enter a nickname or optionally sign in, and click Play!

Tools

  • Node.js
  • Socket.io
  • PlayCanvas
  • Redis
  • Mocha
  • Travis CI

Installing Dependencies

From within the root directory:

npm install

Running Locally

Create a .env file to hold the information for the Redis database. Make sure that the Network.js file points to your localhost, and then start server.js with node or equivalent program.

Workflow

Fork main PlayCanvas project to your own PlayCanvas profile. Develop features in the PlayCanvas editor. Export and download current fork and replace the contents of the public folder with teh exported download. You can then run the project locally by pointint Network.js to your localhost and opening mulitple tabs. From there you may make pull requests to the main repo on GitHub, from which the code will be deployed to Heroku, and optionally uploaded to the main PlayCanvas project.

Run npm test to unit test scripts. When committing and making a pull request to the main repo on GitHub, Travis CI will run the test suite.

File Structure

Exporting from playcanvas packages each asset within an individually assigned file with associated individual numeric identifiers such as ex-> 8668841/1/ - these numbers will be reassigned on individuals forked projects within playcanvas, so some initial navigation will be required to build familiarity within public/files/assets/...

Within the playcanvas editor, these numeric identifiers are abstracted, and much of your work will take place within the playcanvas editor.

Below are some of the most important commonly used file locations.

  • Network.js - public/files/assets/8668841/... - this file sets up our socket.io

  • collider.js - public/files/assets/8668838/... - this file sets up our player collisions

  • teleportable.js - public/files/assets/8668839/... - this file puts players in the right spot on update

  • start-screen.js - public/files/assets/8658762/... - this creates a new player

  • movement.js - public/files/assets/8668840/... - this defines movevment of player and tracks other players

ballhalla's People

Contributors

daberry avatar jamesquillin avatar seanbrock avatar jauregui3 avatar

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.