-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create
README.md
and make lib.rs
tfn into doc test
- Loading branch information
1 parent
e3e4caa
commit d10b807
Showing
2 changed files
with
36 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# `beat_saber_map` | ||
|
||
[](https://crates.io/crates/beat_saber_map) | ||
[](https://docs.rs/beat_saber_map) | ||
[](https://github.com/valentinegb/beat-saber-map-rs/actions/workflows/rust.yml) | ||
|
||
Read and write Beat Saber maps with Rust. | ||
|
||
```rs | ||
use beat_saber_map::BeatSaberMap; | ||
|
||
let map = BeatSaberMap::from_dir("sample").unwrap(); | ||
|
||
assert_eq!(map.info.song.title, "Magic"); | ||
``` | ||
|
||
Documentation can be found on [docs.rs](https://docs.rs/beat_saber_map). | ||
|
||
## Roadmap | ||
|
||
- [ ] Create structures for map files | ||
- [x] [`Info`](https://docs.rs/beat_saber_map/latest/beat_saber_map/info/struct.Info.html) | ||
- [ ] `Audio` | ||
- [ ] `Beatmap` | ||
- [ ] `Lightshow` | ||
- [ ] Create utility methods for map file structures and [`BeatSaberMap`](https://docs.rs/beat_saber_map/latest/beat_saber_map/struct.BeatSaberMap.html) | ||
- [x] [`BeatSaberMap::from_dir()`](https://docs.rs/beat_saber_map/latest/beat_saber_map/struct.BeatSaberMap.html#method.from_dir) | ||
- [ ] More... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters