kyleleneau / provenance

iOS & tvOS multi-emulator frontend, supporting various Atari, Bandai, NEC, Nintendo, Sega, SNK and Sony console systems… Get Started: https://wiki.provenance-emu.com |

Provenance

An iOS & tvOS Frontend for Multiple Emulators

Installation

To get started, please follow the Installation instructions on the wiki.

^{If you run into trouble, check the Frequently Asked Questions and please read up on our Issues Usage first, before posting any new issues.}

Why 'Provenance'?

Provenance is our origin story. The word has a similar meaning to Genesis, which is actually where the project started: Sega Genesis—our early beginnings as humble emulator on iOS.

^{prov·e·nance   /ˈprävənəns/   n.
¹ place of origin   ² the beginning of something's existence}

Systems Supported:

• Atari
  • 2600
  • 5200
  • 7800
  • Lynx
  • Jaguar
• Bandai
  • WonderSwan / WonderSwan Color
• NEC
  • PC Engine / TurboGrafx-16 (PCE/TG16)
  • PC Engine Super CD-ROM² System / TurboGrafx-CD
  • PC Engine SuperGrafx
  • PC-FX
• Nintendo
  • Nintendo Entertainment System / Famicom (NES/FC)
  • Famicom Disk System
  • Super Nintendo Entertainment System / Super Famicom (SNES/SFC)
  • Game Boy / Game Boy Color (GB/GBC)
  • Virtual Boy
  • Nintendo 64 (N64)
  • Game Boy Advance (GBA)
  • Pokémon mini
• Sega
  • SG-1000
  • Master System
  • Genesis / Mega Drive
  • Game Gear
  • CD / MegaCD
  • 32X
• SNK
  • Neo Geo Pocket / Neo Geo Pocket Color
• Sony
  • PlayStation (PSX/PS1)

Systems in Development:

• Nintendo
  • DS
• Sega
  • Dreamcast (reicast)
  • Saturn (yabause)
• Sony
  • PSP (ppsspp)

Features

• Very Accurate, Full Speed Emulation
• Stereo Sound
• Save States (save anywhere/game freezing)
• Battery Saves (native game saves)
• Adjustable Controller Overlay Opacity
• Controller Support:
  • MFi Game Controller Support
  • iCade Controller Support (8bitdo, etc…)
• Local Multiplayer via External Controllers
• Portrait and Landscape Orientation
• Automatic ROM Matching (Game Title, Cover Art, Description, Genre, etc…) via OpenVGDB
• ROM Customizations (Cover Art, Game Titles) (Instructions)
• Multiple Options for Managing ROMs, Game Saves and Cover Art:
  • Import / Export:
    • Uploading (via built-in web server)
  • Import:
    • Downloading (from mobile browsers)
    • Copying (from other mobile apps and AirDrop)
    • Injecting (with desktop apps)
• Game Library Searching
• iOS 9+ (iPhone, iPad)
  • 3D Touch Shortcuts for Recent Games (iPhone 6s and later, except iPhone SE and iPhone Xʀ)
  • Taptic Engine Button Feedback (iPhone 7 and later)
  • Spotlight Searching (Setup)
• tvOS 9+ (Apple TV 4+)
  • TopShelf Support (Setup)

_{Feel free to suggest/request features or report bugs by posting an issue, but please read up on our Issues Usage first, before posting.}

---

Importing ROMs

Visit our wiki on Importing ROMs to learn how to load ROMs into Provenance.

Release Roadmap

We track upcoming releases in our GitHub Milestones. Keep in mind they are subject to change.

Contributions

To contribute to the Provenance project please take look at the open issues. If you see something you can help with: bugfixing, testing, implementation or relevant suggestions, discussion and research.°

Before posting new issues, we ask you to please read up on Issues Usage. If you just want to give us a a shout out, twitter: @provenanceapp, and of course, new GitHub contributors are always welcome. Thank you.

^{° Please note that Issues is not a discussion board nor a help desk. Please help us keep it focused on improving Provenance.}

Community

💬 Join us and the rest of the community on the Provenence-Emu Discord.

---

Attributions

Provenance would not be possible without the great work of those who came before us and the ongoing develeopment of open-source projects that makeup the foundations of our emulation cores.

_{Atari 2600: Stella | Atari 5200: Atari 800 | Atari 7800: ProSystem | Atari Jaguar: Virtual Jaguar | Nintendo Entertainment System/Famicom (NES/FC), Famicom Disk System (FDS): FCEUX | Super Nintendo Entertainment System/Super Famicom (SNES/SFC): SNES9x | Game Boy / Game Boy Color: Gambatte | Nintendo 64 (N64): Mupen64Plus | Game Boy Advance (GBA): VisualBoyAdvance | Pokémon mini: PokiMini | Sega Master System, Game Gear, Genesis/MegaDrive, SG-1000: Genesis Plus GX | Sega 32X: PicoDrive | Atari Lynx, Bandai WonderSwan + WonderSwan Color, NEC TurboGrafx-16/PC Engine / TurboGrafx-CD/Super CD-ROM² System / SuperGrafx / PC-FX, Nintendo Entertainment System/Famicom (NES/FC) / Game Boy / Game Boy Color / Game Boy Advance / Super Nintendo Entertainment System/Super Famicom (SNES/SFC) / VirtualBoy, SNK Neo Geo Pocket / Neo Geo Pocket Color, Sony PlayStation: Mednafen}

_{The specific implementations used in Provenance are loosely based on some of the work done by OpenEmu (source) and RetroArch (source).}

---

Provenance License

_{Copyright © 2016, Provenance-Emu Team. All rights reserved.}

<sub>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer • 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. • 3. Neither the name of the Provenance project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</sub>

_{THIS SOFTWARE IS PROVIDED BY PROVENANCE-EMU "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PROVENANCE-EMU OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.}

_{The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Provenance-Emu Team.}

OpenEmu License

_{Copyright © 2016, OpenEmu Team}

<sub>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. • 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. • 3. Neither the name of the OpenEmu Team nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</sub>

_{THIS SOFTWARE IS PROVIDED BY OpenEmu Team ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL OpenEmu Team BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.}