Merge pull request #6 from SCHREDDO/releases/2.0.0

Update Project to v2.0.0

CHANGELOG.md

@@ -1,15 +1,61 @@
 # Changelog
+## = 2.0.0 March 26th 2019 =
+### Added
+- new setting: dmg_template
+- new setting: show_max
+- new setting: sort_by
+- new setting: check_version
+- new setting: new_version_browser
+- add a possibility (setting: sort_by) to order by `name`
+- add a possibility (setting: sort_by) to order by `dmg`
+- add a possibility (setting: sort_by) to order by `dps`
+- add a possibility (setting: sort_by) to order by `dot_dmg`
+- add a possibility (setting: sort_by) to order by `crit_dmg`
+- add a possibility (setting: sort_by) to order by `action_time`
+- add a possibility (setting: sort_by) to order by `skill_count`
+- add a possibility (setting: dmg_template) to modify the output pattern for the `dmg show/copy` command
+- add pattern placeholder `<player>`
+- add pattern placeholder `<dmg>`
+- add pattern placeholder `<dps>`
+- add pattern placeholder `<dot_dmg>`
+- add pattern placeholder `<crit_dmg>`
+- add pattern placeholder `<used_skills_count>`
+- add pattern placeholder `<time>`
+- new command: dmg
+- new command: settings
+- add possibility to check for a new version (command: info)
+- add possibility to open download page for new version (command: info)
+- new parameter (`-a`) to define the wanted info from the command: info
+- new parameter (`-r`) to define the wanted info from the command: info
+- new parameter (`-v`) to define the wanted info from the command: info
+- new parameter (`-c`) to define the wanted info from the command: info
+### Changed
+- rework the backbone of the command system
+- rename setting: languarge to language
+- updated all help command outputs
+### Removed
+- remove command: goto
+- remove command: back
+- remove damage (path: dmg) command: create
+- remove damage (path: dmg) command: list
+- remove damage (path: dmg) command: show
+- remove damage (path: dmg) command: copy
+- remove settings (path: settings) command: show
+- remove settings (path: settings) command: edit
+- remove settings (path: settings) command: save
+- remove settings (path: settings) command: undo
 ## = 1.0.0 March 26th 2019 =
 ### Added
 - add language support for english
-- new settings (path: settings) command: languarge
+- new base setting: languarge
 - new damage (path: dmg) command: reset
 - new damage (path: dmg) command: delete
 ## = 0.5.0-alpha March 25th 2019 =
 ### Added
 - new base setting: check_chatlog_active
 ## = 0.4.0-alpha March 25th 2019 =
 ### Added
+- new base command: chatlog
 - new base setting: aion
 ### Changed
 - changed base command: info (optical change)

COMMANDS.md

@@ -1,128 +1,153 @@
 # Commands
 
-| Name | Description | Path |
-|------|-------------|------|
-|[goto](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-goto)|go to path x||
-|[chatlog](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-chatlog)|set chatlog active||
-|[back](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-back)|go back to main path||
-|[clear](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-clear)|cleared the console||
-|[info](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-info)|informations about NerdyAion||
-|[help](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-help)|shows commands and paths||
-|[bye](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-bye)|close NerdyAion||
-|[create](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-create)|create a dmg chatlog pointer|dmg|
-|[reset](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-reset)|reset the dmg chatlog pointer x|dmg|
-|[delete](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-delete)|delete the dmg chatlog pointer x|dmg|
-|[show](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-show)|shows dmg informations from pointer x|dmg|
-|[copy](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-copy)|copy dmg informations from pointer x|dmg|
-|[show](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-show)|list of settings|settings|
-|[edit](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-edit)|edit a setting|settings|
-|[save](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-save)|saved changes from settings|settings|
-|[undo](https://github.com/SCHREDDO/NerdyAion-Aion-Tool-Manager/blob/master/COMMANDS.md#command-undo)|reset the last changes|settings|
-
-# Base Commands
-## Command "goto"
-Sets the activ path to the path `<path>`.
-```console
-goto <path>
-```
-Arguments:
-- `path` the path
-## Command "chatlog"
-Sets chatlog active.
+| Name | Description |
+|------|-------------|
+| [info](#command-info) | information about NerdyAion |
+| [help](#command-help) | shows commands and information |
+| [clear](#command-clear) | clears the console |
+| [settings](#command-settings) | handling settings |
+| [dmg](#command-dmg) | provides damage information |
+| [chatlog](#command-chatlog) | activate or deactivate the chatlog |
+| [bye](#command-bye) | close NerdyAion |
+
+## Command "info"
+Displayed information about the used application.
+
+Syntax:
 ```console
-chatlog <option>
+info [-a | -r | -v | -c]
 ```
 Arguments:
-- `option` option for chatlog (options: on)
-## Command "back"
-Sets the activ path to the main path
-```console
-back
-```
-## Command "clear"
-Cleared the console.
-```console
-clear
-```
-## Command "info"
-Shows informations about NerdyAvion
+- `-a`: shows only the author of the application
+- `-r`: shows only the repository of the application
+- `-v`: shows only the version of the application
+- `-c`: checks if there is a new version available
+
+Example:
 ```console
 info
+info -v
 ```
+
 ## Command "help"
-Shows a list of commands and paths or informations about a the `<command>`.
+Provides information about commands. If used without parameters a lists of all commands are displayed without a briefly description.
+
+Syntax:
 ```console
 help [command]
 ```
 Arguments:
-- `command` the command
-## Command "bye"
-Closes NerdyAion.
+- `command`: the command you wish to receive more information about
+
+Example:
 ```console
-bye
+help
+help dmg
 ```
-# Damage (Path: dmg) Commands
-## Command "create"
-Create a pointer (start point) for the analyzing with the given name `<pointer name>`.
+
+## Command "clear"
+Deletes the display information of the current console window.
+
+Syntax:
 ```console
-create <pointer name>
+clear
 ```
-Arguments:
-- `pointer name` the pointer name
-## Command "reset"
-Reset the pointer `<pointer name>`.
+Example:
 ```console
-reset <pointer name>
+clear
+```
+
+## Command "settings"
+For handling application settings.
+
+Syntax:
+```console
+settings <show | edit | save | undo | reset> [-s] [setting] [value]
 ```
-Arguments:
-- `pointer name` the pointer name
-## Command "delete"
-Delete the pointer `<pointer name>`.
 ```console
-delete <pointer name>
+settings show
+settings edit [-s] <setting> <value>
+settings save
+settings undo
+settings reset
 ```
 Arguments:
-- `pointer name` the pointer name
-## Command "list"
-Shows all pointer.
+- `show`: shows all settings and values
+- `edit`: edit the `<setting>` with the new value `<value>`
+- `save`: saved changes from settings
+- `undo`: reset the last changes from settings, only if not saved
+- `reset`: reset the last changes from settings, only if not saved
+- `-s`: for saving instantly
+- `setting`: which setting is to be changed
+- `value`: what value the setting should be set to
+
+Example:
 ```console
-list
+settings show
+settings edit language EN
+settings edit -s language DE
+settings save
+settings undo
+settings reset
 ```
-## Command "show"
-Shows dmg informations from pointer `<pointer name>`.
+
+## Command "dmg"
+For handling damage information.
+
+Syntax:
 ```console
-show <pointer name>
+dmg <add | list | clear | remove | show | copy> [pointer name]
 ```
-Arguments:
-- `pointer name` the pointer name
-## Command "copy"
-Cpy the dmg informations from pointer `<pointer name>`.
 ```console
-copy <pointer name>
+dmg add <pointer name>
+dmg list
+dmg clear <pointer name>
+dmg remove <pointer name>
+dmg show <pointer name>
+dmg copy <pointer name>
 ```
 Arguments:
-- `pointer name` the pointer name
-# Settings (Path: settings) Commands
-## Command "show"
-Shows all settings an values.
+- `add`: add a pointer (start point) for the analyzing with the given name `<pointer name>`
+- `list`: shows all pointer.
+- `clear`: reset a given pointer
+- `remove`: remove a given pointer
+- `show`: Shows damage information of a given pointer
+- `copy`: Copy damage information of a given pointer
+- `pointer name`: the pointer name
+
+Example:
 ```console
-show
+dmg add boss
+dmg list
+dmg clear boss
+dmg remove boss
+dmg show boss
+dmg copy boss
 ```
-## Command "edit"
-Edit the `<setting>` with the new value `<value>`.
+
+## Command "chatlog"
+Activate or deactivate the Aion chatlog. Aion is not allowed to run for this process.
+
+Syntax:
 ```console
-edit <setting> <value>
+chatlog <option>
 ```
 Arguments:
-- `setting` which setting is to be changed
-- `value` what value the setting should be set to 
-## Command "save"
-Saved changes from settings.
+- `option`: on or off
+
+Example:
+```console
+chatlog on
+```
+
+## Command "bye"
+Closes the application.
+
+Syntax:
 ```console
-save
+bye
 ```
-## Command "undo"
-Reset the last changes from settings.
+Example:
 ```console
-undo
-```
+bye
+```