Skip to content

Commit

Permalink
Moved installation instructions to the wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
coldino committed Feb 2, 2018
1 parent 9ecaa27 commit bd6f3d1
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,7 @@ Larkator is already very useful, but it is very new and is limited in some ways.
- None of the new Aberation stats are shown

### Installation
Windows makes installing a simple app into a series of 'yes I'm sure' steps. Here's each little detail for anyone who's unsure:

Note: If running Windows 10 you might need to enable installing apps from outside the app store...
Open **Settings** and go to **Apps**. Under **App & Features** the first setting is called **Installing apps**. If this is set to "Allow apps from the Store only" then set it either "Warn me..." or "Allow apps from anywhere", depending on your level of trust. Warn is the safest.

1. Find the latest release of Larkator and download the ...setup.exe. Click Run/Open once the download is completed.
1. Windows and/or your browser might chime in and tell you that you are opening an untrusted app. If you want to continue you might have to click "More info" to reveal the button to allow the installer to run.
1. The installer's "Application Install - Security Warning" window pops up, telling you once again that the app is unsigned. Choose Install if you wish to continue.
1. At this point Windows 10 chimes in once again and requires you to click "More info" then "Run anyway" if you wish to actually install.
1. Larkator is now installed and pops up its Welcome window.
1. If you do not have ark-tools installed:
1. Click the given link to take you to the ark-tools forum page. Follow the link to ark-tools on GitHub, then to releases and download the latest released ark-tools.zip.
1. Ark tools has no installer, so make a new folder somewhere to keep it. If unsure, make a folder called ark-tools in Downloads.
1. Open the downloaded zip file and extract all of its contents to the folder you created for it.
1. In the Larkator Welcome window, follow step 1) and locate ark-tools.exe.
1. Follow step 2) and locate your saved ARK e.g. C:\SteamLibrary\steamapps\common\ARK\ShooterGame\Saved\SavedArksLocal\TheIsland.ark
1. Click "Let's Go" and you're in.
1. Larkator will auto-update, but will only update after it is restarted (and with an option to skip).
For full step-by-step installation instructions refer to the [wiki](https://github.com/coldino/Larkator/wiki/Installation).

### Use and Tips
- Larkator will use ark-tools to translate your saved ARK on first load and each time it changes. A large spinning cog appears over the map while this is happening. No changes are made to your saved ARK as the translated output lives in Temp.
Expand All @@ -61,13 +44,12 @@ Open **Settings** and go to **Apps**. Under **App & Features** the first setting

### Known Issues
1) Larger saved arks cause ark-tools to generate an OutOfMemory error. To avoid this the memory allocated to ark-tools.exe must be upped.
To achieve this, create simple text file beside ark-tools.exe called **ark-tools.l4j.ini**. It should contain only the text **-Xmx4G**.
To achieve this, create a simple text file in the same directory as ark-tools.exe and call it **ark-tools.l4j.ini**. It should contain only the text **-Xmx4G**.

### License
Larkator is Open Source and released under the MIT license. Contributions are encouraged.

### Thanks

Thanks to [Roland Firmont (Qowyn)](https://github.com/Qowyn) for ark-tools, without which this tool would not be possible.

The project includes [ListView Layout Manager](https://www.codeproject.com/Articles/25058/ListView-Layout-Manager) from Jani Giannoudis.

0 comments on commit bd6f3d1

Please sign in to comment.