Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milouk/artie
Art Scraper for Anbernic Devices
https://github.com/milouk/artie
anbernic art emulator handheld muos retro scraper screenscraper
Last synced: about 1 month ago
JSON representation
Art Scraper for Anbernic Devices
- Host: GitHub
- URL: https://github.com/milouk/artie
- Owner: milouk
- License: gpl-3.0
- Created: 2024-09-17T20:54:19.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-13T17:05:36.000Z (about 1 month ago)
- Last Synced: 2024-11-13T18:19:54.807Z (about 1 month ago)
- Topics: anbernic, art, emulator, handheld, muos, retro, scraper, screenscraper
- Language: Python
- Homepage:
- Size: 5.31 MB
- Stars: 30
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Artie
Artie is a simple art scraper designed for Anbernic devices running MuOS. It helps you download and manage artwork for your ROMs, enhancing your gaming experience with beautiful visuals.
## Features
- Easy-to-use and minimal UI inspired from [tiny-scraper](https://github.com/Julioevm/tiny-scraper).
- Scrape per system or rom.
- Integrates seamlessly with MuOS.
- Highly customizable through `config.json`.
- Support for Box Art, Preview and Text (Synopsis).
- Option to delete all media for a selected system.
- It can work in other OSs as well with little adaptation.
## Installation / Usage
Follow these steps to install Artie:
1. **Download the Latest Release**:
- Visit the [releases page](https://github.com/milouk/artie/releases) and download the latest version of Artie.
2. **Unzip the Downloaded File**:
- Extract the contents of the downloaded zip file.
3. **Configure Artie**:
In `config.json` ensure:
a) `roms` is correctly configured to the path your roms are located.
b) Add your [Screenscraper](https://screenscraper.fr/) credentials.
c) For the systems you are interested to scrape ensure the paths are correct.
4. **Copy Files to MuOS**:
- Copy the `.artie` directory and `Artie Scraper.sh` script to `/mnt/mmc/MUOS/application/`.
This could be done via CLI with:
`scp -r .artie/ Artie\ Scraper.sh root@:/mnt/mmc/MUOS/application/`
5. **Launch Artie Scraper**:
- Open MuOS and launch Artie Scraper from your applications menu.
## Contributing
We welcome contributions! Feel free to open issues or submit pull requests (PRs) to help improve Artie.
### How to Contribute
1. **Fork the Repository**:
- Click the "Fork" button at the top right of the repository page.
2. **Clone Your Fork**:
- Clone your forked repository to your local machine using `git clone`.
3. **Create a Branch**:
- Create a new branch for your feature or bug fix.
4. **Make Changes**:
- Implement your changes and commit them with clear and concise messages.
5. **Submit a Pull Request**:
- Push your changes to your fork and submit a pull request to the main repository. Be sure to mention what feature you are implementing or which bug you are fixing.
### Reporting Bugs
If you encounter any bugs, please open an issue on the [GitHub issues page](https://github.com/milouk/artie/issues) with detailed information about the problem.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
Thank you for using Artie! We hope it enhances your gaming experience on your Anbernic device.