Skip to content

Commit

Permalink
General: Update README.md, Created file with available shortcuts ("he…
Browse files Browse the repository at this point in the history
…lp.txt") and updated compiler script
  • Loading branch information
themitosan committed Jun 15, 2023
1 parent 2dd0944 commit ae9a596
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 3 deletions.
2 changes: 1 addition & 1 deletion App/package.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"hash":"","version":"1.1.1","main":"index.htm","author":"TemmieHeartz","name":"R3 Auto Map Gen","license":"GPL-2.0-only","description":"This app creates an node-conected map on the go for Resident Evil 3 classic.","window":{"frame":true,"width":1130,"height":692,"toolbar":false,"min_width":1130,"min_height":692,"fullscreen":false,"position":"center","theme-color":"#200","icon":"img/icon.png","title":"R3 Auto Map Gen."}}
{"hash":"","version":"1.2.0","main":"index.htm","author":"TemmieHeartz","name":"R3 Auto Map Gen","license":"GPL-2.0-only","description":"This app creates an node-conected map on the go for Resident Evil classic games.","window":{"width":1130,"height":740,"frame":false,"toolbar":false,"min_width":196,"min_height":226,"fullscreen":false,"transparent":true,"position":"center","theme-color":"#200","icon":"img/icon.png","title":"R3 Auto Map Gen."}}
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ _...Do you have heard about the word of **[BioRand](https://github.com/IntelOrca

Also - You can visualize generated files using [R3 Auto Map View](https://themitosan.github.io/R3AMV/) on our browser!

## Shortcuts

You can find a list with all available shortcuts on `help.txt`.

## External plugins on this project
- [memoryjs](https://github.com/rob--/memoryjs) from [Rob--](https://github.com/rob--/)

Expand Down
6 changes: 4 additions & 2 deletions compile.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,14 @@ module.exports = {

// Get licence and readme files
const license = fs.readFileSync('./LICENSE', 'utf8'),
readme = fs.readFileSync('./README.md', 'utf8');
readme = fs.readFileSync('./README.md', 'utf8'),
help = fs.readFileSync('./help.txt', 'utf8');

// Run nw-builder
compileData.build().then(function(){

// Copy license and readme to build dir
// Copy required files to build dir
fs.writeFileSync('./build/R3 Auto Map Gen/win64/help.txt', help, 'utf8');
fs.writeFileSync('./build/R3 Auto Map Gen/win64/LICENSE', license, 'utf8');
fs.writeFileSync('./build/R3 Auto Map Gen/win64/README.md', readme, 'utf8');
fs.writeFileSync('./version.txt', 'Version: ' + packageJson.version, 'utf8');
Expand Down
21 changes: 21 additions & 0 deletions help.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
-- General Shortcuts

[F1] Show about window
[Alt] Toggle between drag canvas or current map
[F7] Center current map
[F8] Reset canvas zoom
[F9] Reset map
[F10] Reload latest saved / loaded map
[Delete] Delete saves from selected game

-- Global Shortcuts

[Ctrl+Shift+S] Save current map (if map already exists on destination folder, it will update it)
[Ctrl+F7] Center current map
[Ctrl+F8] Reset canvas zoom
[Ctrl+F9] Reset map
[Ctrl+F10] Reload latest saved / loaded map
[Ctrl+Delete] APP.options.delGameSaveFiles();
[Ctrl+Shift+R] Run game
[Ctrl+Shift+H] Hook game process
[Ctrl+Shift+Q] Restore right menu

0 comments on commit ae9a596

Please sign in to comment.