Skip to content

Latest commit

 

History

History
72 lines (57 loc) · 3.23 KB

README.md

File metadata and controls

72 lines (57 loc) · 3.23 KB
Raw

Ark Breeder

https://dev.arkbreeder.com/

This is very much a work in progress and we ask you to please be patient as we attempt to provide the best experience possible. Unfortunately, we are not accept feature requests at this time. We are also very aware of bugs in the program at the moment. Thank you. 😄

Inspiration

This app is inspired by the wonderful Ark Smart Breeding and aims to replicate some of its functionality for mobile and tablet devices.

Development

This project follows gitflow. Development work should be based off the develop branch, or in feature branches for large tasks.

For reference: https://github.com/petervanderdoes/gitflow-avh

Testing

Tests exist for:

  • Some parts of the code (unit tests)
  • The extraction of embedded creature data
  • The extraction of all creatures in the ASB_dino_submissions repository
  • Performance of a particular extraction

Our test suites:

npm run ... Description
test:all All except performance-related tests.
test:unit Low-level functional tests.
test:perf Performance tests, currently only for the extractor.
test:data Extraction tests for embedded test data.
test:archive Extraction tests for all creatures present in the testdata directory.
test:extractor Both data and archive together.

TODO

High Priority

  • Ability to import Ark Exports into extractor
  • Implement library-specific settings
  • Move last selected server setting from app settings to library settings
  • Implement a real Extractor UI
  • Begin implementation of Stat Tester - UI and backing code
  • Begin implementation of Expert Mode - UI and backing code
  • Begin implementation of library view, optimised for mobile but expandable to tablet size
  • Add IBM value to server editing UI
  • Store last app & data versions in app settings
  • Display generated What's New page when app version changes
  • Display notification when data version changes
  • Work out why Math.round in extractor.ts:396 causes inf loop

Medium Priority

  • Add server selector either globally or in extractor
  • Figure out how library selection & management is going to be presented
  • Add ability to load extra configs, such as ClassicFlyers, in a generic way
  • Verify app compatibility with iOS
  • Import/export ASB library
  • Disable devMode by default and provide a mechanism to turn it back on (store in app settings)
  • Create continuous tester using random creatures and random server parameters
  • Implement internationalisation via i18-next and panter/vue-i18next
  • Change Extractor tab to Calculator and add ability to switch from Extractor/Tester(or edit)/Expert Mode?
  • Switch navigation to vue-router to get more capability
  • Add an event fired on tab change, so pending DB changes can be flushed (possibly tied to vue-router work)
  • Add Game.ini drop area on server tab (re-use existing importer and make file drop component reusable)

Size Reduction

  • Take only the components we use from bootstrap-vue
  • Investigate the recent 100Kb bump in size

Continuous

  • Add extra test cases
  • Address TODOs and FIXMEs in code
  • Improve the extractor : handle more cases and produce less options in as little time as possible