Skip to content

Commit

Permalink
rewrite into rust
Browse files Browse the repository at this point in the history
  • Loading branch information
dromzeh committed Jun 20, 2023
1 parent e22a00b commit f8027a7
Show file tree
Hide file tree
Showing 9 changed files with 338 additions and 176 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Build Executable

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

env:
CARGO_TERM_COLOR: always

jobs:
build:
runs-on: windows-latest
steps:
- uses: actions/checkout@v2
- name: Build
run: cargo build --verbose --release
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
/node_modules/
/.vscode/
/.vscode/

# Added by cargo

/target
220 changes: 220 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[package]
name = "hi3-fps-unlocker"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
serde = { version = "1.0", features = ["derive"] }
winreg = "0.50.0"
serde_json = "1.0"
hex = "0.4"
termcolor = "1.2.0"
31 changes: 6 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,25 @@
<p align = "center">
<a href="https://buymeacoffee.com/marcelmd" alt="buymeacoffee">
<img src="https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black"/></a>
<a href="https://nodejs.org" alt="node js">
<img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white" /></a>
<a href = "https://pnpm.io/installation" alt = "pnpm">
<img src = "https://img.shields.io/badge/pnpm-%234a4a4a.svg?style=for-the-badge&logo=pnpm&logoColor=white"></a>
<a href = "https://javascript.com" alt = "javascript">
<img src = "https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=white"></a>
</p>

# hi3-fps-unlocker

Program that allows you to modify the fps of Hi3 in and outside of levels to any value of your choice.
Read the blog post about this project [here](https://dromzeh.dev/posts/hi3-fps-unlock/).

> **Note**:
> Because you're modifying the registry, changing your options in-game will reset the fps to the value you set in-game. To change the fps again, you will have to use this program again.
> Because you're modifying the registry, changing your options in-game will overwrite the fps to the value you set in-game. To change the fps again, you will have to re-run the program.
If you're looking for a Honkai: Star Rail unlocker, check out [hsr-fps-unlocker](https://github.com/dromzeh/hsr-fps-unlocker)

> **Warning**:
> I am not responsible for any consequences that may occur from using this program. Use at your own risk.
## Installation
## Usage

- `git clone` or Download this repository.
- Install pnpm & node.js:
## From the releases page

```bash
npm i -g pnpm # if installing pnpm using npm
```
- Download the latest release, then run `hi3-fps-unlocker.exe`

## Usage
## Building

- Open a terminal in the `hi3-fps-unlock` directory.
- If you are using the program for the first time, run `pnpm i`. This will install the required dependencies.
- Run `pnpm start` to run the program, follow the instructions in the CLI.

> **Note**:
> You do **NOT** have to run this as administrator.
- `cargo build --release`

## Contributing

Expand Down
Loading

0 comments on commit f8027a7

Please sign in to comment.