imLinguin / nile

Unofficial Amazon Games client
GNU General Public License v3.0
302 stars 15 forks source link

Quick Start Guide #53

Open narniaexpert opened 1 week ago

narniaexpert commented 1 week ago

Currently documentation is lacking to guide users in how to use the interface. This issue recommends that a quick start guide be attached to the project with basic instructions.

Here are some examples I found online from others about the need for an instruction guide:

NoXPhasma 2 yr. ago Fortunately, with nile there is a CLI tool which you can use to download Amazon games and either run them with bottles or add them to Lutris. The tool lacks of a proper documentation, but here are some commands you can use. #https://www.reddit.com/r/linux_gaming/comments/11bniwl/did_anyone_get_amazon_prime_games_to_run_properly/

NoXPhasma 2 yr. ago Edited 2 yr. ago I found that project a few days ago as well and it works pretty great. A GUI would be nice, but for now the CLI works wonders. Since the readme and help text are not very detailed on how to use it, here are a few commands to use.

# sync the local game list
./bin/nile library sync

# list all games
./bin/nile library list

# install, update or verify a game
./bin/nile install {ID}

# launch a game with system wide wine
./bin/nile launch {ID}

https://www.reddit.com/r/linux_gaming/comments/w0q756/comment/igg5fgi/

narniaexpert commented 1 week ago

What is the difference in functionality between the commands for install and verify? These appear to do the same thing, so I would like clarification of their purposes in the documentation.