Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 4.79 KB

README.md

File metadata and controls

100 lines (75 loc) · 4.79 KB
Raw


Lime3DS
Lime3DS

GitHub Release GitHub Downloads Flathub Downloads

Lime3DS is a project which aims to revive and continue work on Citra, a popular open-source 3DS emulator which ceased development.

Installation

Windows & MacOS

Download the latest release from Releases.

Windows Version Differences

There is no emulation specific difference between the MSVC and MSYS2 versions of Lime3DS, they are just two different compilers used to create a Lime3DS executable. However, there are a few functional differences:

  • MSVC generates a smaller file
  • Microsoft developed MSVC and is closed source while MSYS2 is open-source
  • MSVC requires the installation of Microsoft Visual C++ runtime, if not already installed, which can require a restart to finish the install. If you have issues with the Microsoft Visual C++ runtimes, you should try the MSYS2 install
  • There have been reports where MSVC has not worked while MSYS2 does

Android

The recommended method of downloading Lime3DS on Android is via Obtainium:

  1. Download and install Obtainium from here (use the file named app-release.apk)
  2. Open Obtainium and click 'Add App'
  3. Type https://github.com/Lime3DS/Lime3DS into the 'App Source URL' section
  4. Click 'Add'
  5. Click 'Install' (or 'Update' if you have an existing APK install)
  6. Lime3DS is now ready to use

Using Obtainium will allow for quick and easy installation of updates.


Alternatively, you can install the latest APK from the Releases page.

This will require a new APK to be manually downloaded each time an update is released.

Linux

Lime3DS is available as an AppImage on the Releases page.

We are also on Flathub:

Download on Flathub

Build Instructions

Please refer to our website's wiki in order to find building instructions for Windows, Linux, Android and MacOS

Compatibility Reporting

Reports for game compatibility can be made here: https://github.com/Lime3DS/compatibility-list

Please ensure that you have read the contributing document before submitting a report.

Minimum Requirements

Below are the minimum requirements to run Lime3DS:

Desktop

Operating System: Windows 10 (64-bit), MacOS 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 keep a public roadmap of what features/bug fixes are planned to be included in the next update or two. You can find this at https://github.com/Lime3DS/Lime3DS/milestones.

How can I contribute?

If you believe you can help with this project, please lend us your talent! We're a team of passionate enthusiasts who need all the help we can get.

If there is an issue you want solved or a feature you want implemented, feel free to open a pull request.

(Please don't repeatedly merge master into your PR's branch. A maintainer will update the branch for you if/ when it is appropriate to do so)

Additionally, we are accepting language translations on Transifex. 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.

Discord

Join our Discord community to discuss the project or talk with the developers.