Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.96 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.96 KB

Cosmic Junk Collector

What and Why

Cosmic Junk Collector is a browser game in which you and teammates compete against another team live over the internet to collect as many pieces of space junk around the earth as you can in 2 minutes. Use the game's GUI to form a team and select another to battle.

Space junk, also known as space debris, is any form of rubbish in orbit around the earth. Most of it is disused satellites, or spent rocket pieces. Every year, more space junk ends up there, and it's a problem, because any contact with orbiting material is devastating for rockets or space stations.

Libraries used

  • Project developed in Node.JS
  • Express.JS (used for web routing + compression)
  • UglifyJS (for minification)
  • Gulp
  • Browserify
  • Socket.io (realtime server-client communication, mainly used for position data)
  • Three.JS (used for client side 3D rendering)
  • Jquery (for DOM manipulation)
  • MongoJS (for updating DB, used for authentication + leaderboard data)

How to install

Install Node.js (with NPM). Have a MongoDB instance available somewhere. Clone the repo and change directory into it. Then:

npm install

Add your credentials for Mongo into .env, and install foreman so you can use it:

echo "DBURL=mongo://user:password@your-mongo.server" > .env
npm install -g foreman

Then run:

nf run npm start

https://docs.google.com/presentation/d/1NXdO59YCm2fi478ZhVOWfD6-Db5Wo0w5IAcwWDRq328/edit?usp=sharing

Links

https://docs.google.com/presentation/d/1NXdO59YCm2fi478ZhVOWfD6-Db5Wo0w5IAcwWDRq328/edit?usp=sharing

Public Access

Limited Access