https://github.com/rukai/rukaidata
Uses brawllib_rs to display frame data of characters
https://github.com/rukai/rukaidata
Last synced: 3 months ago
JSON representation
Uses brawllib_rs to display frame data of characters
- Host: GitHub
- URL: https://github.com/rukai/rukaidata
- Owner: rukai
- License: mit
- Created: 2018-06-30T15:39:17.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-23T00:53:14.000Z (6 months ago)
- Last Synced: 2025-03-14T20:20:05.781Z (3 months ago)
- Language: Rust
- Homepage: https://rukaidata.com
- Size: 1.65 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
# Rukaidata
[](https://deps.rs/repo/github/rukai/rukaidata)
Uses [brawllib_rs](https://github.com/rukai/brawllib_rs) to display frame data on characters.
How does it work? Read the [writeup](docs/writeup.md).
## Run the rukaidata website on your machine
1. Install stable rust via (use the default settings)
2. Right click brawl in dolphin game list -> Properties -> Filesystem -> Disc -> Right click Partition 1 -> Extract Files... -> select the directory `data/Brawl`
3. Copy the entire contents of a brawl mod sd card to the directory `data/MODNAMEHERE` **(optional)**
4. Open a terminal and `cd` to the directory this readme is in.
5. Run the command: `cd website`
6. Run the command: `cargo run --release -- -w` This generates the website into the `root` directory.
7. Run the command: `cargo run --release -- -s` This serves the website at
## Filters
You can use the following arguments to specify filters:
* `-m` List of mod folders in `data/` to use
* `-f` List of fighters to use, specified by their internal name
e.g. To only generate framedata for PM3.6 marth and squirtle run this command:
`cargo run --release -- -mpm3.6 -fmarth,pokezenigame -w`
Using filters will save you generation time and disk space.
## Webpage and gif generation
By default rukaidata will generate no output, however you use the following flags to additively specify what to generate:
* `-w` Generate webpages
* `-g` Generate subaction gifs`
e.g. To generate webpages and gifs for everything run this command:
`cargo run --release -- -wg`
## Serving
rukaidata is designed to be served by AWS S3.
Additionally I also use:
* AWS Cloudfront in front of S3 for CDN.
* Route 53 for domain name registration
* ACM for HTTPS
However to test locally you can use the `-s` flag to run a webserver.
You could also use this functionality to serve in production but I've never tried it.
You would need to put something like nginx in front to get HTTPS
### Generate the site and then serve it
`cargo run --release -- -wgs`
### serve a previously generated site
`cargo run --release -- -s`
## `data` folder cleanup
Most of the files in the `data` folder are actually unused by rukaidata, so after you get everything working, feel free to delete unused files, maintaining the same directory tree structure.
The following files and folders must be kept:
* `*.pac` files in the `fighter` folder
* `RSBE01.gct`
However I may make other files required in the future so watch out. :)