Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 2.52 KB

README.md

File metadata and controls

28 lines (16 loc) · 2.52 KB

The Flying Cube Game! 🟥💨

Hi!

This project is intended to help introduce you to Open Source as part of MLH 2023 Global Hack Week: GAMES! It's a JavaScript-based 3D game built with Babylon.JS that lets you fly a Cube through a set of obstacles.

When you create a repository from this template, a series of Issues will be generated that you can pick up to get started.

The entire project can be run by opening game/index.html in a browser. All of the 3rd party dependencies like Babylon are using a CDN so you do not need Node or a local developer environment.

🧙‍ New Open Sourcerers

If you're new to GitHub you can get started by creating a new repository by clicking Use this template and then selecting Create a new repository to create a copy of this repository into your own GitHub account. This is where you can make your own changes!

The green button used to create a new repository from this template

If you want to keep learning about GitHub you can check out GitHub Skills.

If you're new to Babylon JS that's fine too! Here are some helpful links to help you get started. Babylon runs in your browser and this game should work on your Phone, Tablet or PC - you can make and test your changes from any of those devices! If something doesn't work you can enter the developer mode of your browser (F12 on Edge or Chrome) and explore the errors in the console. This developer mode also lets you insert breakpoints if you want to debug further.

  • The Babylon.JS Playground will let you explore different community samples to learn how Babylon works!
  • The Babylon.JS API has documentation that can help you understand the API.

We've also provided a file that should support launching from VS Code that will allow you to integrate your debugging experience there as well as a devcontainer you can use to develop in if you choose with some recommended extensions pre-installed.

This project is intended as a sandbox for you to learn about GitHub and contributing to Open Source.

Acknowledgements

All the code in this repo was written by Sam Wronski.