mirror of
https://github.com/Lime3DS/Lime3DS.git
synced 2026-04-08 02:11:29 -06:00
Updated readme
This commit is contained in:
OpenSauce04
parent
e37cbcf2ff
commit
56f2bccbe0
36
README.md
36
README.md
@ -16,11 +16,14 @@ The goal of this project is to be the de-facto platform for future development.
|
||||
|
||||
### Windows
|
||||
|
||||
Download the latest release from [Releases](https://github.com/azahar-emu/azahar/releases).
|
||||
Azahar is available as both an installer and a zip archive.
|
||||
|
||||
If you are unsure of whether you want to use MSYS2 or MSVC, use MSYS2.
|
||||
Download the latest release in your preferred format from the [Releases](https://github.com/azahar-emu/azahar/releases) page.
|
||||
|
||||
If you are unsure of whether you want to use MSVC or MSYS2, use MSYS2.
|
||||
|
||||
---
|
||||
|
||||
### MacOS
|
||||
|
||||
To download a build that will work on all Macs, you can download the `macos-universal` build on the [Releases](https://github.com/azahar-emu/azahar/releases) page.
|
||||
@ -31,23 +34,30 @@ Alternatively, if you wish to download a build specifically for your Mac, you ca
|
||||
- `macos-x86_64` for Intel Macs
|
||||
|
||||
---
|
||||
|
||||
### Android
|
||||
The recommended method of downloading Azahar on Android is via the Google Play store:
|
||||
|
||||
There are two variants of Azahar available on Android, those being the Vanilla and Google Play builds.
|
||||
|
||||
The Vanilla build is technically superior, as it uses an alternative method of file management which is faster, but isn't permitted on the Google Play store.
|
||||
|
||||
For most users, we currently recommended downloading Azahar on Android via the Google Play Store for ease of accessibility:
|
||||
|
||||
<a href='https://play.google.com/store/apps/details?id=io.github.lime3ds.android'><img width='180' alt='Get it on Google Play' src='https://raw.githubusercontent.com/pioug/google-play-badges/06ccd9252af1501613da2ca28eaffe31307a4e6d/svg/English.svg'/></a>
|
||||
|
||||
Alternatively, you can install the app using Obtainium:
|
||||
Alternatively, you can install the app using Obtainium, allowing you to use the Vanilla variant:
|
||||
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-emu/azahar` into the 'App Source URL' section
|
||||
4. Click 'Add'
|
||||
5. Click 'Install'
|
||||
5. Click 'Install', and select the preferred variant
|
||||
|
||||
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
|
||||
|
||||
The recommended format for using Azahar on Linux is the Flatpak available on Flathub:
|
||||
@ -56,11 +66,13 @@ The recommended format for using Azahar on Linux is the Flatpak available on Fla
|
||||
|
||||
Azahar is also available as an AppImage on the [Releases](https://github.com/azahar-emu/azahar/releases) page.
|
||||
|
||||
There are two variants of the AppImage available, those being `azahar.AppImage` and `azahar-wayland.AppImage`.
|
||||
|
||||
If you are unsure of which variant to use, we recommend using the default `azahar.AppImage`. This is because of upstream issues in the Wayland ecosystem which may cause problems when running the emulator (e.g. [#1162](https://github.com/azahar-emu/azahar/issues/1162)).
|
||||
|
||||
Unless you explicitly require native Wayland support (e.g. you are running a system with no Xwayland), the non-Wayland variant is recommended.
|
||||
|
||||
If you are using the Flatpak and run into issues with Wayland, you can disable Wayland support for the Azahar Flatpak using [Flatseal](https://flathub.org/en/apps/com.github.tchx84.Flatseal).
|
||||
The Flatpak build of Azahar also has native Wayland support disabled by default. If you require native Wayland support, it can be enabled using [Flatseal](https://flathub.org/en/apps/com.github.tchx84.Flatseal).
|
||||
|
||||
# Build instructions
|
||||
|
||||
@ -92,18 +104,23 @@ To do so, simply read https://github.com/azahar-emu/compatibility-list/blob/mast
|
||||
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.4 (Ventura), or modern 64-bit Linux
|
||||
CPU: x86-64/ARM64 CPU (Windows for ARM not supported). Single core performance higher than 1,800 on Passmark
|
||||
CPU: x86-64/ARM64 CPU (Windows for ARM not supported).
|
||||
Single core performance higher than 1,800 on Passmark.
|
||||
SSE4.2 required on x86_64.
|
||||
GPU: OpenGL 4.3 or Vulkan 1.1 support
|
||||
Memory: 2GB of RAM. 4GB is recommended
|
||||
```
|
||||
### Android
|
||||
|
||||
```
|
||||
Operating System: Android 9.0+ (64-bit)
|
||||
Operating System: Android 10.0+ (64-bit)
|
||||
CPU: Snapdragon 835 SoC or better
|
||||
GPU: OpenGL ES 3.2 or Vulkan 1.1 support
|
||||
Memory: 2GB of RAM. 4GB is recommended
|
||||
@ -116,6 +133,7 @@ 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)
|
||||
Join at https://discord.gg/4ZjMpAp3M6
|
||||
|
||||
Loading…
Reference in New Issue
Block a user