https://github.com/scanmountgoat/ssbh_wgpu
Smash Ultimate WGPU model renderer
https://github.com/scanmountgoat/ssbh_wgpu
smash-bros smash-ultimate
Last synced: 8 months ago
JSON representation
Smash Ultimate WGPU model renderer
- Host: GitHub
- URL: https://github.com/scanmountgoat/ssbh_wgpu
- Owner: ScanMountGoat
- License: mit
- Created: 2022-02-20T02:36:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T21:28:03.000Z (over 1 year ago)
- Last Synced: 2024-12-20T22:26:02.163Z (over 1 year ago)
- Topics: smash-bros, smash-ultimate
- Language: Rust
- Homepage:
- Size: 2.01 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ssbh_wgpu
ssbh_wgpu is a lightweight and portable Smash Ultimate model and texture renderer built using [WGPU](https://github.com/gfx-rs/wgpu).
## Usage
Add the following lines to the `Cargo.toml`. This library is still highly experimental. Specify the commit tag or commit the `Cargo.lock` file to version control to avoid any versioning issues. For an example of an application using this renderer, see [ssbh_editor](https://github.com/ScanMountGoat/ssbh_editor).
```
ssbh_wgpu = { git = "https://github.com/ScanMountGoat/ssbh_wgpu", rev = "hash" }
nutexb_wgpu = { git = "https://github.com/ScanMountGoat/ssbh_wgpu", rev = "hash" }
```
## Overview
- nutexb_wgpu -- texture renderer and library for converting nutexb files to WGPU textures
- nutexb_wgpu_viewer -- simple winit application for viewing nutexb textures
- ssbh_wgpu -- model and animation rendering library. Converts ssbh_data types to WGPU types.
- ssbh_wgpu_test -- windowless program for testing model loading
- ssbh_wgpu_viewer -- simple winit application for viewing models and animations
## Building
With a recent verison of the Rust toolchain installed, run `cargo build --release`. Don't forget the `--release` since debug builds have very low framerates!
## Development
Implementations are based on data from testing the output of the emulators Yuzu and [Ryujinx](https://ryujinx.org/) using the [RenderDoc](https://renderdoc.org/) debugger. Most testing is done by running a modified build of Ryujinx running OpenGL on the latest version of RenderDoc. The modified build comments out usages of functions not supported by RenderDoc like `GL.AlphaFunc` to fix compatibility issues preventing captures. The OpenGL API can have worse performance than Vulkan but allows for editing shaders in RenderDoc. The shaders use the same format as the decompiled shaders found in [Smush-Material-Research](https://github.com/ScanMountGoat/Smush-Material-Research). Converting the memory layout of Switch textures to a usable layout is handled by [tegra_swizzle](https://github.com/ScanMountGoat/tegra_swizzle), which was also tested using RenderDoc and Ryujinx. Although the WGPU library is more similar to Vulkan or DX12 in terms of design, mapping OpenGL calls in RenderDoc to WGPU is generally straightforward. This approach also avoids the need to reverse engineer any graphis APIs specific to the Switch hardware. Creating a perfect 1:1 recreation of the Smash Ultimate rendering engine is not a goal of this project, so debugging the emulators primarily serves as a way to validate parts of this implementation and debug any relevant differences with in game rendering.
When submitting code, run `cargo fmt` for Rust files and format using [wgsl_analyzer](https://github.com/wgsl-analyzer/wgsl-analyzer) for WGSL files.
## Credits
ssbh_wgpu is a continuation of the rendering work done for [CrossMod](https://github.com/Ploaj/SSBHLib).
File formats are handled by [ssbh_data](https://github.com/ultimate-research/ssbh_lib), [nutexb](https://github.com/jam1garner/nutexb), and [prc-rs](https://github.com/ultimate-research/prc-rs).