Basic Usage

#Welcome Welcome to Shuffle Move, here is the basic usage for the program from installation to completion of your first stage.

##Installation All source code is available here if you wish to compile it yourself. See here for instructions on building the program from source. ###Requirements The program requires Java 8 to run, please ensure that it has been installed before attempting to install or run Shuffle Move. Other than that, the program requires anywhere from 100MB to 3GB to run, depending on your settings and available resources. The more resources available, the more accurate the results. Note that if your system is very low end you should not set the number of instances in the program to anything above 30 or the simulation could take a long time.

###Download See the latest release from here and download the zip file to your computer.

###Extraction Extract the zip to a folder of your own choosing. I suggest a new folder called "Shuffle Move" in your documents or home folder.

###Execution

Depending on your operating system, you may be able to simply double click the Jar file to run the program. If you would like more selection in the save location, please see here. ####Windows Double click either the Shuffle Move vX.X.X.exe or Shuffle Move vX.X.X_portable.exe to start the program. Some virus scanners may scan or block it, please allow the program to run if you wish to use it. ####Linux and Macintosh Either run the jar using java -jar "Shuffle Move vX.X.X.jar" or use the launch.sh script mentioned here.

##Operation of the program

On launch, you are met with the simple, unmodified interface. To use the program in a basic approach, perform these steps:

###Configure your team and stage Either press the "Team" menu item, then Edit Team, or Press Ctrl-T to open the Team Editor.

In this window, select the stage you wish to play for, or the appropriate type name stage if it is not available. You can filter the stage list by typing in the small text box on the left of the stage chooser.

When you have selected the stage you want, continue on to add the species you want to the team.

You can add species by hitting the Add button, and remove them by pressing the "R" button. Special blocks and selection of the mega slot is also available here. If your stage is already in progress or you are using a mega start, set the mega progression here as well.

Once you are satisfied, press "OK".

###Updating the levels for your team

Either press Ctrl-R or Go to the "Roster" menu and select "Edit Roster".

The species here can be filtered like in the Team editor, but there is an additional option: Team Filter. Select the "Team" checkbox now.

Now, select the appropriate levels for each of the species in your team. For maxed species, select level 10. For species you do not own, set it to 0 (the default).

Once you are done, press "OK" to close the Roster Editor while applying your changes.

###Set your move preferences to match your hardware.

Open the Move Preferences Window.

Here, select the appropriate value for Simulations per move:

• For Low end machines, select a value between 5 and 20.
• For Medium spec machines, select a value between 10 and 50.
• For High end machines or very patient users, select a value between 50 and 300. I use a i5-4670k and I usually keep it at 100 for non-competition stages, and push it up to as much as 300 for serious competitions when I don't mind waiting 5-15 seconds for the very best result accuracy.

Note that if you set it too low, randomness will skew your results to be far different than reality most times. If you experience problems, try reducing the value and trying again. If the program crashes, please see the troubleshooting steps here.

You can also modify some other settings here, but most of these are for advanced users and beginners are recommended to leave them as-is until they are familiar with the program and the specifics about moves and stages in general.

When done, press "OK" to apply your changes and close the Move Preferences Window.

###Save your preferences, Team data, and Roster data.

Now, either press Ctrl-S or go to File, and select Save. This will save your work so far so you don't have to enter in their levels again unless they change.

###Fill the board to match the in-game state

Press tab at any moment to switch between entry modes.

####Paint Mode

Select the appropriate paint by either pressing the key-bind you configured in the Team Editor, or by clicking on them in the Paint Pallet. You can scroll the paint pallet by either controlling the scroll bar or by scrolling your mouse while inside the Paint Pallet.

Then, left click to apply the paint on grid cells on the board. Right click will erase a tile, and you can drag the mouse around to fill it up faster. Ctrl-F will fill the entire board with your selected paint if you wish, and Ctrl-Delete will clear the entire board for you (you can also select these functions from the Grid Menu).

Continue editing the board until it perfectly matches what you see in-game.

####Express Mode

In Express Mode, as you press the keybind for the appropriate paint it will apply it at the "selection" cursor, and advance it by one. The "freeze" cursor is always one behind the "selection" cursor. If you press "f" or "F" you will freeze or unfreeze the cell currently selected by the "freeze" cursor. This allows rapid entry of a grid without needing to click anything. You can navigate by doing the following: press backspace to move back one space, spacebar to move forward one space, navigate via the arrow keys. You can also move the cursor in this mode by left or right clicking in the grid.

###Select a move

By default, the Move Chooser is closed and the absolute top result is selected. You can do a move by simply pressing either Ctrl-Enter, or going to the Move menu and selecting "Do Move". You can undo or redo a move by pressing Ctrl-Z or Ctrl-Y, or by pressing the appropriate entry in the Move menu.

####Move Chooser

To open the Move Chooser, go to the Move Menu and press "Choose Move".

The following window will appear:

The contents of this panel will reflect in great detail the statistics about each move. You can move and resize this window to your own preference as it will save its position for future opening/launching during the session, and across sessions if you save the program.

You can select different grading modes to auto-sort the moves for you. Play around with these to get the best results, as you learn about what really matters for different stages. Note that the simulation is not perfect and it can't predict sky-fall randomness so your real results may differ. The values here depict the best that the simulation can gather given the information you have provided.

You also have some limited controls in this window like a "Do Move" button, but all focus will be sent back to the main window after doing a move regardless so you can continue to use normal hotkeys in the main window.

To perform a move in the game, you must pick up the species at the red block and drop it at the blue/purple block.

When you have selected a move in the Move Chooser, perform the move in your game and then you can do the move to apply the most likely result (Ctrl-Enter). Then you must go through the board with either entry mode and update it to fully reflect the in-game situation. Also note that you should update the score counter to match what you see in-game if you are using any species that might have an ability affected by the remaining health (Vitality Drain).

##Congratulations

You're now set to use the program in completing stages for Pokemon Shuffle! If you want to improve the wiki or tutorials, please feel free to contribute but keep in mind that this is meant to be for everyone so be respectful and informative.

##Feedback If you encounter problems, please do not hesitate to contact me as defined in the README.txt. For any bugs or feature improvements, see here to see if the issue already exists, or create a new issue here.

###Bug reports

####Creation of the Report

If you are unable to reach the bug report GUI in time, press Ctrl-B to instantly capture the current program state and file data. This will be saved in your save location's bugs directory.

Otherwise, please go to the Bug Report window.

Describe the issue in the text box, then press "Create Bug Report".

When created, the program will tell you exactly where it was saved in the alerts box. In the latest versions it will also attempt to open your desktop's file manager to the directory in which it was saved.

Finally, upload the zip at that path to a file sharing service like Google Drive and create a new issue on GitHub with a link to the zip

If you like, you can also contact me by the methods described in README.txt to help expedite matters.