Mega Render Engine

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Resources
7. License
8. Contact

About The Project

Mega is a WebGPU based (targeting DAWN/WGPU and the web via Emscripten) render engine.

🔝

Built With

🔝

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them. The foolowing examples pertains to installing the required dependencies on MacOS.

CMake

# Make sure to install XCode via the App store first
xcode-select --install && \
brew install cmake

Installation

1. Clone the repo

git clone https://github.com/suny-am/mega.git && \
cd mega

2. Build the project

navigate to the project directory of your choice

# Working Directory Example
cd 1.getting_started/hello_webgpu

Then choose one of three compile options:

WGPU-Native

cmake -B build-wgpu -DWEBGPU_BACKEND=WGPU
cmake --build build-wgpu

Dawn

cmake -B build-dawn -DWEBGPU_BACKEND=DAWN
cmake --build build-dawn

Emscripten

emcmake cmake -B build-emscripten
cmake --build build-emscripten

🔝

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project

gh repo fork suny-am/mega --clone
cd mega

2. Create your Feature Branch

git checkout -b feature/aNewCoolFeature

3. Commit your Changes

`git commit -m 'Add a new cool feature'

4. Push to the Branch

git push origin feature/aNewCoolFeature

5. Open a Pull Request

gh pr create 

🔝

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

TBD

🔝

Roadmap

• File parsing
  • native file dialog
  • Load .gltf/glb
  • Load .obj into gltf format
  • TBD (🚧)
• Dynamics
  • World color
• Shaders
  • BRDF
  • TBD (🚧)
• UI
  • Dear ImGui integration
  • ImGuizmo integration
  • TBD (🚧)
• Camera control
  • Orbit (turntable)
  • Zoom
  • Pan
  • TBD (🚧)
• TBD (🚧)

🔝

Resources

References

• W3C WebGPU Reference
• W3C WGSL Reference

Assets

• Khronos Group glTF sample assets

textures

• cobblestone_floor_08_diff_2k.jpg
• cobblestone_floor_08_nor_gl_2k.png

models

• plane.obj
• cylinder.obj
• fourareen.zip (Scottish Maritim Museum assets)

shaders

License

Distributed under the MIT License. See LICENCE.txt for more information.

🔝

Contact

Your Name - @sunyam.bsky.social - [email protected]

Project Link: https://github.com/suny-am/mega

🔝