Skip to content

Latest commit

 

History

History
544 lines (448 loc) · 25.8 KB

README.md

File metadata and controls

544 lines (448 loc) · 25.8 KB
Raw

Loadouts for Genshin Impact

drawing

PyPI - Version PyPI - Status PyPI - Supported Python versions PyPI - Downloads PyPI - Implementation PyPI - Format

GitHub - Watchers GitHub - Stars GitHub - Forks GitHub - Language GitHub - License GitHub - Release GitHub - Size GitHub - Activity GitHub - Contributors GitHub Sponsors - Akashdeep Dhar

GitHub - gnul.yml GitHub - gnul.yml GitHub - gnul.yml GitHub - gnul.yml

This is a desktop application that allows travelers to manage their custom equipment of artifacts and weapons for playable characters and makes it convenient for travelers to calculate the associated statistics based on their equipment using the semantic understanding of how the gameplay works. Travelers can create their bespoke loadouts consisting of characters, artifacts and weapons and share them with their fellow travelers. Supported file formats include a human-readable Yet Another Markup Language (YAML) serialization format and a JSON-based Genshin Open Object Definition (GOOD) serialization format.

This project is currently in its beta phase and we are committed to delivering a quality experience with every release we make. If you are excited about the direction of this project and want to contribute to the efforts, we would greatly appreciate it if you help us boost the project visibility by starring the project repository, address the releases by reporting the experienced errors, choose the direction by proposing the intended features, enhance the usability by documenting the project repository, improve the codebase by opening the pull requests and finally, persist our efforts by sponsoring the development members.

Screenshots

On GNU/Linux distributions

  • Light mode - Dash

  • Light mode - Result

  • Dark mode - Dash

  • Dark mode - Result

On Microsoft Windows

  • Light mode - Dash

  • Light mode - Result

  • Dark mode - Dash

  • Dark mode - Result

Download

Optical Character Recognition

The project depends on the Tesseract OCR project to be able to scan in-game screenshots using the Optical Character Recognition technology. As such, please ensure that the Tesseract OCR application is installed and configured properly.

On GNU/Linux distributions

  1. Install Tesseract OCR from your default package manager.

    $ sudo dnf install tesseract

  2. Make note of the place where the Tesseract OCR executable binary is placed.

    /usr/bin/tesseract

On Microsoft Windows

  1. Install Tesseract OCR from the UB Mannheim GitHub namespace.

    https://github.com/UB-Mannheim/tesseract/wiki

  2. Make note of the place where the Tesseract OCR executable binary is placed.

    C:\Program Files\Tesseract-OCR\tesseract.exe

Releases

Stable

Releases for the general usability purposes can be found here.

Nightly

Releases for the testing debugging purposes can be found here.

Package

Releases that automatically update can be found here.

Usage

  1. Select the vision from the dropdown menu to quickly locate the character that you wish to manage the equipment for.

  2. Select the character from the dropdown menu aligned with the element that was selected previously.

  3. Select the level of the character constellation from the dropdown menu and statistics of the character will be calculated automatically.

  4. Select the level of the character experience from the dropdown menu and the statistics of the character will be calculated automatically.

  5. Quickly switch over to either of the travelers, Lumine or Aether from the character menu using the VENUS or MARS buttons respectively.

  6. Once the character is selected from the dropdown menu, the compatible weapon type is automatically selected.

  7. Select the weapon of your choice from the dropdown menu that you want to equip.

  8. Select the rank of the weapon refinement from the dropdown menu and the statistics of the weapon will be calculated automatically.

  9. Select the level of the weapon experience from the dropdown menu and the statistics of the weapon like will be calculated automatically.

  10. Load the weapon equipment from your local storage by using the LOAD button beside the sections.

  11. Save the weapon equipment to your local storage by using the SAVE button beside the sections.

  12. Once the weapon has been configured, configure the artifacts by selecting the artifact set from the dropdown menu.

  13. Select the quality associated with the artifact sought from the dropdown menu so that the possible levels are populated.

  14. Select the level of the artifact experience from the dropdown menu.

  15. Select the primary stat of the artifact from the dropdown menu and the statistics of the artifact will be calculated automatically.

  16. Select the secondary stats of the artifact from the dropdown menu from each distribution area.

  17. Enter the value associated with the secondary stats of the artifact from the dropdown menu from each distribution area.

  18. Alternatively, import the statistics from artifact units from in-game screenshots by using the SCAN buttons beside the distribution areas.

  19. Load the in-game screenshot of the artifact units into interface using the LOAD button.

  20. Alternatively, the in-game screenshot of the artifact units can be inserted from the clipboard by pressing CTRL + V.

  21. Alternatively, the in-game screenshot of the artifact units can be inserted by using the drag and drop action.

  22. Please note that the supported image formats include, but are not limited to, the following.

    • Bitmap [image/bmp] [BMP]
    • Graphics Interchange Format [image/gif] [GIF]
    • Tagged Image File Format [image/tiff] [TIF]
    • Truevision TGA [image/x-tga] [TGA]
    • Open Document Drawing [application/vnd.oasis.opendocument.graphics] [ODG]
    • Icon [image/x-icon] [ICO]
    • Portable Network Graphics [image/png] [PNG]
    • Joint Photographic Experts Group [image/jpeg] [JPG]
    • WebP Image [image/webp] [WEBP]
    • Photoshop Document [image/vnd.adobe.photoshop] [PSD]

  23. Please note that the unsupported image formats include, but are not limited to, the following.

    • Scalable Vector Graphics [image/svg+xml] [SVG]
    • Encapsulated PostScript [application/postscript] [EPS]

  24. Confirm if the correct Tesseract OCR executable is selected by using the LOCATE button.

  25. Wipe the in-game screenshot of the artifact unit from the configuration area by using the WIPE button.

  26. Import the statistics of the detected artifact unit by using the IMPORT button.

  27. Wipe the statistics of the detected artifact unit by using from the configuration area by using the WIPE button.

  28. Wait for the statistics to be read from the in-game screenshot of artifact using Optical Character Recognition or OCR.

  29. Make corrections wherever the application was unable to correctly recognize statistics of the artifact before importing them.

  30. Confirm if better scanning results are obtained for the statistics of the artifact from the details screen.

  31. Confirm if better scanning results are obtained for the statistics of the artifact from the inventory screen.

  32. Confirm if better scanning results are obtained for the statistics of the artifact from the enhancement screen.

  33. Alternatively, load the artifact units from your local storage by using the LOAD buttons beside the distribution areas.

  34. Save the artifact units to your local storage by using the SAVE buttons beside the distribution areas.

  35. Wipe the artifact units from the configuration area by using the WIPE buttons beside the distribution areas.

  36. Read the artifact bonuses available to the character when using two pieces or four-pieces of a certain artifact set.

  37. Load the artifact sets from your local storage by using the LOAD buttons beside the distribution areas.

  38. Save the artifact sets to your local storage by using the SAVE buttons beside the distribution areas.

  39. Wipe the artifact sets from the configuration area by using the WIPE buttons beside the distribution areas.

  40. Calculate the character potential with the equipped artifact units or sets and weapon.

  41. View the calculations of the character potential on the newly created dialog box.

  42. View the help details about the application by clicking on the HELP button from the user interface.

  43. View the info details about the application by clicking on the INFO button from the user interface.

  44. View the homepage of the project by clicking on the FORK button from the user interface.

  45. Report software errors or feature requests by clicking on the REPORT button from the user interface.

  46. Donate to the project by clicking on the HEART button from the user interface.

Development

On GNU/Linux distributions

  1. Ensure that the necessary packages are available on the operating system installation. 
    $ sudo dnf install git tesseract

    $ sudo dnf install python3 python3-pip python3-virtualenv poetry
  2. Clone your fork to the local storage and make it your current working directory. 
    $ git clone https://github.com/gridhead/gi-loadouts.git

    $ cd gi-loadouts
  3. Create a virtual environment and activate it for installing project dependencies. 
    $ virtualenv venv

    $ source venv/bin/activate
  4. Install the project dependencies after verifying the correctness of the configuration. 
    (venv) $ poetry check

    (venv) $ poetry install
  5. Start the application after verifying that the dependencies have been installed. 
    (venv) $ poetry show

    (venv) $ gi-loadouts
  6. Once done with making changes in a separate branch, make a pull request to contribute.

On Microsoft Windows

  1. Ensure that the necessary packages are available on the operating system installation. 
    Git - https://git-scm.com/downloads
Tesseract - https://github.com/UB-Mannheim/tesseract/wiki

    Python 3 - https://www.python.org/downloads/
Poetry - https://python-poetry.org/
  2. Clone your fork to the local storage and make it your current working directory. 
    PS > git clone https://github.com/gridhead/gi-loadouts.git

    PS > cd gi-loadouts
  3. Create a virtual environment and activate it for installing project dependencies. 
    PS > py -m venv venv

    PS > .\venv\Scripts\activate
  4. Install the project dependencies after installing the dependency management tools. 
    (venv) PS > py -m pip install poetry

    (venv) PS > poetry install
  5. Start the application after verifying that the dependencies have been installed. 
    (venv) PS > poetry show

    (venv) PS > gi-loadouts.cmd
  6. Once done with making changes in a separate branch, make a pull request to contribute.

Contribution

You can help our efforts by

  • Star the project repository
    Starring our project repository on GitHub not only helps us witness your support and boost the visibility for the project but it also motivates us to continue improving and expanding our efforts.

  • Report the experienced errors
    If you encounter any errors that should be taken care of, please file them as issue tickets on our issue tracker to help us identify problems as it is when we will be able to address the problems.

  • Propose the intended features
    If you have any ideas that should be introduced in the project, please file them as issue tickets on our issue tracker to help us understand the direction you want the project to take in the future.

  • Document the project repository
    Facilitating a comprehensive project documentation not only enhances the project repository but it also vital for the project's growth among users and project's approachability among developers.

  • Write the project codebase
    Consider opening a pull request against the project repository to contribute to the project codebase whether it is for fixing errors, adding features, amending documentation or modifying assets.

  • Sponsor the project maintainers
    By providing financial support, the maintainers have the means to dedicate more efforts into the development of the project codebase and ensure compatibility from each upcoming Genshin Impact release.

Disclaimer

All rights to Genshin Impact assets used in this project are reserved by miHoYo Ltd. and Cognosphere Pte., Ltd.

Other properties belong to their respective owners.