Skip to content

Commit

Permalink
Add install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
coldino authored Jan 19, 2018
1 parent 3ecceef commit b2b7ddb
Showing 1 changed file with 41 additions and 30 deletions.
71 changes: 41 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,66 @@
# Larkator : ARK Dino Finder

> Reads your saved ARK. Finds your dinos.
> Reads your ARK. Finds your dinos.
### What is is?

Need help finding your next high-stat tame for better dino breeding?
Larkator uses your ARK save file to help you find both wild and tamed creatures.
Need help locating your next high-stat tame for better dino breeding?
Larkator uses your ARK save file to help you locate both wild and tamed creatures.

![Larkator Screenshot](Assets/screenshot.png)

### Requirements

Larkator requires **ark-tools** to be installed (or at least, extracted).
On first run Larkator will ask you to locate it.
You can get it from the [Steam forum post](https://survivetheark.com/index.php?/forums/topic/80750-ark-tools-v064-tools-for-reading-and-manipulating-ark-savegame-files/),
or directly from [Qowyn/ark-tools](https://github.com/Qowyn/ark-tools/releases).

Before using Larkator, ark-tools must have downloaded its database (update-data). For anyone struggling with the command-prompt side of things open a Command Prompt and type the following, replacing `<path-to-ark-tools-directory>` with the correct path for your system:
```
cd <path-to-ark-tools-directory>
ark-tools.exe update-data
```

### Features

- Find both wild and tamed creatures
- Filter based on species, gender, min and max levels
- Show the results on a map with full corrdinates
- Show the results on a map with full coordinates
- Helps you find your lost tames
- Creature stats are shown to help you find that elusive next tame
- Automatically re-reads your save file when it changes

Currently only has a map for the island, although it will load any ARK.
Currently only has a map for the island, although it will load any ARK and give useful coordinates.

### Tips
### Requirements
Larkator requires **ark-tools** to be installed (or at least, extracted).
On first run Larkator will ask you to locate it.
You can get it from the [forum post](https://survivetheark.com/index.php?/forums/topic/80750-ark-tools-v064-tools-for-reading-and-manipulating-ark-savegame-files/),
or directly from [Qowyn/ark-tools](https://github.com/Qowyn/ark-tools/releases).

- Use your mouse's scroll wheel over a search filter's gender and level seletor to change them
- While ingame, use the command `saveworld` to force the game to save - Larkator will update immediately
(note: Larkator now updates the ark-tools database (*update-data*) each time it is launched)

### Limitations

Larkator is already very useful, but it is very new and is limited in some ways.

- Only has a map for the island, so far
- If you have too many searches the list will not scroll
- The results list is not scrollable either
- No new Aberation stats are shown
- The search and results lists do not scroll if there are too many entries
- None of the new Aberation stats are shown

### Installation
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).

### 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.
- Select a filter on the left side of the window to show a map of the results. Details of the results are show on the right.
- Use your mouse's scroll wheel over a search filter's gender and level selector to change them.
- To add a new species click the big add button. Set a category name, the species and any other filters you would like then click add.
- Filters can be dragged around in the list to re-order or change categories.
- While ingame, use the command `saveworld` to force the game to save - Larkator will update immediately
- Locate that max-level Quetzal and go get it!

### License

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

### Thanks

Expand Down

0 comments on commit b2b7ddb

Please sign in to comment.