Skip to content

Commit

Permalink
Merge pull request #4 from milouk/dev
Browse files Browse the repository at this point in the history
Dev
  • Loading branch information
milouk authored Oct 3, 2024
2 parents 683da4f + e9ddaba commit db746c6
Show file tree
Hide file tree
Showing 8 changed files with 454 additions and 319 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ build
app.spec
.DS_Store
build.sh
todo.txt
50 changes: 21 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,22 @@

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.

![Artie Screenshot 1](artie1.png)
![Artie Screenshot 2](artie2.png)
<div style="display: flex; justify-content: space-between;">
<img src="screenshots/artie1.png" alt="Artie Screenshot 1" style="width: 48%;"/>
<img src="screenshots/artie2.png" alt="Artie Screenshot 2" style="width: 48%;"/>
</div>

## Features

- Easy-to-use interface
- Supports multiple systems
- Integrates seamlessly with MuOS
- 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
## Installation / Usage

Follow these steps to install Artie:

Expand All @@ -25,33 +31,25 @@ Follow these steps to install Artie:

3. **Configure Artie**:

- Open `config.json` and add your ScreenScraper credentials.
- *Customize other settings such as ROMs path, art path per system, etc.*
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 with:
This could be done via CLI with:

`scp -r .artie/ Artie\ Scraper.sh root@<your IP>:/mnt/mmc/MUOS/application/`

5. **Launch Artie Scraper**:
- Open MuOS and launch Artie Scraper from your applications menu.

## Usage

1. **Run Artie Scraper**:

- Navigate to the applications menu in MuOS and select Artie Scraper.

2. **Scrape Artwork**:

- Follow the on-screen instructions to scrape artwork for your ROMs.

3. **Enjoy Enhanced Visuals**:
- View your ROMs with the newly downloaded artwork.

## Contributing

We welcome contributions! Feel free to open issues or submit pull requests (PRs) to help improve Artie.
Expand All @@ -75,18 +73,12 @@ We welcome contributions! Feel free to open issues or submit pull requests (PRs)
- 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.
- 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.

## Roadmap

### Upcoming Features

- **Multithreading**: Implement multithreading to improve performance and speed up the scraping process.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Expand Down
21 changes: 17 additions & 4 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,22 @@
"screenscraper": {
"username": "",
"password": "",
"devid": "cmVhdmVu",
"devpassword": "MDZXZUY5bTBldWs=",
"threads": 3,
"devid": "bWlsb3Vr",
"devpassword": "dVdDNVVsWHhaaFo=",
"threads": 1,
"content": {
"synopsis_lang": "en",
"synopsis": {
"enabled": true,
"lang": "en"
},
"box": {
"enabled": true,
"type": "box-3D",
"height": 240,
"width": 320
},
"preview": {
"enabled": true,
"type": "ss",
"height": 275,
"width": 515
Expand All @@ -30,6 +35,14 @@
]
},
"systems": [
{
"dir": "TEST",
"id": "-1",
"name": "test",
"box": "/mnt/mmc/MUOS/info/catalogue/ADVMAME/box/",
"preview": "/mnt/mmc/MUOS/info/catalogue/ADVMAME/preview/",
"synopsis": "/mnt/mmc/MUOS/info/catalogue/ADVMAME/text/"
},
{
"dir": "ADVMAME",
"id": "75",
Expand Down
File renamed without changes
File renamed without changes
Loading

0 comments on commit db746c6

Please sign in to comment.