CubeSurfer

Welcome to CubeSurfer, a beginner-friendly project to dive into game development with Unity! Whether you're new to game dev or looking to sharpen your skills, CubeSurfer offers a fun and interactive way to learn while contributing to OpenCode 2024.

📚 Table of Contents

• Summary
• Features
• Setup Guide
• Development Guidelines
• Reference Links
• Directory Structure
• Contribution Guidelines
• Communication
• Mentor

📝 Summary

CubeSurfer is a basic game-dev repo where you will enter into the world of game dev using Unity and C#. This repo is based on the legendary tutorial series (in the gamedev community) by Brackeys, find it here. If you have any doubt or confusion of what we will be making refer this anytime.

Tip

Brakeys tutorial series on which this repo is based, playlist.

🌐 Features

• Interactive Gameplay: Develop and play an engaging game featuring cubes and obstacles. (yes, its this only and this easy 💀)
• Hands-On Unity Learning: Learn Unity scripting (C#), asset management, game physics, materials and basic lighting setup.
• Open Source Collaboration: Contribute, review, and improve the game.

🛠️ Setup Guide

1. Fork this repository to your GitHub account.

2. Clone the forked repository:

   git clone <forked-repo-link>

3. Open the project in Unity 3D (recommended version: Unity 6 (LTS)).

   Note: Open the Project Folder as a folder in Unity Hub. If asked about any version change warning, just simply open it, might happen as right now this project is in Unity 6000.23f, and later minor changes might happen.

   This is a Unity3D project, install the Unity3D engine, visit here, download and install Unity Hub, then download and install the engine version Unity 6000.

4. After opening an untitled scene will open, ignore that and navigate to the First level scene in the Project Window below, Goto Project Folder --> Assets --> Scenes --> First Level. This is where all the scene will be saved.

5. Explore the issue and the project folder and start contributing!

Note

Your main code and working will be in the Assets folder.

Caution

DO NOT modify any of the settings outside the Assets folder until told, as it might break the project!

⚡ Development Guidelines

• Hierarchy: Maintain a proper hierarchy in Unity scenes.
• Assets: Store assets in appropriate folders (e.g., Scripts, Prefabs, Materials).
• Coding Standards: Follow standard Unity coding practices and ensure clean, readable code.

Caution

Failure to follow any of these might result in a tempban!

Tip

Facing some difficulties Refer here to clarify your doubts.

🔗 Reference Links

• Unity Scripting API
• Unity Learn
• YouTube - Brackeys

📁 Directory Structure

.
├─ 📁 Project Folder
│   ├── 📁 Assets
│   │   ├── 📁 Scripts
│   │   ├── 📁 Prefabs
│   │   ├── 📁 Materials
│   │   ├── 📁 Scenes
│   │   └── 📁 ...
│   ├── 📁 ProjectSettings
│   ├── 📁 Packages
│   └── 📁 ...
└── 📄 README.md

👆 Contribution Guidelines

1. Claim an issue in the repository before starting work.
2. Keep your code and folder structure organized.
3. Comment your code for better readability.
4. Use meaningful commit messages and include screenshots or videos for clarity.

Note

Inactive claims after 2 days may be reassigned.

💻 Communication

Stay connected on our Discord channel for updates and discussions with mentors and contributors or to ask any doubt needed. Make sure to use suitable channels according to your repo in the server.

🤝 Mentor

1. Bhavya Gupta (aka Gamin8ing)
   Game dev and an all-time gamer
   GitHub: Gamin8ing
   Discord: gamin8ing (or blackHole)
2. Srijan Suryansh Github: Lordlyamigo Discord: Lordlyamiga

Let’s build something amazing together with CubeSurfer! 🚀