RetroUFO/README.md

# RetroUFO
[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-yellow.svg)](https://www.youtube.com/watch?v=NLGoKxh8Aq4)
[![Python Version](https://img.shields.io/pypi/pyversions/Django.svg)](https://www.python.org/downloads/) [![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://opensource.org/licenses/MIT) [![PyPI version](https://badge.fury.io/py/RetroUFO.svg)](https://pypi.org/project/RetroUFO/)

A ~~messy~~ Python script that grabs the latest version of every libretro core from the [build bot](https://buildbot.libretro.com/).  

***

### Installation

The package can be installed via pip:

```bash
python -m pip install --user RetroUFO
```


### Usage-CLI

Just run the script from the terminal:

```bash
RetroUFO
```

It will then download and extract all the latest versions of each core to their default location based on `retroarch.default.cfg` for each platform  
_(Which is only Linux, macOS, & Windows for right now)_

If you are more of a advance user, and want to do things a bit more manually, you can view all the scripts arguments by:
```bash
RetroUFO --help
```

### Usage-GUI

The GUI script uses [Qt for Python](https://wiki.qt.io/Qt_for_Python) ([PySide2](https://pypi.org/project/PySide2/)). So you can make sure you have that package installed if you plan to run the script manually:  
```bash
python -m pip install --user PySide2
```


After that you can just run the script like so:
```bash
RetroUFO-GUI
```

You can then just click the `Grab Cores` button at the bottom and then you should be all set.

![](screenshots/grab_cores.gif)

If you would like to grab cores for a different platform or architecture you can override which supported cores it grabs.

![](screenshots/custom_platform.gif)

If you have your core directory set somewhere special you can override where the cores extract to.

![](screenshots/custom_location.gif)

***
### TO-DO

- Set where cores are downloaded
- ~~Set where cores are extracted for RA Usage~~
- ~~Choose which architecture you are downloading format~~
- ~~Choose what platform you are downloading format~~
- ~~Auto detect platform & architecture~~
- Download progress bar
- ~~Keep downloaded archives~~
- ~~Make GUI~~
- Real error handling
- Support for ARM detection
- ~~Make a PyPi package~~
Actually filled this out 🎈 2018-10-15 22:48:32 -04:00			`# RetroUFO`
Fixed platform badge 2019-03-06 08:52:45 -05:00			`[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-yellow.svg)](https://www.youtube.com/watch?v=NLGoKxh8Aq4)`
Updated badges some 2019-12-11 01:04:02 -05:00			`[![Python Version](https://img.shields.io/pypi/pyversions/Django.svg)](https://www.python.org/downloads/) [![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://opensource.org/licenses/MIT) [![PyPI version](https://badge.fury.io/py/RetroUFO.svg)](https://pypi.org/project/RetroUFO/)`
Actually filled this out 🎈 2018-10-15 22:48:32 -04:00
Forgot to add build bot link 🔗 2018-10-15 22:54:53 -04:00			`A ~~messy~~ Python script that grabs the latest version of every libretro core from the [build bot](https://buildbot.libretro.com/).`
Added more info and crossed off (while also adding) some TO-DOs :arrows_counterclockwise: 2018-10-21 03:10:31 -04:00
Actually filled this out 🎈 2018-10-15 22:48:32 -04:00			`***`
Restructured for PyPi 2019-12-11 00:33:48 -05:00
			`### Installation`

			`The package can be installed via pip:`

			```bash
Don't assume pip is in the $PATH 2019-12-11 00:37:00 -05:00			`python -m pip install --user RetroUFO`
Restructured for PyPi 2019-12-11 00:33:48 -05:00			```


Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00			`### Usage-CLI`
Actually filled this out 🎈 2018-10-15 22:48:32 -04:00
Better wording 2019-12-11 01:08:35 -05:00			`Just run the script from the terminal:`
Actually filled this out 🎈 2018-10-15 22:48:32 -04:00
			```bash
Restructured for PyPi 2019-12-11 00:33:48 -05:00			`RetroUFO`
Actually filled this out 🎈 2018-10-15 22:48:32 -04:00			```

Added more info and crossed off (while also adding) some TO-DOs :arrows_counterclockwise: 2018-10-21 03:10:31 -04:00			It will then download and extract all the latest versions of each core to their default location based on `retroarch.default.cfg` for each platform
Restructured for PyPi 2019-12-11 00:33:48 -05:00			`_(Which is only Linux, macOS, & Windows for right now)_`
Added more info and crossed off (while also adding) some TO-DOs :arrows_counterclockwise: 2018-10-21 03:10:31 -04:00
			`If you are more of a advance user, and want to do things a bit more manually, you can view all the scripts arguments by:`
			```bash
Restructured for PyPi 2019-12-11 00:33:48 -05:00			`RetroUFO --help`
Added more info and crossed off (while also adding) some TO-DOs :arrows_counterclockwise: 2018-10-21 03:10:31 -04:00			```

Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00			`### Usage-GUI`

Fixed GUI Command 2019-12-11 01:12:35 -05:00			`The GUI script uses [Qt for Python](https://wiki.qt.io/Qt_for_Python) ([PySide2](https://pypi.org/project/PySide2/)). So you can make sure you have that package installed if you plan to run the script manually:`
Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00			```bash
Don't assume pip is in the $PATH 2019-12-11 00:37:00 -05:00			`python -m pip install --user PySide2`
Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00			```
Restructured for PyPi 2019-12-11 00:33:48 -05:00

Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00			`After that you can just run the script like so:`
			```bash
Fixed GUI Command 2019-12-11 01:12:35 -05:00			`RetroUFO-GUI`
Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00			```

			You can then just click the `Grab Cores` button at the bottom and then you should be all set.

Added screenshots to the README 2019-03-06 09:13:17 -05:00			`![](screenshots/grab_cores.gif)`
Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00
			`If you would like to grab cores for a different platform or architecture you can override which supported cores it grabs.`

Added screenshots to the README 2019-03-06 09:13:17 -05:00			`![](screenshots/custom_platform.gif)`
Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00
			`If you have your core directory set somewhere special you can override where the cores extract to.`

Added screenshots to the README 2019-03-06 09:13:17 -05:00			`![](screenshots/custom_location.gif)`
Added more info and crossed off (while also adding) some TO-DOs :arrows_counterclockwise: 2018-10-21 03:10:31 -04:00
Actually filled this out 🎈 2018-10-15 22:48:32 -04:00			`***`
			`### TO-DO`

Added more info and crossed off (while also adding) some TO-DOs :arrows_counterclockwise: 2018-10-21 03:10:31 -04:00			`- Set where cores are downloaded`
			`- ~~Set where cores are extracted for RA Usage~~`
			`- ~~Choose which architecture you are downloading format~~`
			`- ~~Choose what platform you are downloading format~~`
			`- ~~Auto detect platform & architecture~~`
Actually filled this out 🎈 2018-10-15 22:48:32 -04:00			`- Download progress bar`
Added args to keep downloaded archives 2018-10-16 00:29:45 -04:00			`- ~~Keep downloaded archives~~`
2 != 32 != 3 2019-03-06 08:54:27 -05:00			`- ~~Make GUI~~`
Added more info and crossed off (while also adding) some TO-DOs :arrows_counterclockwise: 2018-10-21 03:10:31 -04:00			`- Real error handling`
Added usage for the GUI and redid some TODOs 2019-03-06 08:51:48 -05:00			`- Support for ARM detection`
Restructured for PyPi 2019-12-11 00:33:48 -05:00			`- ~~Make a PyPi package~~`