rsaber_lib 0.4.0

rsaber
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

# rsaber: Beat Saber clone written in Rust

## State

We are really at the beginning. At least, the colored notes are already moving and there is a basic collision detection logic :).
As there are no built-in levels, they are fetched from https://beatsaver.com/.

Screenshots

<img src="doc/menu1.jpg" width="300" height="163">
<img src="doc/menu2.jpg" width="300" height="163">
<img src="doc/game1.jpg" width="300" height="163">
<img src="doc/game2.jpg" width="300" height="163">

## Supported Devices

| Subdirectory | Tested devices                                                                                                  |
|--------------|-----------------------------------------------------------------------------------------------------------------|
| android      | Meta Quest 2                                                                                                    |
| pc           | Windows (runs in a window, useful for debugging)                                                                |
| pcvr         | OpenXR (SteamVR): [Sony PlayStation VR2](https://www.playstation.com/en-us/support/hardware/pc-prepare-ps-vr2/) |

Actually, any headset with OpenXR support + Vulkan API is supposed to work.

## Download

You can go to [releases](https://github.com/bandipapa/rsaber/releases/) to download pre-compiled binaries.

## Build From Source

If you prefer, you can compile rsaber from sources. First of all, you need to have [rust toolchain](https://rustup.rs/) installed.

### android

Prerequisite:
- Install Android Studio, then go to SDK Manager and install:
  - SDK Platforms -> API level: see ANDROID_SDK_LEVEL below
  - SDK Tools -> NDK

- Setup rust toolchain, replace username as needed:
  ```
  rustup target add aarch64-linux-android
  cargo install cargo-ndk
  set JAVA_HOME=c:\Program Files\Android\Android Studio\jbr
  set ANDROID_HOME=c:\Users\<username>\AppData\Local\Android\Sdk
  set ANDROID_SDK_LEVEL=34
  ```

Clone repo, connect Quest to PC, then build in debug mode & run:
```
git clone https://github.com/bandipapa/rsaber.git
cd rsaber\android\build
gradlew runDebug
```

Building in release mode can be done by setting ANDROID_KEYSTORE, ANDROID_KEYSTORE_PW, ANDROID_KEYALIAS, ANDROID_KEYALIAS_PW
environment variables, and execute:
```
gradlew runRelease
```

### pc

Build & run:
```
cargo install rsaber_pc
rsaber_pc
```

### pcvr

Prerequisite:
- cmake is needed to build OpenXR loader, go to https://cmake.org/, and install it.

Build & run:
```
cargo install rsaber_pcvr
rsaber_pcvr
```

## Suggested Reading

- [Essence of linear algebra (excellent stuff, highly recommended)](https://www.youtube.com/watch?v=fNk_zzaMoSs&list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab)
- [Learn OpenGL (still relevant, even we use WebGPU)](https://learnopengl.com/)
- [WebGPU Fundamentals](https://webgpufundamentals.org/)
- [Learn Wgpu](https://sotrh.github.io/learn-wgpu/)
- [rust wgpu](https://docs.rs/wgpu/latest/wgpu/)
- [Normal Transformation](https://paroj.github.io/gltut/Illumination/Tut09%20Normal%20Transformation.html)

## TODO

- Linux port (rsaber_hackedcpal)
- Have the option to dump/read assets from local files (this is for modders who don't want to recompile)