Skip to content

Latest commit

 

History

History
65 lines (37 loc) · 2.95 KB

README.md

File metadata and controls

65 lines (37 loc) · 2.95 KB

BananaDragon Static Data

A tool to generate more accurate and timely DDragon-esque files from CDragon game & client files.

Dependencies

To install dependencies, run:

pip install -r requirements.txt

As BDragon uses CDTB, these include CDTB's requirements.

Configuration

Configuration can be set in the config.yml file located in the main directory. You will need to rename config_example.yml to config.yml and configure the yaml to the configuration that meets your needs. This will allow updates without having to worry about having your config file replaced in the future.

You can use these settings to tune what you wish to do with BDragon, whether it is just downloading files, or hosting it as a cdn.

Command Line Running

You can use the command line to explain parameters python3 bdragon -h

Example parameters:

#download current patch files
python3 bdragon

#download pbe files
python3 bdragon -p pbe

#download pbe files and create a tarball
python3 bdragon -p pbe --tarball

#download 10.20 files for only en_US
python3 bdragon -p 10.20 -l en_US

Sprite Sheets

This project uses a modified version of Querijin's DragonSpriter. Binaries for Linux and Windows are included in the repository. If you would like to compile these files yourself you can download and compile from my forked repository and replace the respective file in the bdragon folder.

Files

Files are generated into the files/{patch} directory in the main directory. data contains all the data jsons (cdn/patch/data), img contains all the versioned images of the patch (cdn/patch/img), images contains all the unversioned images of the patch (cdn/img)

Contributing

The best way to contribute is to fork the repository and create a Pull Request. All Pull Requests are welcome but please make sure you are only effecting the code you plan to as every small change can have a big impact parsing files.

CDN

As hosting your own ddragon data is not always viable, I also host the data at https://ddragon.bangingheads.net/cdn/

This includes all ddragon resources like the versions api.

Although no downtime is expected, this CDN is provided as a best effort service. If you require high amounts of bandwidth from the CDN, I kindly ask that you either use the project as a CDN or download the tarball and host it yourself.

Thank You

A special shoutout to the CommunityDragon team, this project is not possible without them, they work hard for the community. More can be found about CDragon on their website. You can support their project on their Patreon.

A thank you to Querijin for his making of the sprite sheet maker as it saved time in building the project.