Obtainium-Emulation-Pack/README.md

Obtainium Emulation Pack

An Obtainium import file that adds popular Android emulation applications to Obtainium.

The maintainer of Obtainium also hosts a collection of Crowdsourced app configurations. apps.obtainium.imranr.dev

How to install

Option 1. Import Method

Tip

This is recommended installation method for beginners and/or new devices

1. On your android emulation device, navigate to the latest release of the Obainium Emulation Pack.
2. Download the file titled obtainium-emulation-pack-vX.X.X.json to your device.
3. Open Obtainium.
4. Navigate to Import/Export.
5. Select Obtainium Import and open obtainium-emulation-pack-vX.X.X.json
6. You should see packages imported to your obtainium.

Option 2. Click-to-Install Method

1. Visit this page on your android emulation device
2. Click the "Add to Obtainium!" links of the emulators you wish to track

Applications

Emulator

Application Name	Add to Obtainium	Included in export json?
+AzaharPlus+	Add to Obtainium!	❌
Azahar	Add to Obtainium!	✅
Cemu	Add to Obtainium!	✅
Citron	Add to Obtainium!	✅
Dolphin Emulator	Add to Obtainium!	✅
Dolphin Emulator (Dev build)	Add to Obtainium!	❌
DuckStation (Beta)	Add to Obtainium!	✅
Eden	Add to Obtainium!	✅
NetherSX2 Classic	Add to Obtainium!	✅
NetherSX2 Classic (Pre-Release)	Add to Obtainium!	❌
PPSSPP	Add to Obtainium!	✅
RPCSX	Add to Obtainium!	✅
RetroArch AArch64 (Nightly)	Add to Obtainium!	❌
RetroArch AArch64 (Stable)	Add to Obtainium!	✅
ScummVM	Add to Obtainium!	✅
Vita3K	Add to Obtainium!	✅
Vita3K ZX	Add to Obtainium!	✅
Winlator	Add to Obtainium!	✅
melonDS	Add to Obtainium!	✅
melonDS Nightly	Add to Obtainium!	❌

Frontend

Application Name	Add to Obtainium	Included in export json?
Daijishō	Add to Obtainium!	✅
Pegasus	Add to Obtainium!	✅

Streaming

Application Name	Add to Obtainium	Included in export json?
Artemis	Add to Obtainium!	✅
Moonlight	Add to Obtainium!	✅

Track Only

Application Name	Add to Obtainium	Included in export json?
AdrenoToolsDrivers	Add to Obtainium!	✅
Obtainium Emulation Pack	Add to Obtainium!	✅

Utilities

Application Name	Add to Obtainium	Included in export json?
ES-DE Android Apps	Add to Obtainium!	✅
Syncthing-Fork	Add to Obtainium!	✅

FAQ

Why do some applications say TRACK ONLY?

As the name implies, these application versions are only tracked, not pulled. This was done because we can't pull these resources, but you may still care to know when these resources have updates so you can pull them manually. For example: NetherSX2 can't provide an APK for legal reasons, but you'll get update notifications so you don't have to manually check or be stuck with outdated resources.

How do I use TRACK ONLY resources?

When you get notified of an update to your track only resource:

• visit the link to your resource
• download it manually
• in obtainium > click resource > click "Mark Updated"

How do I updated Obtainium Emulation Pack?

Same as install method. It'll update existing resources. It will not remove any other resources you've added.

A new switch emulator has released! Can you add it?

Note

Context: I have a full time job, a family. I do this for fun. With that in mind...

I want to be very selective about which switch emulators I add to this pack. The switch emulation space can be very volatile, and I don't want to be in a position where I have to chase a moving target and update the pack every day.

The switch emulators I've added have proven to be somewhat stable in where they are and how they're tracked.

A note about stable, beta, nightly and canary versions of the same app

You cannot install more than one version of the same app. For example: You must choose between RetroArch (stable) or RetroArch (nightly). You cannot have both.

To make things easier for beginners, I've omitted nightly, beta and canary versions where a stable one exists.

You can manually add beta/nightly applications by using the links in the README

How does this work?

Obtainium allows you to filter for links on a page using regular expression (regex) It also allows you to follow multiple links using regex. see https://regexr.com/7rmf7 for a basic example of how this works.

Can this break?

Yes. Absolutely it can. Any of the scrapers that use regex can break if the maintainer changes their page. The applications pulling from GitHub are more stable and less likely to break.

Development & Contribution

Contributing

You are welcome to make a PR with a contribution.

1. Making changes to the pack

You'll want to directly edit only things in either ./pages/ or ./src/. Everything else should be designed to update through scripts. Including the README!

...why template out the README? Because that table is very cumbersome to update on every change.

2. Pre-Commit

Before you commit, make sure to run make release. This will:

• template the README
• update the minified json release file

Development Tips

Meta field options

My scripts will do specific actions if a meta field is present

key	type	default	description
exludeFromExport	bool	false	Excludes the app from the release export json.
exludeFromTable	bool	false	Excludes the app from the README table.
nameOverride	string	null	overwrite emulator name, useful if the default name is not human friendly