mirror of
https://github.com/derrod/legendary.git
synced 2024-12-22 17:55:27 +00:00
Update README and setup.py (filter for PyPI)
This commit is contained in:
parent
5557dc63ae
commit
85244f4c88
35
README.md
35
README.md
|
@ -1,5 +1,7 @@
|
||||||
# Legendary Game Launcher
|
# Legendary
|
||||||
### A free and open-source Epic Games Launcher replacement
|
## A free and open-source Epic Games Launcher replacement
|
||||||
|
![Logo](https://repository-images.githubusercontent.com/249938026/7ea8a680-7e65-11ea-9260-fea84c1112f1)
|
||||||
|
|
||||||
[![Discord](https://discordapp.com/api/guilds/695233346627698689/widget.png?style=shield)](https://discord.gg/UJKBwPw) [![Twitter Follow](https://img.shields.io/twitter/follow/legendary_gl?label=Follow%20us%20for%20updates%21&style=social)](https://twitter.com/legendary_gl)
|
[![Discord](https://discordapp.com/api/guilds/695233346627698689/widget.png?style=shield)](https://discord.gg/UJKBwPw) [![Twitter Follow](https://img.shields.io/twitter/follow/legendary_gl?label=Follow%20us%20for%20updates%21&style=social)](https://twitter.com/legendary_gl)
|
||||||
|
|
||||||
Legendary is an open-source game launcher that can download and install games from the Epic Games Store on Linux and Windows.
|
Legendary is an open-source game launcher that can download and install games from the Epic Games Store on Linux and Windows.
|
||||||
|
@ -8,22 +10,23 @@ It's name as a tongue-in-cheek play on tiers of [item rarity in many MMORPGs](ht
|
||||||
Right now it is in an early public testing stage and still needs a lot of work to work. But it does work!
|
Right now it is in an early public testing stage and still needs a lot of work to work. But it does work!
|
||||||
|
|
||||||
**What works:**
|
**What works:**
|
||||||
- Authenticate with Epic
|
- Authenticating with Epic's service
|
||||||
- Download and install games and their DLC
|
- Downloading and installing your games and their DLC
|
||||||
- Delta patching/updating of installed games
|
- Delta patching/updating of installed games
|
||||||
- Launch games with online authentication
|
- Launching games with online authentication (for multiplayer)
|
||||||
|
- Running games with WINE on Linux
|
||||||
|
|
||||||
**Planned:**
|
**Planned:**
|
||||||
- PyPI/PPA distribution
|
|
||||||
- Simple GUI for managing/launching games
|
- Simple GUI for managing/launching games
|
||||||
- Importing installed games from the EGS launcher
|
- Importing installed games from the EGS launcher
|
||||||
|
- Better interfaces for other developers to use Legendary in their projects
|
||||||
- Lots and lots of bug fixes, optimizations, and refactoring...
|
- Lots and lots of bug fixes, optimizations, and refactoring...
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- python 3.8+ **(64-bit)**
|
- python 3.8+ (64-bit on Windows)
|
||||||
- requests
|
- requests
|
||||||
- setuptools (for installation)
|
- setuptools (only when installing/building)
|
||||||
|
|
||||||
## How to run/install
|
## How to run/install
|
||||||
|
|
||||||
|
@ -165,7 +168,12 @@ optional arguments:
|
||||||
debug
|
debug
|
||||||
--platform <Platform>
|
--platform <Platform>
|
||||||
Platform override for download (disables install)
|
Platform override for download (disables install)
|
||||||
--prefix <prefix> Only fetch files whose path starts with <prefix> (case insensitive)
|
--prefix <prefix> Only fetch files whose path starts with <prefix> (case
|
||||||
|
insensitive)
|
||||||
|
--exclude <prefix> Exclude files starting with <prefix> (case
|
||||||
|
insensitive)
|
||||||
|
--install-tag <tag> Only download files with the specified install tag
|
||||||
|
(testing)
|
||||||
|
|
||||||
|
|
||||||
Command: uninstall
|
Command: uninstall
|
||||||
|
@ -223,8 +231,9 @@ optional arguments:
|
||||||
|
|
||||||
Command: list-files
|
Command: list-files
|
||||||
usage: legendary list-files [-h] [--force-download] [--platform <Platform>]
|
usage: legendary list-files [-h] [--force-download] [--platform <Platform>]
|
||||||
[--manifest <uri>] [--csv] [--hashlist]
|
[--manifest <uri>] [--csv] [--tsv] [--hashlist]
|
||||||
<App Name>
|
[--install-tag <prefix>]
|
||||||
|
[<App Name>]
|
||||||
|
|
||||||
positional arguments:
|
positional arguments:
|
||||||
<App Name> Name of the app
|
<App Name> Name of the app
|
||||||
|
@ -236,8 +245,12 @@ optional arguments:
|
||||||
Platform override for download (disables install)
|
Platform override for download (disables install)
|
||||||
--manifest <uri> Manifest URL or path to use instead of the CDN one
|
--manifest <uri> Manifest URL or path to use instead of the CDN one
|
||||||
--csv Output in CSV format
|
--csv Output in CSV format
|
||||||
|
--tsv Output in TSV format
|
||||||
--hashlist Output file hash list in hashcheck/sha1sum compatible
|
--hashlist Output file hash list in hashcheck/sha1sum compatible
|
||||||
format
|
format
|
||||||
|
--install-tag <tag> Show only files with specified install tag
|
||||||
|
|
||||||
|
|
||||||
````
|
````
|
||||||
|
|
||||||
|
|
||||||
|
|
4
setup.py
4
setup.py
|
@ -12,7 +12,9 @@ if sys.version_info < (3, 8):
|
||||||
sys.exit('python 3.8 or higher is required for legendary')
|
sys.exit('python 3.8 or higher is required for legendary')
|
||||||
|
|
||||||
with open("README.md", "r") as fh:
|
with open("README.md", "r") as fh:
|
||||||
long_description = fh.read()
|
long_description_l = fh.readlines()
|
||||||
|
del long_description_l[2:5] # remove discord/twitter link and logo
|
||||||
|
long_description = ''.join(long_description_l)
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='legendary-gl',
|
name='legendary-gl',
|
||||||
|
|
Loading…
Reference in a new issue