/ChroniCalc

A character planner application for the action-rpg Chronicon

Primary LanguageC#

ChroniCalc - An offline build planning tool for the Action RPG ChroniCalc
=======

---

## Installation

### Prerequisites
 * An internet connection to download the installer (the application can then be used offline)
 * .NET Framework 4.5.2 or greater; this can be installed from Microsoft.com via their [Online Installer](https://www.microsoft.com/en-us/download/details.aspx?id=42643) or [Offline Installer](https://www.microsoft.com/en-us/download/details.aspx?id=42642).
 * Windows OS (usage on other operating systems has not been tested and is currently not directly supported)

### Steps
1. Navigate to the [Releases page](https://github.com/MidwestSteeze/ChroniCalc/releases) of the ChroniCalc GitHub repository
2. Find the most current Release located at the top of the list of Releases
3. Expand the Assets drop-down
4. Click to download "setup.exe"
5. Open "setup.exe" once it has finished downloading and follow the on-screen instructions
	* NOTE: You will see a notification at the beginning of installation stating the application is not from a Trusted Publisher.  To at least confirm the executable was generated by Me, right-click setup.exe and select Properties --> Digital Signatures.  Ensure my GitHub username is listed as the Name of signer.
6. Installation is complete.  You may now run ChroniCalc from your Start Menu.

---

## Features
* **Builds**
	* **Create**: Create a new Build from scratch with the maximum number of Skill Points available and a full Mastery tree.
	* **Save**: Save your Build to your local hard drive so you can reference or modify it later.
	* **Load**: Load your Build for further reference or modification.
	* **Share**: Share your Build with other players by uploading it to Pastebin.  A perfect way to provide additional information in your Build Guides.
	* **Import**: Import your Build directly from Chronicon by selecting the ".build" file created by NPC Korem after performing his "Export Character Build" function.
	* **Export**: Export your Build and copy it to the location listed below to be able to import it directly into Chronicon by speaking with NPC Korem and performing his "Import Character Build" function.
		* C:\Users\username\AppData\Local\Chronicon\save\builds

## Additional Usage Tips
 * **Left-click**: Increase level of the selected Skill by 1
 * **Control + Left-click**: Increase level of the selected Skill by 5
 * **Shift + Left-click**: Increase level of the selected Skill by 20
 * **Control + Shift + Left-click**: Decrease level of the selected Skill by 1
 * **Right-click**: Open the Skill selection menu, if available
 
 ---
 
# Technical
 
## Internal and External Input/Output
Below is a list of all internal (local) and external (network) access this program may be performing during its use.  This is being documented to provide additional transparency of "what is this program doing that I may not know about?" for those who do not review the source code.

**Internal:**
 * **File Read/Write**:  Saving and Opening Builds will utilize local File Read and Write functions in order to persist your Builds.
	* NOTE: The only file location being directly read/written is "%UserProfile%\Documents\ChroniCalc\\"

**External:**
 * **Text Upload/Download**:  Sharing Builds uses https://pastebin.com for storage and retrieval of serialized Build data in string format.
 
## Reporting Bugs

Error messages and/or screenshots can be reported in the following ways:  
  * **Reddit**: New posts can be made with the "[BUG]" tag in the [ChroniCalc subreddit](https://www.reddit.com/r/ChroniCalc)