szhshp/Project-Donner

Application Project Donner

Project Donner - Document

ドン,カツ,ド,ド,カツ,ド,ドドカ,ド,カ,ド,ドドカ,カツ

LICENSE

Main Features

1. Score Search
2. Score View
3. Score Download

TODO

Dev

• Build V0.5 Prod version and public a release
• Log saved score file lists to console
• Demo Site

Feature

• Handle auto download feature
• Fetch for latest version
• Load downloaded score
• Load saved score in search screen
• Display the saved score in search screen and score screen
• Save event in modal
• Split searchscreen into 2 views (search score & saved score)
• Exclude duplicated downloaded scores
• Move 'savedScore' validation inside function read_setting
• Score download
• Version history
• Setting screen
• Setting config file read/write
• Navigation style
• Score modal back event

Bug

• Prevent redownload sore if downloaded in score screen

UI

• Update history text styles

Technology Stacks

• React Native
• Expo
• React Native Shoutem UI

Actions

(TODO)

IO

Settings

• Stores settings of this application into single json file
• Path: ${FileSystem.documentDirectory}setting.json

Format:

{
    autoSave: true,
    [Other Setting Key-Values]
}

Saved Scores

• Stores the downloaded score picture in local storage
• Path: ${FileSystem.documentDirectory}savedScore/
  • Example: ${FileSystem.documentDirectory}savedScore/C6F1B0D7C5D9C9BD2FA4AAA4CB2FA4B5A4A4A4BFA4DE32303030_6F2E706E67
  • Although no extension name, this is directly a picture file
  • File path contains 3 parts:
    1. Fixed path: ${FileSystem.documentDirectory}savedScore/
    2. File name: C6F1B0D7C5D9C9BD2FA4AAA4CB2FA4B5A4A4A4BFA4DE32303030_6F2E706E67
       • File name is taken from the final part of picture path:

        https://www.wikihouse.com/taiko/attach/C6F1B0D7C5D9C9BD2FA4AAA4CB2FA4B5A4A4A4BFA4DE32303030_6F2E706E67
       

• For enumeration of saved score, simply enumerate the files in ${FileSystem.documentDirectory}savedScore/

Dynamic Data

States

{
  settings: {   /* application level settings */
    autoSave: [true|false], /* autoSave when score loaded? */
    savedScore: {
      arrScore: [
        /*
        {
          relativePath: [String]
          scoreObj: {scoreObj}
          levelObj: {levelObj}
        }  
        */
      ], /* saved score file name array */
    },
  },
  search: {
    searchBar: { 
      toggleSearchBar: [true|false], /* search bar input open? */
      keyword: [''|String],
      // previousKeyword: [Array<String>], /* previous searched keyword, TBD */
    },
    selectedCategory: [undefined|categoryObj], /* selected an category? */
  },
  view: {
    scoreView: {
      selectedScore: [undefined|scoreObj], /* selected an score? */
      status: [String], /* screen status, may represents the loading status */
      selectedWikiLink: [undefined|String], /* direct wiki page of selected score and difficulty */
      selectedScoreLink: [undefined|String], /* direct wiki of selected score picture */
      selectedLevel: [undefined|levelObj], /* selected an level? */
      message: [''|String],
      modalVisible: [true|false],
    }
  },
  home: {
    releases: [], /* releases array from github */
  },
}

Static Data

Version Data

• Stores application version data
• Path: data/Version.js
• Check the final element as latest version

Format:

const data_Version = {
  updateDate: '2019-01-06',
  updateHistory: [
    {
      version: 'V0.1',
      detail: 'Init: Framework',
    },
    {
      version: 'V0.2',
      detail: 'Updated: Async call for score details',
    },
  ]
}

Levels Data

• Stores game levels data
• Path: data/Levels.js

Format:

const levels = [
  {
    levelID: 0,
    title: 'かんたん',
    transTitle: '梅',
  },
  {
    levelID: 1,
    title: 'ふつう',
    transTitle: '竹',
  },
  {
    levelID: 2,
    title: 'むずかしい',
    transTitle: '松',
  },
  {
    levelID: 3,
    title: 'おに',
    transTitle: '鬼',
  },
],

Scores Data

• Stores game scores data
• Path: data/Scores.js

Big data file, use data/Scores.Dev.js for dev

Format:

const scores = [
  {
    categoryID: 0,
    scores: [] // array of scores
  },
  {
    categoryID: 0,
    scores: []
  }
]

Score Object

• Description of a single score

Format:

{
  id: 0,
  title: '愛唄',
  subTitle: '',
  BPM: '85',
  levels: [2, null, 2, 3], // if not available for any difficulty level, put null here
},