Justin Edmund
c0922203a7
* Add table for data version and migrate * Modify migration and re-migrate * Create data_version.rb Adds a model for DataVersion * Add aws-sdk-s3 and create aws_service.rb AwsService handles streaming game image files from the Granblue Fantasy server to our S3 instance. * Add importers The Importer libraries take CSV data and import them into the database for each type. We currently support characters, summons and weapons. * Add downloaders Downloaders take Granblue IDs and download images for those items from the Granblue Fantasy server in all relevant sizes. Downloaders can download to disk or stream the file directly to S3. * Create data_importer.rb * Fetches a list of all CSV files present in the updates folder * Checks which have already been imported * Sends unimported data to the appropriate Importer to handle * Create download_manager.rb Creates an appropriate downloader for each Granblue ID it receives * Update download_images.rake Most of this task has been extracted into the Downloader libraries * Update import_data.rake * Create deploy.rake This task is to be run as a post-deploy script. It checks for new unimported data, imports it, then downloads the relevant images to S3 or local disk depending on the parameters provided. * Update credentials.yml.enc * Began working on a README and added example CSVs * Modify importer to handle updates This way we can also add FLBs and other uncaps easier. * Updates only require values that will change When updating a row, fields that don't have a provided value will not be changed * Rebuild search indices in post deploy * Clean up logs with LoggingHelper * More logging adjustments Trying to get a nice-looking output * Change some ASCII characters * Final ASCII changes * Fix issues with Summon and Weapon importers * Finish README for contributing
179 lines
5 KiB
Markdown
179 lines
5 KiB
Markdown
# Adding items to the database
|
|
|
|
Anyone can add data to the database via a Pull Request on Github. Fork the repository, then create a new CSV file in the
|
|
`updates` folder with the date, type of item you're updating, and the next number in the sequence. The most important
|
|
part is the type of item, which should be plural for convention. This is what tells the service how to process your
|
|
data.
|
|
|
|
```
|
|
20240618-characters-001.csv
|
|
20241231-weapons-010.csv
|
|
20250115-summons-025.csv
|
|
```
|
|
|
|
It's recommended to use a CSV editor to edit this data, but something like Microsoft Excel or Numbers should work fine
|
|
too.
|
|
|
|
## Required values
|
|
|
|
You are required to set values for the following fields:
|
|
TBA
|
|
|
|
## Arrays
|
|
|
|
When adding the `character_id`, `nicknames_en`, or `nicknames_jp`, make sure to wrap your values in brackets ({}). If
|
|
there are multiple values, you can separate them with a comma (,) with no spaces on either side.
|
|
|
|
```
|
|
# character_id, Zeta and Vaseraga (Halloween):
|
|
{3024,3025}
|
|
|
|
# nicknames_en, Threo
|
|
{sarasa,cake,thalatha}
|
|
```
|
|
|
|
## Value tables
|
|
|
|
Values for properties like `element` are pre-defined, so you only need to input the corresponding digit.
|
|
|
|
#### Rarity
|
|
|
|
| Rarity | Value |
|
|
|--------|-------|
|
|
| SSR | 3 |
|
|
| SR | 2 |
|
|
| R | 1 |
|
|
|
|
#### Element
|
|
|
|
| Element | Value |
|
|
|---------|-------|
|
|
| Wind | 1 |
|
|
| Fire | 2 |
|
|
| Water | 3 |
|
|
| Earth | 4 |
|
|
| Dark | 5 |
|
|
| Light | 6 |
|
|
|
|
#### Proficiency
|
|
|
|
| Proficiency | Value |
|
|
|-------------|-------|
|
|
| Sabre | 1 |
|
|
| Dagger | 2 |
|
|
| Axe | 3 |
|
|
| Spear | 4 |
|
|
| Bow | 5 |
|
|
| Staff | 6 |
|
|
| Melee | 7 |
|
|
| Harp | 8 |
|
|
| Gun | 9 |
|
|
| Katana | 10 |
|
|
|
|
#### Race
|
|
|
|
| Race | Value |
|
|
|---------|-------|
|
|
| Unknown | 0 |
|
|
| Human | 1 |
|
|
| Erune | 2 |
|
|
| Draph | 3 |
|
|
| Harvin | 4 |
|
|
| Primal | 5 |
|
|
|
|
#### Gender
|
|
|
|
| Gender | Value |
|
|
|-------------|-------|
|
|
| Other | 0 |
|
|
| Male | 1 |
|
|
| Female | 2 |
|
|
| Male/Female | 3 |
|
|
|
|
#### Weapon Series (Needs to be cleaned)
|
|
|
|
| Series Name | Value | Series Name | Value |
|
|
|--------------|-------|----------------------|-------|
|
|
| Seraphic | 0 | Cosmic | 20 |
|
|
| Grand | 1 | Draconic | 21 |
|
|
| Dark Opus | 2 | Superlative | 22 |
|
|
| Draconic | 3 | Vintage | 23 |
|
|
| Revenant | 4 | Class Champion | 24 |
|
|
| Beast | 5 | Proven | 25 |
|
|
| Primal | 6 | Malice | 26 |
|
|
| Beast | 7 | Menace | 27 |
|
|
| Regalia | 8 | Sephira | 28 |
|
|
| Omega | 9 | New World Foundation | 29 |
|
|
| Olden Primal | 10 | Revans | 30 |
|
|
| Militis | 11 | Illustrious | 31 |
|
|
| Hollowsky | 12 | World | 32 |
|
|
| Xeno | 13 | Exo | 33 |
|
|
| Astral | 14 | Event | 35 |
|
|
| Rose Crystal | 15 | Gacha | 36 |
|
|
| Bahamut | 16 | Celestial | 37 |
|
|
| Ultima | 17 | Omega Rebirth | 38 |
|
|
| Epic | 18 | Assorted | -1 |
|
|
| Ennead | 19 | | |
|
|
|
|
#### Summon Series (Needs to be cleaned)
|
|
|
|
| Series Name | Value |
|
|
|--------------|-------|
|
|
| Providence | 0 |
|
|
| Genesis | 1 |
|
|
| Omega | 2 |
|
|
| Optimus | 3 |
|
|
| Demi Optimus | 4 |
|
|
| Archangel | 5 |
|
|
| Arcarum | 6 |
|
|
| Epic | 7 |
|
|
| Dynamis | 9 |
|
|
| Cryptid | 11 |
|
|
| Six Dragons | 12 |
|
|
|
|
### Wiki links
|
|
|
|
You should try to provide identifiers for the 4 major wikis: gbf.wiki, gbf-wiki.com (JA), Kamigame (JA) and Gamewith (
|
|
JA). Here's how:
|
|
|
|
#### gbf.wiki
|
|
|
|
This is simply the item's name, as it appears after `https://gbf.wiki/` in the URL.
|
|
|
|
```
|
|
https://gbf.wiki/Bahamut -> Bahamut
|
|
```
|
|
|
|
#### Gamewith
|
|
|
|
This is a 5 to 6 digit string that appears at the end of the URL.
|
|
|
|
```
|
|
https://xn--bck3aza1a2if6kra4ee0hf.gamewith.jp/article/show/21612 -> 21612
|
|
```
|
|
|
|
#### Kamigame
|
|
|
|
Use a [URL decoder](https://www.urldecoder.org/) to extract the Japanese characters from the URL after the final forward
|
|
slash (/) and before `.html`.
|
|
|
|
```
|
|
https://kamigame.jp/%E3%82%B0%E3%83%A9%E3%83%96%E3%83%AB/%E3%82%AD%E3%83%A3%E3%83%A9%E3%82%AF%E3%82%BF%E3%83%BC/SSR%E3%83%A4%E3%83%81%E3%83%9E.html
|
|
-(decoder)->
|
|
https://kamigame.jp/グラブル/キャラクター/SSRヤチマ.html
|
|
-(value)->
|
|
SSRヤチマ
|
|
```
|
|
|
|
#### gbf-wiki.com
|
|
|
|
Use a [URL decoder](https://www.urldecoder.org/) to extract the Japanese characters from the URL after the question
|
|
mark. Replace the `+` with a space.
|
|
|
|
```
|
|
https://gbf-wiki.com/?%E3%83%A4%E3%83%81%E3%83%9E+(SSR)%E3%83%AA%E3%83%9F%E3%83%86%E3%83%83%E3%83%89%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3
|
|
-(decoder)->
|
|
https://gbf-wiki.com/?ヤチマ+(SSR)リミテッドバージョン
|
|
-(value)->
|
|
ヤチマ (SSR)リミテッドバージョン
|
|
```
|