Skip to content

folaakingbe/cryptoGolf

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

crytoGolf

Project Description

This project represents a group effort to create a physics-based golf game, with a twist:
the terrain is generated based on the ups and downs of the cryptocurrency market.

The project was conceived and organized by Chandler Dibble;
it was developed by a four-person team over one week.
The total time spent developing our project, including time spent learning new tools, is estimated at 120+ hours.

We primarily utilized Javascript with Node, JQuery, Matter.js, and Express.js.
HTML and CSS were deliberately de-emphasized to allow us to generate our images, shapes, etc. with Javascript.
This is reflected in contributors' roles all including "back-end" work.
Bitfinex's API was utilized to provide our cryptocurrency exchange data, with which we generated our terrain.
Heroku was also utilized for the first time by group members, as previous projects were hosted solely on Github Pages.
Significant time was devoted to learning Matter.js.

Internally, we needed to generate a basic world and physics-based parameters for our game.
Objects such as a golf ball were created and assigned values to allow their proper interaction.
Functions were written to generate our objects, cause them to interact, and influence the manner in which they interacted.
The Bitfinex API was called in order to generate the ground on which golf was played.
Each project member spent time learning how to implement Matter.js.
Expertise on cryptocurrencies was provided by Tim Hill.

Our project is hosted through Github Pages at: https://xhandler.github.io/cryptoGolf/,
and through Heroku at: https://guarded-fortress-57011.herokuapp.com/

Contributors

Afolabi Akingbe - math MVP/genius; research, back-end;
Github: https://github.com/folaakingbe
Chandler Dibble- project lead/organizer; research, back-end/front-end;
Github: https://github.com/Xhandler
Tim Hill - lead on wireframe and user-flow; crypto expert; research, back-end;
Github: https://github.com/peakcodes
Daniel Mace - project historian/note-taker; research, back-end/front-end;
Github: https://github.com/Daniibooii

How to Use

The user will need to clone a copy of our repo.
Then, he or she should open the index.html file in a browser of their choice.
The user will then play through a game of golf, with a few twists.

To start, the user will select their favorite cryptocurrencies.
This will generate the ground on which the game is played;
it might help to pray for a stable day in the crypto markets!
Then, a ball will generate for the user to hit.
From here, just aim for the hole, and swing away!

Notes

Our initial project idea was gito create a Rube Goldberg game;
it became apparent that this wouldn't be viable within the timeframe we allotted ourselves.

To view our original work, please see: https://github.com/Xhandler/rubegoldberg
Future work on rubegoldberg, collaborative or independent, is possible.

Inspirations

Desert Golfing served as our initial inspiration;
the idea of combining this with cryptocurrency was provided by Tim Hill.

Resources

Project Group's One Drive: https://onedrive.live.com/view.aspx?resid=A24E366977AFCFDC!951&app=OneNote&authkey=!ALdVeX0u2AWWcC0
Matter.js Package: https://www.npmjs.com/package/matter-js
Matter.js Info/Tutorials: http://brm.io/matter-js/
Express.js Package: https://www.npmjs.com/package/express
Express.js Info/Tutorials: https://expressjs.com/
Heroku Deployment Guide: https://github.com/nielsenjared/node-express-heroku-deployment

Desert Golf: http://desertgolfing.captain-games.com/
Many Golf Main Site: https://manygolf.club/
Many Golf Repo: https://github.com/thomasboyt/manygolf
Bitfinex Main Site: https://www.bitfinex.com/

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 50.5%
  • JavaScript 45.6%
  • CSS 3.9%