Skip to main content

A utility for the Genshin Impact Housing system

Project description

Tubby


A utility for the Genshin Impact Housing system.
PyPI - Status pypi package GitHub Platform : Unix

Installation    |    Usage    |    Workflow    |    Contributing

Installation

pip install tubby

Verification

To verify that Tubby is installed, run:

python -c "import tubby"

Usage

Run the following command to display a helpful message:

tubby -h
Usage: tubby [options] <command> [Args]

  A utility for the Genshin Impact Housing system

Options:
  -h, --help  Show this message and exit.

Commands:
  analyze   Performs analysis on inventory
  backup    Creates or loads inventory backup
  download  Downloads housing metadata
  info      Displays package information
  manage    Manages inventory
  reset     Resets inventory

Workflow

download metadata from the Genshin Impact Wiki

Tubby scrapes the Wiki and collects relevant metadata for the housing sets and furnishings.

tubby download
Refreshing sources...

Gathering 342 Furnishings...
100%|█████████████████████████████████████████████████████████████████████████████| 342/342 [01:56<00:00,  2.93page/s]

Gathering 45 Sets...
100%|███████████████████████████████████████████████████████████████████████████████| 45/45 [00:16<00:00,  2.72page/s]

Housing metadata updated!

manage your inventory

Start tracking your in-game inventory of characters, materials, furnishings and sets.

tubby manage

Manage menu

Companions

Manage companions menu

Materials

Manage materials menu

Furnishings

Manage furnishings menu

Manage furnishing menu

Sets

Manage sets menu

Manage set menu

To navigate between the menus, use:

  • Enter to select an option,
  • & to cycle through the options,
  • / to open a search prompt, and
  • Esc to return to the previous menu/ quit.

analyze your inventory

Find out how many of which resources (materials, currency, missing furnishings, etc.) are required to meet certain milestones.

tubby analyze

Analyze menu

Materials

Analyze materials menu

Currency

Analyze currency menu

Furnishings

Analyze furnishings menu

Analyze furnishing menu

Sets

Analyze sets menu

Analyze set menu


import / export backup inventory data

Create backups of the information saved with Tubby and export them later.

Import backup from file
tubby backup -i backup/my_inventory.json
Are you sure you want to import inventory from 'backup/my_inventory.json'? [y/N]: y
Imported backup!
Export backup to file
tubby backup -e backup/my_inventory.json
Are you sure you want to export inventory to 'backup/my_inventory.json'? [y/N]: y
Exported backup!

Tubby uses .json files for storing data.


reset data

Deletes information loaded into Tubby.

tubby reset
Are you sure you want to delete your inventory? [y/N]: y
Deleted inventory!

This resets only the inventory data. Metadata is not deleted.

Contributing

Do you have a feature request, bug report, or patch? Great! Check out the contributing guidelines!

License

Copyright (c) 2021 Kelvin DeCosta. Released under the MIT License. See LICENSE for details.

This project is not affiliated with or endorsed by miHoYo. Genshin Impact and miHoYo are trademarks or registered trademarks of miHoYo. Genshin Impact © miHoYo.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tubby-1.0.3.tar.gz (20.8 kB view hashes)

Uploaded Source

Built Distribution

tubby-1.0.3-py3-none-any.whl (22.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page