Skip to content

Commit

Permalink
upd notice, known issues readme section
Browse files Browse the repository at this point in the history
  • Loading branch information
dromzeh committed Aug 17, 2023
1 parent b4241f1 commit c349ae6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Read the blog post about this project (For Hi3 unlocking) [here](https://dromzeh
> **Warning**:
> **I am not responsible for any consequences that may occur from using this program.** Use at your own risk.
## Download and Usage
## Download & Usage

## From the releases page

- Download the latest release from [the releases page](https://github.com/dromzeh/hyv-fps-unlocker/releases)
- Run`hyv-fps-unlocker.exe` and follow the instructions.
- Run `hyv-fps-unlocker.exe` and follow the instructions.

## Building

Expand All @@ -24,12 +24,19 @@ Read the blog post about this project (For Hi3 unlocking) [here](https://dromzeh
- Run the built executable in `./target/release/hyv-fps-unlocker.exe`.

**You don't have to run the program as Administrator**, if you're having issues, you can try running it as Administrator.
Alternatively, create an issue.

## Known Issues

### Registry Issues [Can't be fixed]

- Modifying the registry values **will NOT work if you have the game open.**
- The game **will overwrite the registry values if you change the FPS in-game.**
- **Options menus for games may not work as intended** after modifying the registry values.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Pull requests are welcome. For major changes, please open an issue first.

## License

Licensed under [MIT](https://mit.dromzeh.dev/) - see [LICENSE](LICENSE) for more information.
hyv-fps-unlocker is licensed under [MIT](https://mit.dromzeh.dev/) - see [LICENSE](LICENSE) for more information.
6 changes: 5 additions & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ fn main() {

fn run_program() -> Result<(), Box<dyn Error>> {
println!("hyv-fps-unlocker @ git.dromzeh.dev/hyv-fps-unlocker");
println!("Your registry files will be modified to unlock FPS, if you are not comfortable with this, please do not continue.");
println!("This program is provided as-is, without any warranty. Use at your own risk.");
println!(
"Do not use this program if you are not comfortable with modifying your registry files."
);
println!("Modifying registry values while the game is running will prevent the program from working as intended.\n");
let game = game_selection::get_game_selection()?;
let (reg_key_path, value_name_contains) = registry_info::get_registry_info(&game)?;
let raw_value = registry_info::get_raw_value(&reg_key_path, &value_name_contains)?;
Expand Down

0 comments on commit c349ae6

Please sign in to comment.