Hi!
This project is intended to help introduce you to open source! It's a javascript based 3D game built with Babylon.JS that lets you fly a Cube through a set of obstacles.
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. You can always play the current version of the game at flying-cube-game.netlify.app and if you create PR's against the project you'll be able to play your changes using a special link.
New PR's are welcome and we've created a series of Issues you can pick up to get started. We're always looking for new Greetings in the game (shown under the game title on the main menu) and you're welcome to contribute your own - there's more info about that in Issue #25: Add More Greetings.
If you're new to contributing you can get started by forking this repository into your own GitHub account or clicking the edit (pencil ✏️) button next to the file you want to change. Make the changes in your own repository and test them, then submit a Pull Request and link the issue you are contributing towards.
If you would like to submit a new feature or fix a bug that isn't listed consider Submitting an Issue first so we can track the change!
If you're new to Babylon JS that's fine to! Here are some helpful links to help you get started and remember you can always test your changes in your own branch or in the Pull Request first. 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. We're accepting most changes in support of that!