<h1 align="center">Loadouts for Genshin Impact</h1>
<p align="center">
<img src="https://raw.githubusercontent.com/gridhead/gi-loadouts/main/assets/imgs/pmon/8.png" alt="drawing" width="200"/>
</p>
<p align="center">
<a href="https://pypi.org/project/gi-loadouts/">
<img src="https://img.shields.io/pypi/v/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080" alt="PyPI - Version">
<img src="https://img.shields.io/pypi/status/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080" alt="PyPI - Status">
<img src="https://img.shields.io/pypi/pyversions/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080" alt="PyPI - Supported Python versions">
<img src="https://img.shields.io/pypi/dm/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080" alt="PyPI - Downloads">
<img src="https://img.shields.io/pypi/implementation/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080" alt="PyPI - Implementation">
<img src="https://img.shields.io/pypi/format/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080" alt="PyPI - Format">
</a>
</p>
<p align="center">
<a href="#">
<img src="https://img.shields.io/github/watchers/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - Watchers">
<img src="https://img.shields.io/github/stars/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - Stars">
<img src="https://img.shields.io/github/forks/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - Forks">
<img src="https://img.shields.io/github/languages/top/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - Language">
<img src="https://img.shields.io/github/license/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - License">
<img src="https://img.shields.io/github/v/release/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - Release">
<img src="https://img.shields.io/github/repo-size/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - Size">
<img src="https://img.shields.io/github/commit-activity/m/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - Activity">
<img src="https://img.shields.io/github/contributors/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub - Contributors">
<img src="https://img.shields.io/github/sponsors/gridhead?style=flat&logo=github&logoColor=ffffff&color=008080" alt="GitHub Sponsors - Akashdeep Dhar">
</a>
</p>
<p align="center">
<a href="https://github.com/gridhead/gi-loadouts/actions/workflows/qlty.yml">
<img src="https://img.shields.io/github/actions/workflow/status/gridhead/gi-loadouts/qlty.yml?style=flat&logo=git&logoColor=ffffff&color=008080&label=Checking%20code%20quality" alt="GitHub - gnul.yml">
</a>
<a href="https://github.com/gridhead/gi-loadouts/actions/workflows/gnul.yml">
<img src="https://img.shields.io/github/actions/workflow/status/gridhead/gi-loadouts/gnul.yml?style=flat&logo=git&logoColor=ffffff&color=008080&label=Builds%20for%20GNU%2FLinux%20distributions" alt="GitHub - gnul.yml">
</a>
<a href="https://github.com/gridhead/gi-loadouts/actions/workflows/mswn.yml">
<img src="https://img.shields.io/github/actions/workflow/status/gridhead/gi-loadouts/mswn.yml?style=flat&logo=git&logoColor=ffffff&color=008080&label=Builds%20for%20Microsoft%20Windows" alt="GitHub - gnul.yml">
</a>
<a href="https://github.com/gridhead/gi-loadouts/actions/workflows/wipe.yml">
<img src="https://img.shields.io/github/actions/workflow/status/gridhead/gi-loadouts/wipe.yml?style=flat&logo=git&logoColor=ffffff&color=008080&label=Periodic%20artifact%20cleanup" alt="GitHub - gnul.yml">
</a>
</p>
<p align="center">
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 <b>Yet Another Markup Language (YAML)</b> serialization
format and a JSON-based <b>Genshin Open Object Definition (GOOD)</b> serialization format.
</p>
<p align="center">
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 <b>starring the project repository</b>, address the releases by
<b>reporting the experienced errors</b>, choose the direction by <b>proposing the intended
features</b>, enhance the usability by <b>documenting the project repository</b>, improve the
codebase by <b>opening the pull requests</b> and finally, persist our efforts by <b>sponsoring
the development members</b>.
</p>
## 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](https://src.fedoraproject.org/rpms/tesseract) 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](https://github.com/UB-Mannheim/tesseract/wiki) 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](https://github.com/gridhead/gi-loadouts/releases).
#### Nightly
**Releases** for the _testing debugging purposes_ can be found [here](https://github.com/gridhead/expedite/actions).
#### Package
**Releases** that _automatically update_ can be found [here](https://pypi.org/project/gi-loadouts/).
## Usage
1. Select the [*vision*](https://genshin-impact.fandom.com/wiki/Vision) from
the dropdown menu to quickly locate the
[*character*](https://genshin-impact.fandom.com/wiki/Character)
that you wish to manage the equipment for.
2. Select the [*character*](https://genshin-impact.fandom.com/wiki/Character)
from the dropdown menu aligned with the
[*element*](https://genshin-impact.fandom.com/wiki/Element)
that was selected previously.
3. Select the [*level*](https://genshin-impact.fandom.com/wiki/Constellation)
of the [*character*](https://genshin-impact.fandom.com/wiki/Character)
constellation from the dropdown menu and statistics of the character will
be calculated automatically.
4. Select the [*level*](https://genshin-impact.fandom.com/wiki/Character_EXP)
of the [*character*](https://genshin-impact.fandom.com/wiki/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*](https://genshin-impact.fandom.com/wiki/Traveler), **Lumine**
or **Aether** from the
[*character*](https://genshin-impact.fandom.com/wiki/Character) menu using
the **VENUS** or **MARS** buttons respectively.
6. Once the [*character*](https://genshin-impact.fandom.com/wiki/Character)
is selected from the dropdown menu, the compatible
[*weapon*](https://genshin-impact.fandom.com/wiki/Weapon)
type is automatically selected.
7. Select the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) of
your choice from the dropdown menu that you want to equip.
8. Select the [*rank*](https://genshin-impact.fandom.com/wiki/Refinement_Rank)
of the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon)
refinement from the dropdown menu and the statistics of the weapon will
be calculated automatically.
9. Select the [*level*](https://genshin-impact.fandom.com/wiki/Weapon_EXP)
of the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon)
experience from the dropdown menu and the statistics of the weapon like
will be calculated automatically.
10. Load the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon)
equipment from your local storage by using the **LOAD** button beside the
sections.
11. Save the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon)
equipment to your local storage by using the **SAVE** button beside the
sections.
12. Once the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) has
been configured, configure the
[*artifacts*](https://genshin-impact.fandom.com/wiki/Artifact) by
selecting the artifact
[*set*](https://genshin-impact.fandom.com/wiki/Artifact/Sets)
from the dropdown menu.
13. Select the [*quality*](https://genshin-impact.fandom.com/wiki/Quality)
associated with the
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
sought from the dropdown menu so that the possible
[*levels*](https://genshin-impact.fandom.com/wiki/Artifact_EXP) are
populated.
14. Select the [*level*](https://genshin-impact.fandom.com/wiki/Artifact_EXP)
of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
experience from the dropdown menu.
15. Select the
[*primary stat*](https://genshin-impact.fandom.com/wiki/Artifact/Stats) of
the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from the
dropdown menu and the statistics of the artifact will be calculated
automatically.
16. Select the
[*secondary stats*](https://genshin-impact.fandom.com/wiki/Artifact/Stats)
of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from
the dropdown menu from each
[*distribution*](https://genshin-impact.fandom.com/wiki/Artifact/Distribution)
area.
17. Enter the value associated with the
[*secondary stats*](https://genshin-impact.fandom.com/wiki/Artifact/Stats)
of the
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from the
dropdown menu from each
[*distribution*](https://genshin-impact.fandom.com/wiki/Artifact/Distribution)
area.
18. Alternatively, import the statistics from
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
units from in-game screenshots by using the **SCAN** buttons beside the
distribution areas.
19. Load the in-game screenshot of the
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) units into
interface using the **LOAD** button.
20. Alternatively, the in-game screenshot of the
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) units can be inserted from the
clipboard by pressing `CTRL` + `V`.
21. Alternatively, the in-game screenshot of the
[*artifact*](https://genshin-impact.fandom.com/wiki/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](https://github.com/UB-Mannheim/tesseract/wiki) executable
is selected by using the **LOCATE** button.
25. Wipe the in-game screenshot of the
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) unit from the
configuration area by using the **WIPE** button.
26. Import the statistics of the detected
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) unit by using
the **IMPORT** button.
27. Wipe the statistics of the detected
[*artifact*](https://genshin-impact.fandom.com/wiki/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*](https://genshin-impact.fandom.com/wiki/Artifact) using Optical
Character Recognition or OCR.
29. Make corrections wherever the application was unable to correctly recognize
statistics of the
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) before
importing them.
30. Confirm if better scanning results are obtained for the statistics
of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from
the *details screen*.
31. Confirm if better scanning results are obtained for the statistics
of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from
the *inventory screen*.
32. Confirm if better scanning results are obtained for the statistics
of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from
the *enhancement screen*.
33. Alternatively, load the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
units from your local storage by using the **LOAD** buttons beside the
distribution areas.
34. Save the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
units to your local storage by using the **SAVE** buttons beside the
distribution areas.
35. Wipe the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
units from the configuration area by using the **WIPE** buttons beside the
distribution areas.
36. Read the
[*artifact bonuses*](https://genshin-impact.fandom.com/wiki/Artifact/Sets)
available to the character when using two pieces or four-pieces of a
certain [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
set.
37. Load the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
sets from your local storage by using the **LOAD** buttons beside the
distribution areas.
38. Save the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
sets to your local storage by using the **SAVE** buttons beside the
distribution areas.
39. Wipe the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)
sets from the configuration area by using the **WIPE** buttons beside the
distribution areas.
40. Calculate the
[*character*](https://genshin-impact.fandom.com/wiki/Character) potential
with the equipped
[*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) units or sets
and [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon).
41. View the calculations of the character potential on the newly created
dialog box.
42. View the
[*help details*](https://raw.githubusercontent.com/gridhead/gi-loadouts/main/assets/docs/lcns.png)
about the application by clicking on the **HELP** button from the user
interface.
43. View the
[*info details*](https://raw.githubusercontent.com/gridhead/gi-loadouts/main/assets/docs/info.png)
about the application by clicking on the **INFO** button from the user
interface.
44. View the [*homepage*](https://github.com/gridhead/gi-loadouts/) 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*](https://github.com/sponsors/gridhead) 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/gridhead/gi-loadouts",
"name": "gi-loadouts",
"maintainer": "Akashdeep Dhar",
"docs_url": null,
"requires_python": "<3.14,>=3.12",
"maintainer_email": "akashdeep.dhar@gmail.com",
"keywords": null,
"author": "Akashdeep Dhar",
"author_email": "akashdeep.dhar@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8f/2d/c6759f5ae062fbc264ddd4d71eacb41ccc0e6d4c74806ed97b7b1795cf10/gi_loadouts-0.1.2.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Loadouts for Genshin Impact</h1>\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/gridhead/gi-loadouts/main/assets/imgs/pmon/8.png\" alt=\"drawing\" width=\"200\"/>\n</p>\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/gi-loadouts/\">\n <img src=\"https://img.shields.io/pypi/v/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080\" alt=\"PyPI - Version\">\n <img src=\"https://img.shields.io/pypi/status/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080\" alt=\"PyPI - Status\">\n <img src=\"https://img.shields.io/pypi/pyversions/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080\" alt=\"PyPI - Supported Python versions\">\n <img src=\"https://img.shields.io/pypi/dm/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080\" alt=\"PyPI - Downloads\">\n <img src=\"https://img.shields.io/pypi/implementation/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080\" alt=\"PyPI - Implementation\">\n <img src=\"https://img.shields.io/pypi/format/gi-loadouts?style=flat&logo=python&logoColor=ffffff&color=008080\" alt=\"PyPI - Format\">\n </a>\n</p>\n\n<p align=\"center\">\n <a href=\"#\">\n <img src=\"https://img.shields.io/github/watchers/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - Watchers\">\n <img src=\"https://img.shields.io/github/stars/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - Stars\">\n <img src=\"https://img.shields.io/github/forks/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - Forks\">\n <img src=\"https://img.shields.io/github/languages/top/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - Language\">\n <img src=\"https://img.shields.io/github/license/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - License\">\n <img src=\"https://img.shields.io/github/v/release/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - Release\">\n <img src=\"https://img.shields.io/github/repo-size/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - Size\">\n <img src=\"https://img.shields.io/github/commit-activity/m/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - Activity\">\n <img src=\"https://img.shields.io/github/contributors/gridhead/gi-loadouts?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub - Contributors\">\n <img src=\"https://img.shields.io/github/sponsors/gridhead?style=flat&logo=github&logoColor=ffffff&color=008080\" alt=\"GitHub Sponsors - Akashdeep Dhar\">\n </a>\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/gridhead/gi-loadouts/actions/workflows/qlty.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/gridhead/gi-loadouts/qlty.yml?style=flat&logo=git&logoColor=ffffff&color=008080&label=Checking%20code%20quality\" alt=\"GitHub - gnul.yml\">\n </a>\n <a href=\"https://github.com/gridhead/gi-loadouts/actions/workflows/gnul.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/gridhead/gi-loadouts/gnul.yml?style=flat&logo=git&logoColor=ffffff&color=008080&label=Builds%20for%20GNU%2FLinux%20distributions\" alt=\"GitHub - gnul.yml\">\n </a>\n <a href=\"https://github.com/gridhead/gi-loadouts/actions/workflows/mswn.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/gridhead/gi-loadouts/mswn.yml?style=flat&logo=git&logoColor=ffffff&color=008080&label=Builds%20for%20Microsoft%20Windows\" alt=\"GitHub - gnul.yml\">\n </a>\n <a href=\"https://github.com/gridhead/gi-loadouts/actions/workflows/wipe.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/gridhead/gi-loadouts/wipe.yml?style=flat&logo=git&logoColor=ffffff&color=008080&label=Periodic%20artifact%20cleanup\" alt=\"GitHub - gnul.yml\">\n </a>\n</p>\n\n<p align=\"center\">\n This is a desktop application that allows travelers to manage their custom equipment of \n artifacts and weapons for playable characters and makes it convenient for travelers to \n calculate the associated statistics based on their equipment using the semantic understanding \n of how the gameplay works. Travelers can create their bespoke loadouts consisting of \n characters, artifacts and weapons and share them with their fellow travelers. Supported file\n formats include a human-readable <b>Yet Another Markup Language (YAML)</b> serialization \n format and a JSON-based <b>Genshin Open Object Definition (GOOD)</b> serialization format.\n</p>\n\n<p align=\"center\">\n This project is currently in its beta phase and we are committed to delivering a quality \n experience with every release we make. If you are excited about the direction of this project \n and want to contribute to the efforts, we would greatly appreciate it if you help us boost the \n project visibility by <b>starring the project repository</b>, address the releases by \n <b>reporting the experienced errors</b>, choose the direction by <b>proposing the intended \n features</b>, enhance the usability by <b>documenting the project repository</b>, improve the \n codebase by <b>opening the pull requests</b> and finally, persist our efforts by <b>sponsoring \n the development members</b>.\n</p>\n\n## Screenshots\n\n### On GNU/Linux distributions\n\n- **Light mode** - Dash \n \n\n- **Light mode** - Result \n \n\n- **Dark mode** - Dash \n \n\n- **Dark mode** - Result \n \n\n### On Microsoft Windows\n\n- **Light mode** - Dash \n \n\n- **Light mode** - Result \n \n\n- **Dark mode** - Dash \n \n\n- **Dark mode** - Result \n \n\n## Download\n\n### Optical Character Recognition\n\nThe project depends on the Tesseract OCR project to be able to scan in-game \nscreenshots using the Optical Character Recognition technology. As such, please\nensure that the Tesseract OCR application is installed and configured properly.\n\n#### On GNU/Linux distributions \n\n1. Install [Tesseract OCR](https://src.fedoraproject.org/rpms/tesseract) from your default package manager.\n ```\n $ sudo dnf install tesseract\n ```\n\n2. Make note of the place where the Tesseract OCR executable binary is placed.\n ```\n /usr/bin/tesseract\n ```\n\n#### On Microsoft Windows\n\n1. Install [Tesseract OCR](https://github.com/UB-Mannheim/tesseract/wiki) from the UB Mannheim GitHub namespace.\n ```\n https://github.com/UB-Mannheim/tesseract/wiki\n ```\n\n2. Make note of the place where the Tesseract OCR executable binary is placed.\n ```\n C:\\Program Files\\Tesseract-OCR\\tesseract.exe\n ```\n\n### Releases\n\n#### Stable\n\n**Releases** for the _general usability purposes_ can be found [here](https://github.com/gridhead/gi-loadouts/releases).\n\n#### Nightly\n\n**Releases** for the _testing debugging purposes_ can be found [here](https://github.com/gridhead/expedite/actions).\n\n#### Package\n\n**Releases** that _automatically update_ can be found [here](https://pypi.org/project/gi-loadouts/).\n\n## Usage\n\n1. Select the [*vision*](https://genshin-impact.fandom.com/wiki/Vision) from \n the dropdown menu to quickly locate the \n [*character*](https://genshin-impact.fandom.com/wiki/Character) \n that you wish to manage the equipment for. \n \n\n2. Select the [*character*](https://genshin-impact.fandom.com/wiki/Character) \n from the dropdown menu aligned with the \n [*element*](https://genshin-impact.fandom.com/wiki/Element) \n that was selected previously. \n \n\n3. Select the [*level*](https://genshin-impact.fandom.com/wiki/Constellation) \n of the [*character*](https://genshin-impact.fandom.com/wiki/Character) \n constellation from the dropdown menu and statistics of the character will \n be calculated automatically. \n \n\n4. Select the [*level*](https://genshin-impact.fandom.com/wiki/Character_EXP) \n of the [*character*](https://genshin-impact.fandom.com/wiki/Character) \n experience from the dropdown menu and the statistics of the character \n will be calculated automatically. \n \n\n5. Quickly switch over to either of the \n [*travelers*](https://genshin-impact.fandom.com/wiki/Traveler), **Lumine** \n or **Aether** from the \n [*character*](https://genshin-impact.fandom.com/wiki/Character) menu using \n the **VENUS** or **MARS** buttons respectively. \n  \n \n\n6. Once the [*character*](https://genshin-impact.fandom.com/wiki/Character) \n is selected from the dropdown menu, the compatible \n [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) \n type is automatically selected. \n \n\n7. Select the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) of \n your choice from the dropdown menu that you want to equip. \n \n\n8. Select the [*rank*](https://genshin-impact.fandom.com/wiki/Refinement_Rank)\n of the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) \n refinement from the dropdown menu and the statistics of the weapon will \n be calculated automatically. \n \n\n9. Select the [*level*](https://genshin-impact.fandom.com/wiki/Weapon_EXP) \n of the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) \n experience from the dropdown menu and the statistics of the weapon like \n will be calculated automatically. \n \n\n10. Load the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) \n equipment from your local storage by using the **LOAD** button beside the \n sections. \n \n\n11. Save the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) \n equipment to your local storage by using the **SAVE** button beside the \n sections. \n \n\n12. Once the [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon) has \n been configured, configure the \n [*artifacts*](https://genshin-impact.fandom.com/wiki/Artifact) by \n selecting the artifact \n [*set*](https://genshin-impact.fandom.com/wiki/Artifact/Sets) \n from the dropdown menu. \n \n\n13. Select the [*quality*](https://genshin-impact.fandom.com/wiki/Quality) \n associated with the \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) \n sought from the dropdown menu so that the possible \n [*levels*](https://genshin-impact.fandom.com/wiki/Artifact_EXP) are \n populated. \n \n\n14. Select the [*level*](https://genshin-impact.fandom.com/wiki/Artifact_EXP) \n of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) \n experience from the dropdown menu. \n \n\n15. Select the \n [*primary stat*](https://genshin-impact.fandom.com/wiki/Artifact/Stats) of \n the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from the \n dropdown menu and the statistics of the artifact will be calculated \n automatically. \n \n\n16. Select the \n [*secondary stats*](https://genshin-impact.fandom.com/wiki/Artifact/Stats) \n of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from \n the dropdown menu from each \n [*distribution*](https://genshin-impact.fandom.com/wiki/Artifact/Distribution) \n area. \n \n\n17. Enter the value associated with the \n [*secondary stats*](https://genshin-impact.fandom.com/wiki/Artifact/Stats) \n of the\n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from the \n dropdown menu from each \n [*distribution*](https://genshin-impact.fandom.com/wiki/Artifact/Distribution) \n area. \n \n\n18. Alternatively, import the statistics from \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) \n units from in-game screenshots by using the **SCAN** buttons beside the \n distribution areas. \n \n\n19. Load the in-game screenshot of the \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) units into \n interface using the **LOAD** button. \n \n\n20. Alternatively, the in-game screenshot of the \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) units can be inserted from the \n clipboard by pressing `CTRL` + `V`. \n \n\n21. Alternatively, the in-game screenshot of the \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) units can be inserted by using\n the drag and drop action. \n \n\n22. Please note that the *supported image formats* include, but are not limited to, the following. \n - Bitmap `[image/bmp]` `[BMP]`\n - Graphics Interchange Format `[image/gif]` `[GIF]`\n - Tagged Image File Format `[image/tiff]` `[TIF]`\n - Truevision TGA `[image/x-tga]` `[TGA]`\n - Open Document Drawing `[application/vnd.oasis.opendocument.graphics]` `[ODG]`\n - Icon `[image/x-icon]` `[ICO]`\n - Portable Network Graphics `[image/png]` `[PNG]`\n - Joint Photographic Experts Group `[image/jpeg]` `[JPG]`\n - WebP Image `[image/webp]` `[WEBP]`\n - Photoshop Document `[image/vnd.adobe.photoshop]` `[PSD]`\n\n23. Please note that the *unsupported image formats* include, but are not limited to, the following. \n - Scalable Vector Graphics `[image/svg+xml]` `[SVG]`\n - Encapsulated PostScript `[application/postscript]` `[EPS]`\n\n24. Confirm if the correct\n [Tesseract OCR](https://github.com/UB-Mannheim/tesseract/wiki) executable \n is selected by using the **LOCATE** button. \n \n\n25. Wipe the in-game screenshot of the \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) unit from the\n configuration area by using the **WIPE** button. \n \n\n26. Import the statistics of the detected \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) unit by using\n the **IMPORT** button. \n \n\n27. Wipe the statistics of the detected \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) unit by using\n from the configuration area by using the **WIPE** button. \n \n\n28. Wait for the statistics to be read from the in-game screenshot of \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) using Optical\n Character Recognition or OCR. \n \n\n29. Make corrections wherever the application was unable to correctly recognize\n statistics of the \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) before \n importing them. \n \n\n30. Confirm if better scanning results are obtained for the statistics \n of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from \n the *details screen*. \n \n\n31. Confirm if better scanning results are obtained for the statistics \n of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from \n the *inventory screen*. \n \n\n32. Confirm if better scanning results are obtained for the statistics \n of the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) from \n the *enhancement screen*. \n \n\n33. Alternatively, load the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) \n units from your local storage by using the **LOAD** buttons beside the \n distribution areas. \n \n\n34. Save the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) \n units to your local storage by using the **SAVE** buttons beside the \n distribution areas. \n \n\n35. Wipe the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) \n units from the configuration area by using the **WIPE** buttons beside the \n distribution areas. \n \n\n36. Read the \n [*artifact bonuses*](https://genshin-impact.fandom.com/wiki/Artifact/Sets) \n available to the character when using two pieces or four-pieces of a \n certain [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) \n set. \n \n\n37. Load the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)\n sets from your local storage by using the **LOAD** buttons beside the \n distribution areas. \n \n\n38. Save the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)\n sets to your local storage by using the **SAVE** buttons beside the \n distribution areas. \n \n\n39. Wipe the [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact)\n sets from the configuration area by using the **WIPE** buttons beside the \n distribution areas. \n \n\n40. Calculate the \n [*character*](https://genshin-impact.fandom.com/wiki/Character) potential \n with the equipped \n [*artifact*](https://genshin-impact.fandom.com/wiki/Artifact) units or sets \n and [*weapon*](https://genshin-impact.fandom.com/wiki/Weapon). \n \n\n41. View the calculations of the character potential on the newly created \n dialog box. \n \n\n42. View the \n [*help details*](https://raw.githubusercontent.com/gridhead/gi-loadouts/main/assets/docs/lcns.png) \n about the application by clicking on the **HELP** button from the user \n interface. \n \n\n43. View the \n [*info details*](https://raw.githubusercontent.com/gridhead/gi-loadouts/main/assets/docs/info.png) \n about the application by clicking on the **INFO** button from the user \n interface. \n \n\n44. View the [*homepage*](https://github.com/gridhead/gi-loadouts/) of the \n project by clicking on the **FORK** button from the user interface. \n \n\n45. Report software errors or feature requests by clicking on the **REPORT** \n button from the user interface. \n \n\n46. Donate to the [*project*](https://github.com/sponsors/gridhead) by \n clicking on the **HEART** button from the user interface. \n \n\n## Development\n\n### On GNU/Linux distributions\n\n1. Ensure that the necessary packages are available on the operating system \n installation.\n ```\n $ sudo dnf install git tesseract\n ```\n ```\n $ sudo dnf install python3 python3-pip python3-virtualenv poetry\n ```\n2. Clone your fork to the local storage and make it your current working \n directory.\n ```\n $ git clone https://github.com/gridhead/gi-loadouts.git\n ```\n ```\n $ cd gi-loadouts\n ```\n3. Create a virtual environment and activate it for installing project \n dependencies.\n ```\n $ virtualenv venv\n ```\n ```\n $ source venv/bin/activate\n ```\n4. Install the project dependencies after verifying the correctness of the \n configuration.\n ```\n (venv) $ poetry check\n ```\n ```\n (venv) $ poetry install\n ```\n5. Start the application after verifying that the dependencies have been \n installed.\n ```\n (venv) $ poetry show\n ```\n ```\n (venv) $ gi-loadouts\n ```\n6. Once done with making changes in a separate branch, make a pull request to \n contribute.\n\n### On Microsoft Windows\n\n1. Ensure that the necessary packages are available on the operating system \n installation.\n ```\n Git - https://git-scm.com/downloads\n Tesseract - https://github.com/UB-Mannheim/tesseract/wiki\n ```\n ```\n Python 3 - https://www.python.org/downloads/\n Poetry - https://python-poetry.org/\n ```\n2. Clone your fork to the local storage and make it your current working \n directory.\n ```\n PS > git clone https://github.com/gridhead/gi-loadouts.git\n ```\n ```\n PS > cd gi-loadouts\n ```\n3. Create a virtual environment and activate it for installing project \n dependencies.\n ```\n PS > py -m venv venv\n ```\n ```\n PS > .\\venv\\Scripts\\activate\n ```\n4. Install the project dependencies after installing the dependency management\n tools.\n ```\n (venv) PS > py -m pip install poetry\n ```\n ```\n (venv) PS > poetry install\n ```\n5. Start the application after verifying that the dependencies have been \n installed.\n ```\n (venv) PS > poetry show\n ```\n ```\n (venv) PS > gi-loadouts.cmd\n ```\n6. Once done with making changes in a separate branch, make a pull request to \n contribute.\n\n## Contribution\n\nYou can help our efforts by\n\n- **Star the project repository** \n Starring our project repository on GitHub not only helps us witness your \n support and boost the visibility for the project but it also motivates us \n to continue improving and expanding our efforts.\n\n- **Report the experienced errors** \n If you encounter any errors that should be taken care of, please file them \n as issue tickets on our issue tracker to help us identify problems as it is \n when we will be able to address the problems.\n\n- **Propose the intended features** \n If you have any ideas that should be introduced in the project, please file \n them as issue tickets on our issue tracker to help us understand the \n direction you want the project to take in the future.\n\n- **Document the project repository** \n Facilitating a comprehensive project documentation not only enhances the \n project repository but it also vital for the project's growth among users \n and project's approachability among developers.\n\n- **Write the project codebase** \n Consider opening a pull request against the project repository to contribute \n to the project codebase whether it is for fixing errors, adding features, \n amending documentation or modifying assets.\n\n- **Sponsor the project maintainers** \n By providing financial support, the maintainers have the means to dedicate \n more efforts into the development of the project codebase and ensure \n compatibility from each upcoming Genshin Impact release.\n\n## Disclaimer\n\nAll rights to Genshin Impact assets used in this project are reserved by \nmiHoYo Ltd. and Cognosphere Pte., Ltd.\n\nOther properties belong to their respective owners.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Loadouts for Genshin Impact",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://github.com/gridhead/gi-loadouts/blob/main/README.md",
"Homepage": "https://github.com/gridhead/gi-loadouts",
"Repository": "https://github.com/gridhead/gi-loadouts"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b6a09c2a73985b076e2a2fdd30f28ed535dac0ff372f743b45219f3dc2509b2",
"md5": "90198da78a0d2fc9dc0532bef5ed8a93",
"sha256": "c33c7c4de8fa0b0b3fb42b52620a991fa9ec8962e9c3a5ec4659ede4aa6aac22"
},
"downloads": -1,
"filename": "gi_loadouts-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90198da78a0d2fc9dc0532bef5ed8a93",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.12",
"size": 113876583,
"upload_time": "2024-11-25T07:16:33",
"upload_time_iso_8601": "2024-11-25T07:16:33.165313Z",
"url": "https://files.pythonhosted.org/packages/4b/6a/09c2a73985b076e2a2fdd30f28ed535dac0ff372f743b45219f3dc2509b2/gi_loadouts-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f2dc6759f5ae062fbc264ddd4d71eacb41ccc0e6d4c74806ed97b7b1795cf10",
"md5": "99a527a5b62f811ff9de21363966c878",
"sha256": "04a58dcf96e9c438fd5fa158e9c1cb73f44157e9bca49b1ee5ec444be665339e"
},
"downloads": -1,
"filename": "gi_loadouts-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "99a527a5b62f811ff9de21363966c878",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.12",
"size": 109638959,
"upload_time": "2024-11-25T07:16:50",
"upload_time_iso_8601": "2024-11-25T07:16:50.489279Z",
"url": "https://files.pythonhosted.org/packages/8f/2d/c6759f5ae062fbc264ddd4d71eacb41ccc0e6d4c74806ed97b7b1795cf10/gi_loadouts-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 07:16:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gridhead",
"github_project": "gi-loadouts",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "gi-loadouts"
}
JSON
