mirror of
https://github.com/azahar-emu/azahar.git
synced 2025-03-03 17:25:21 +01:00
109 lines
4.8 KiB
Markdown
109 lines
4.8 KiB
Markdown
|
|
|
|
|
|
 <!--  -->
|
|
|
|
|
|
<b>Azahar</b> is an open-source 3DS emulator project based on Citra.
|
|
|
|
It was created from the merging of PabloMK7's Citra fork and the Lime3DS project, both of which emerged shortly after Citra was taken down.
|
|
|
|
The goal of this project is to be the de-facto platform for future development.
|
|
|
|
> [!NOTE]
|
|
> Azahar has not fully released yet. For this reason, there are no compiled binaries available for download.
|
|
>
|
|
> It is recommended that only developers and early adopters should use the emulator until our first stable release.
|
|
>
|
|
> Here be dragons.
|
|
|
|
<!--
|
|
# Installation
|
|
|
|
### Windows & MacOS
|
|
|
|
Download the latest release from [Releases](https://github.com/azahar-emu/azahar/releases).
|
|
|
|
---
|
|
### Android
|
|
The recommended method of downloading Azahar on Android is via the [Google Play store](https://play.google.com/store/apps/details?id=io.github.lime3ds.android).
|
|
|
|
Alternatively, you can install the app using Obtainium:
|
|
1. Download and install Obtainium from [here](https://github.com/ImranR98/Obtainium/releases) (use the file named `app-release.apk`)
|
|
2. Open Obtainium and click 'Add App'
|
|
3. Type `https://github.com/azahar/azahar-emu` into the 'App Source URL' section
|
|
4. Click 'Add'
|
|
5. Click 'Install'
|
|
|
|
If you wish, you can also simply install the latest APK from the [Releases](https://github.com/azahar-emu/azahar/releases) page.
|
|
|
|
Keep in mind that you will not recieve automatic updates when installing via the APK.
|
|
|
|
---
|
|
### Linux
|
|
|
|
Azahar is available as an AppImage on the [Releases](https://github.com/azahar-emu/azahar/releases) page.
|
|
|
|
We are also on Flathub:
|
|
|
|
<a href=https://flathub.org/apps/org.azahar-emu.azahar><img width='180' alt='Download on Flathub' src='https://dl.flathub.org/assets/badges/flathub-badge-en.png'/></a>
|
|
-->
|
|
|
|
# Build instructions
|
|
|
|
Please refer this repository's [wiki](https://github.com/azahar-emu/azahar/wiki/Building-From-Source) for build instructions
|
|
|
|
# How can I contribute?
|
|
|
|
### Pull requests
|
|
|
|
If you want to implement a change and have the technical capability to do so, we would be happy to accept your contributions.
|
|
|
|
If you are contributing a new feature, it is highly suggested that you first make a Feature Request issue to discuss the addition before writing any code. This is to ensure that your time isn't wasted working on a feature which isn't deemed appropriate for the project.
|
|
|
|
After creating a pull request, please don't repeatedly merge `master` into your branch. A maintainer will update the branch for you if/ when it is appropriate to do so.
|
|
|
|
### Language translations
|
|
|
|
Additionally, we are accepting language translations on [Transifex](https://app.transifex.com/azahar/azahar). If you know a non-english language listed on our Transifex page, please feel free to contribute.
|
|
|
|
> [!NOTE]
|
|
> We are not currently accepting new languages for translation. Please do not request for new languages or language variants to be added.
|
|
|
|
### Compatibility reports
|
|
|
|
Even if you don't wish to contribute code or translations, you can help the project by reporting game compatibility data to our compatibility list.
|
|
|
|
To do so, simply read https://github.com/azahar-emu/compatibility-list/blob/master/CONTRIBUTING.md and follow the instructions.
|
|
|
|
Contributing compatibility data helps more accurately reflect the current capabilities of the emulator, so it would be highly appreciated if you could go through the reporting process after completing a game.
|
|
|
|
# Minimum requirements
|
|
Below are the minimum requirements to run Azahar:
|
|
|
|
### Desktop
|
|
```
|
|
Operating System: Windows 10 (64-bit), MacOS 13 (Ventura), or modern 64-bit Linux
|
|
CPU: x86-64 (64-bit) CPU. Single core performance higher than 1,800 on Passmark
|
|
GPU: OpenGL 4.3 or Vulkan 1.1 support
|
|
Memory: 2GB of RAM. 4GB is recommended
|
|
```
|
|
### Android
|
|
```
|
|
Operating System: Android 9.0+
|
|
CPU: Snapdragon 835 SoC or better
|
|
GPU: OpenGL ES 3.2 or Vulkan 1.1 support
|
|
Memory: 2GB of RAM. 4GB is recommended
|
|
```
|
|
|
|
# What's next?
|
|
|
|
We share public roadmaps for upcoming releases in the form of GitHub milestones.
|
|
|
|
You can find these at https://github.com/azahar-emu/azahar/milestones.
|
|
|
|
# Join the conversation
|
|
We have a community Discord server where you can chat about the project, keep up to date with the latest announcements, or coordinate emulator development.
|
|
|
|
[](https://discord.gg/4ZjMpAp3M6)
|