Setting Up Dev Environment

If you are interested in making modifications to the Replays mod, this page will help you get started. Before you begin, I recommend using Visual Studio Code as your IDE if you are a novice with Node.js and npm.

Note: I will assume you have a basic understanding of Node.js and npm usage, and also have them installed already.

1. Designate a folder to be the main project folder.
2. Navigate to C:\Users\{YOUR USER}\AppData\Local\Plays\
3. Open the folder with the highest app version (ex: app-3.0.1)
4. Copy C:\Users\{YOUR USER}\AppData\Local\Plays\app-3.0.1\resources\app.asar to your main project folder.
5. Extract app.asar to your main project folder. I recommend using 7-zip and this plugin.

• 

6. After extracting, you should get something like this:

• 

7. Now open up your main project folder in Visual Studio Code and open up the terminal.

• 

8. Type the command npm init -f and hit enter

• 

9. Next, type the command npm install and hit enter
10. Next, type the command npm install -g electron-forge and hit enter
11. Next, type the command npm install -g cross-env and hit enter
12. Next, type the command electron-forge import and hit enter
13. It will ask you a couple of questions, answer them accordingly:

• ? WARNING: We will now attempt to import: "F:\main project folder". This will involve modifying some files, are you sure you want to continue? Yes

  ? Do you want us to change the "main" attribute of your package.json? If you If you are currently using babel and pointing to a "build" directory say yes. Yes

  ? Enter the relative path to your uncompiled main file src/main/main.js

  ? Do you want us to update the "start" script to instead call the electron-forge task "electron-forge start" No

15. Delete the .cache folder:

• 

16. Navigate to the replays folder:

• 

17. You can now make changes in the replays folder.

• Fetch the contents of https://github.com/lulzsun/RePlaysTV/tree/master/src to the replays folder to stay up to date with the master branch

18. To run/test the dev client, start it with the command npm run start or through here:

• 

19. You should now be ready for development. Good luck!