Installation

To install or update the game, simply follow the steps below. If you run into any issues, reach out on Discord or the Subreddit. If you need help locating your save file check out this guide.

## Windows

### Save File Location

With any Windows install all saves are stored in appdata/renpy/championofrealms. This means you can safely delete any versions and the saves will persist.

### **Launcher**

The easiest way to install the game on windows is to use the Official Launcher. This will patch and update the game automatically, so no need to re-download the entire game every update. It will also be the first to receive bug fixes, and may receive some that are not fixed until the next release on other platforms.

#### Install

1. Download the Installer
2. Run the Installer
3. Accept the License Agreement
4. Choose install location (Default is C:/users/[username]/Champion of Realms
5. Chose if you would like a Desktop Shortcut or a Start Menu Shortcut
6. Once it has finished installing leave the box checked to run the patcher to finish installing the game
	1. The installer alone will NOT install all of CoR. It only installs the launcher and base renpy libraries. You MUST run the patcher at least once before the game will be playable.
	2. Note: This will take some time as the game is 12+GB. It may appear as though it is stuck on 30-35% for some time. Please allow the patching process to complete before attempting to start the game.

#### Updating

1. Hit Check for Updates
2. Wait for patch to install

### Itch

The Itch deskop client will allow you to install and update the game automatically (note due to the build surpassing 4gb it is ONLY the compressed version).

1. Install Itch desktop client
2. Sign in
3. Search for Champion of Realms
4. Press install at the bottom
5. Choose compressed or normal version
6. Select install location or create a new one
7. Hit Install
8. When finished hit Run

#### Updating

The game will be updated automatically if enabled, otherwise when you launch it will prompt you to install the new version.

### Manual

If you wish to install the game manually download it from one of several locations

* Patreon (Always the first to be updated)
	+ Note: these are public links, you do not need to be a patreon, or have an account to access. Downloads are hosted on Mega and Mediafire
* Website
* Itch (Only compressed version)

1. Extract the zip to a location of your choosing
2. Enter extracted folder
3. Click on ChampionOfRealms.exe

#### Updating

1. Download the new version
2. Extract it to a new location
	1. Do NOT extract to the same location and replace files, this is known to cause issues
3. Delete the old version

## Android

### Save File Location

The saves are stored in a variety of locations.

APK before CoR 0.79: Android/Data/com.zimon.chamoionofrealms/files

APK on CoR 0.79 or later: Documents/Zimon/com.zimon.championofrealms/files

Joiplay: Wherever you extracted the game to/game/saves

NoticeAs of version 0.77 released April 5th, 2023, CoR is now too large to be built into a traditional APK.
### APK

As of version 0.77, CoR is now too large to be built into an APK file with all assets included. Compressing the game from 12+ GB to under the 2GB limit is impractical. This means the game is now split into an APK file, and the assets directory, which must be placed according to the instructions below.

1. Download the zip
2. Extract the game folder and the APK from the zip with the file manager. Remember where you extract them to.
3. Install the APK like you would any other app.
	1. Do NOT open the APK. If you see things like 'androidmanifest.xml' you are inside the apk.
4. Move the `game` folder into this path `/Documents/Zimom/com.zimon.championofrealms/`.
	1. Note: It \*\*MUST\*\* be this path exactly, or the game will not work.
	2. If this path does not exist run the APK once, until you see the traceback/exception screen. This will generate the folder.
	3. Force Close the Game
	4. Repeat Step 4 and move the game folder into the newly created folder in Documents
5. Navigate to '/Documents/Zimon/com.zimon.championofrealms/game' and ensure you see the files (script.rpa, etc.). If this directory is empty or non existent, you extracted to the wrong location.
6. Play and enjoy!

#### Updating

1. Copy your saves from `Documents/Zimon/com.zimon.championofrealms/files` to a safe place
2. Delete the game folder (the one you placed in the install step)
3. Follow the install steps above
4. Re-add your save files

### Joiplay

Joiplay is an emulator for running the Windows version of CoR on Android. This is an alternative to the APK+ game folder described above. For steps 4-8 there is a video guide available: https://www.youtube.com/watch?v=DwZIdFmKNuE

1. Download Joiplay and the Joiplay Renpy plug-in from their website. The version found on the Google Play store will NOT work as it does not support Ren'Py 8.0.
2. Download the PC version of CoR from the links above (Must be the .zip files as the Launcher is not compatibly with Joiplay).
3. Extract the .zip file with the RAR app or any other zip extraction app.
	1. After extracting CoR's folder from the .zip, remember where it's located, because the following steps involve the folder location.
4. Open game folder, find game.exe file (not 32.exe) and then just press on it, you will see options what app you want to use to open it, choose JoiPlay.
6. For the name, you can enter "Champion of Realms" and for the version just the current update number (ex. 0.46).
7. For the icon, the app will find it automatically.
8. Lastly, tap Add after you've finished steps 5-7.
9. You're good to go. Enjoy CoR on Mobile.

#### Updating

1. Go to your CoR folder and move the saves file to somewhere safe before proceeding to step 2.
2. Delete the game through JoiPlay (press and hold the game, and choose delete option) or any file manager,
3. Do steps 2-8 from the Installation Method.
4. After doing steps 2-8, go back to where you moved your saves file and copy/move it to the new updated CoR folder to where the .exe files are located.
5. Open CoR to see if it works.
6. After that you're good to go. Enjoy CoR.

#### Transfering saves from APK

To transfer your saves from an APK install to Joiplay follow the instructions below

1. Go to Android/Data/com.zimon.chamoionofrealms/files, copy the "saves" file into a safe place you will remember it at then open and close CoR on Joiplay for it to create a new saves folder
	1. If you cannot see this folder you need to download a file manager compatible with Android11+ permissions. ZArchiver is known to work.
2. Find the unzipped folder for the game and you should see a saves folder you created upon opening the game. Then go back to your current save folder, copy and paste it into the CoR folder and you should be asked if you want to overwrite the existing one, press yes.
3. Reopen CoR on Joiplay and if done right you should be able to launch and play the game with your existing saves you used on the android version of the game.