Skip to content

Commit

Permalink
Add Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
milouk committed Sep 29, 2024
1 parent fa9ab03 commit 7faa135
Show file tree
Hide file tree
Showing 2 changed files with 96 additions and 1 deletion.
96 changes: 96 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# 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 interface
- Supports multiple systems
- Integrates seamlessly with MuOS

## Installation

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**:

- Open `config.json` and add your ScreenScraper credentials.
- Customize other settings such as ROMs path, art path per system, etc.

4. **Copy Files to MuOS**:

- Copy the `.artie` directory and `Artie Scraper.sh` script to `/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.

### 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.

## Bugs

### Known Issues

- **Screen Flickering**: There is a known issue with screen flickering. We are actively working on a fix.

### 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.


---

Thank you for using Artie! We hope it enhances your gaming experience on your Anbernic device.
1 change: 0 additions & 1 deletion src/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,6 @@ def load_emulators(self) -> None:
(20, 50 + (i * 35)),
600,
i == (selected_position % max_elem),
logo,
)

self.button_circle((30, 450), "A", "Select")
Expand Down

0 comments on commit 7faa135

Please sign in to comment.