Eclipse - TheG-Meister/pkc-mms-rando GitHub Wiki

The following contains a legacy guide from when pkc-mms-rando could only be run by modifying the source code. For instructions on how to run the latest release, see the Wiki homepage.

This guide demonstrates how to get pkc-mms-rando loaded and running in Eclipse, an integrated development environment for Java.

Download Java version 15+

First, make sure you have Java version 15 or greater.

Download and install Eclipse

Download Eclipse https://www.eclipse.org/downloads/
Run the installer
Make sure to install something that looks like Eclipse IDE for Java Developers
Point it at the downloaded JDK if necessary
Let eclipse install

Set up a workspace and import pkc-mms-rando

Launch Eclipse
Create a workspace folder on your system, and set it as your workspace in the Eclipse launcher
Select File > Import...
On Select, select Git > Projects from Git, and click Next
On Select Repository Source, select Clone URI and click Next
Copy the clone link for the repository, eg. https://github.com/TheG-Meister/pkc-mms-rando.git
Return to Eclipse, and on Source Git Repository, paste the link into URI and click Next
On Branch Selection, select a branch to clone and click Next
On Local destination, select or create a folder on your system to clone into and click Next
On Select a wizard to use for importing projects, select Import existing Eclipse projects and click Next
On Import Projects, select Finish

Set up pkc-mms-rando with Java

The imported project should be present in the Package Explorer on the left of the screen. If there is a red exclamation point in the bottom left of the project icon, perform the following steps.

Right click on the generated project and select Build path > Configure build path...
Select the Libraries tab
Under Modulepath there should be a Java Runtime Environment (JRE). Select this and click Edit...
Select the Execution environment radio button in the pop up window. If JavaSE-15 is present in the drop down menu, select it, select Finish, and then select Apply and Close. You can now move on to making a run configuration
Otherwise, select the Alternate JRE radio button. If the JDK you downloaded in the first step is present in the drop down menu, select it, select Finish, and then select Apply and Close. You can now move on to making a run configuration
Otherwise, select Installed JREs...
In the opened Preferences window, select Add...
On JRE type, select Standard VM and select Next
On JRE Definition, fill JRE home with the path to your downloaded JRE and select Finish
Select Apply and Close
In the Alternate JRE dropdown menu, select your new JRE and select Finish.
Select Apply and Close

Make a run configuration

Select Run > Run Configurations...
In Create, manage, and run configurations, select Java Application on the left.
Select New launch configuration in the top left.
In the Name box (right at the top of the window), enter a fitting name
Under Main class, click Search...
On Select Main Type, select Notes and click OK
Select the Arguments tab, and paste in ${folder_prompt} ${folder_prompt} ${string_prompt} ${string_prompt} ${string_prompt}
Select Apply, and Close

Run the configuration

Before running pkc-mms-rando, it needs a pret/pokecrystal style pokemon crystal disassembly to work from. Find and download one yourself. On GitHub, this can be done by going to the repository's web page, selecting Code, and selecting Download ZIP. Extract the downloaded ZIP file somewhere. Then we are ready to run the configuration:

At the top of the screen, select the drop-down menu next to the green play button, and select the run configuration you named in the step above. The subsequent pop-up windows then take each argument to the command-line program in order:
In the first pop-up window, select the downloaded disassembly. Keep clicking through folders until you see folders named audio, constants, data etc., and then select Select Folder
In the second pop-up window, select a folder in which to store the output files.
In the third pop-up window, type true to randomise music pointers, else type false (race safe)
In the fourth pop-up window, type true to randomise SFX pointers, else type false (race safe)
In the fifth pop-up window, type true to randomise some warps, else type false (not race safe)
Finally, check the output folder for files.