How to use

Introduction to the UI

After running the .jar file of the program you are greeted with a list of available commands. The available commands are limited to the main class used in the .jar file. By default this is the ProductionUI.

You are now prompted to enter a command from the list. A command description is already present next to the command itself. For a more detailed explanation about what a command does visit the Command Page of this wiki.

Entering a command can be done in two different ways, although only one is accessible at the moment. The UI runs either in interactive or batch mode. By default the UI runs in batch mode and can not be changed for now.

Interacting with the UI in batch mode

Entering a command from the given list will often not be enough. Certain commands require arguments in a specific format. The exact arguments are listed in the Command Page of this wiki. The general format is:

command arg1 arg2 ... argN

All arguments have to be present when trying to execute the command. Missing or invalid arguments will fail the execution. After the command executed successfully or failed, another command can be entered.

Interacting with the UI in interactive mode

For now this mode is unusable. However it can be used by changing the value of the isInteractive variable in the SharkMessengerUI class. Doing so will use the Questionnaire to obtain arguments instead of providing them when issuing the command. When using the Questionnaire only the command name needs to be entered. Following, the user is asked questions in regards to obtaining the needed arguments. After answering all questions the command executes.