Skip to content

Commit

Permalink
Update V1.2.0 (#5)
Browse files Browse the repository at this point in the history
* genshin 4.3

* Update package.json

* Fix new scroll reset action

* update README(s)
  • Loading branch information
Jugbot authored Jan 6, 2024
1 parent 2d41ecd commit 5bf518e
Show file tree
Hide file tree
Showing 27 changed files with 2,897 additions and 2,327 deletions.
1 change: 1 addition & 0 deletions .electron-builder.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ module.exports = function () {
files: ['packages/**/dist/**'],
extraMetadata: {
},
extraResources: 'resources',
win: {
requestedExecutionLevel: 'requireAdministrator',
target: [
Expand Down
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ TODO
- [x] Artifact end of list detection
- [x] Artifact card string formatting
- [x] Artifact card lock state
- [ ] Update read artifacts when locking to reflect new lock status
- [x] Update read artifacts when locking to reflect new lock status
- [ ] Tooltips, hovers
- [ ] Pause on _any_ keyboard press (+resume??/stop)
- [x] Dropdown
Expand All @@ -14,10 +14,9 @@ TODO
- [x] 16:9 (1920×1080), 16:10 (1920×1200)
- [ ] Adding screen resolutions readme
- [ ] Install instructions + images
- [ ] Bundle sharp, tesseract
- [x] Bundle sharp, tesseract
- [ ] Save settings in local storage
- [x] GL window icon
- [ ] remove this list and publish :)
Stretch:
Expand Down Expand Up @@ -49,7 +48,7 @@ Fun:
-->

![App Screenshot](https://user-images.githubusercontent.com/5402388/227738305-8b05f3e3-0909-48dc-a7b6-545003c64c58.png)
![App Screenshot](https://github.com/Jugbot/genshin-locker/assets/5402388/4d9746c2-70e7-4de1-bbab-552cffff3542)

# Genshin Artifact Locker

Expand All @@ -61,8 +60,7 @@ Download the latest [release](https://github.com/Jugbot/genshin-locker/releases)

- [x] Automatically read artifact data from the game.
- [x] Choose artifacts based on various criteria. Artifacts will be locked or unlocked to make for easy disposal in-game.
- [x] Popularity in crowdsourced builds from [Lineup Simulator].
- [x] Mainstat / substat rarity.
- [x] You can write your own custom script using the example bundled with the app.
- [x] Supports any screen resolution.
- [x] Export artifacts to other popular tools such as [Genshin Optimizer].
- [x] Light mode for freaks.
Expand All @@ -71,22 +69,25 @@ Download the latest [release](https://github.com/Jugbot/genshin-locker/releases)

- [ ] Character & weapon scanning.
- [ ] Gamepad support.
- [ ] More filter methods.

### Usage

1. Open Genshin Impact. Make sure you don't have hdr enabled and that the controls are set to keyboard.
2. Open the artifact tab. From here you can apply any in-game filters to specify what artifacts to parse.
3. You can edit the logic determining which components to lock in the left pane. Usually you would run the scanner first in "Scan" mode and then preview changes in logic in the right pane.
3. You can change the logic determining which components to lock by editing the script `example.js`. Usually you would run the scanner first in "Scan" mode and then preview changes in logic in the right pane.
4. Run the scanner. Press [SPACE] to stop the scanning early.
5. If need be, you can export the scanned artifacts in GOOD format.
5. If need be, you can export the scanned artifacts in GOOD format via the button in the upper right.

### Dev Setup

1. Do the usual git clone.
2. This project uses native node modules, so you will need to have a compiler installed if you don't already.
3. This is a yarn project, so run `yarn` to set up. I have pinned the node environment to `v16.x.x` so you might need to install node too. Of course if you have a node version manager this is easy.
4. Start the application with `yarn start` IN ADMINISTRATOR MODE or run through elevated vscode.
4. Start the application with `yarn start` IN ADMINISTRATOR MODE or run through elevated vscode using [F5].

### Screen resolution not supported?

Either file an issue or add it yourself via the [README](./packages/automation/src/landmarks/README.md).

[Lineup Simulator]: https://act.hoyolab.com/ys/event/bbs-lineup-ys-sea/index.html
[Genshin Optimizer]: https://frzyc.github.io/genshin-optimizer
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "genshin-locker",
"private": true,
"productName": "genshin-locker",
"version": "1.1.1",
"version": "1.2.0",
"description": "Genshin artifact scraper and manager",
"main": "packages/main/dist/index.cjs",
"scripts": {
Expand Down
10 changes: 1 addition & 9 deletions packages/automation/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
# `automation`

> TODO: description
## Usage

```
const automation = require('automation');
// TODO: DEMONSTRATE API
```
For adding custom screen resolution support see the [landmarks README](../src/landmarks/README.md).
Loading

0 comments on commit 5bf518e

Please sign in to comment.