joshuaboniface/c3dbdl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add linting/formatting and convert to module

Browse Source
This commit is contained in:
Joshua Boniface
2023-04-06 19:26:00 -04:00
parent ca36555e6b
commit a766f2a61f
9 changed files with 1025 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,23 +1,31 @@
# C3DB Download Tool
# Customs Creators Collective archive tool
The C3DB Download Tool allows for easy scraping to a local JSON database and downloading of files from the C3
(Customs Creators Collective) database, a collection of custom songs for Guitar Hero, Rock Band, and similar clone
games.
The Customs Creators Collective archive tool allows for easy scraping to a local JSON database and downloading of
files from the C3 (Customs Creators Collective) database, a collection of custom songs for Rock Band and similar
clone games.
This tool exists because the C3DB is very hard to mass download from: each song must be found in the extensive
list, selected manually, and a second link clicked through, before a random file name is obtained. This tool
simplifies the process by first collecting information about all available songs of a particular type, and then is
able to download songs based on customizable filters (e.g. by genre, artist, author, etc.) and output them in a
standardized format.
simplifies the process by first collecting information about all available songs of a particular type, and then
is able to download songs based on customizable filters (e.g. by genre, artist, author, etc.) and output them in
a standardized format.
To use the tool, first use the "database" command to build or modify your local JSON database, then use the
"download" command to download songs.
## Installation
### `pip`
1. Use `pip3 install .` to install the package to a virtualenv or your system Python. The tool will be available
as `c3dbdl` in your shell.
### Manual
1. Install the Python3 requirements from `requirements.txt`.
1. Copy the script to a virtualenv, somewhere in your $PATH or execute directly from this folder (see Usage below).
1. Copy the file `c3dbdl/c3dbdl.py` to somewhere in your `$PATH`. You can optionally remove the `.py` if you
with for command compatibility with a `pip` installation.
## Usage