├── .github
├── ISSUE_TEMPLATE
│ ├── bug.yml
│ ├── config.yml
│ ├── enhance.yml
│ └── guide.yml
└── pull_request_template.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
└── emulators
├── citra.md
├── dolphin.md
├── mednaffe.md
├── melonds.md
├── pcsx2.md
├── ppsspp.md
├── simple64.md
├── snes9x.md
└── yuzu.md
/.github/ISSUE_TEMPLATE/bug.yml:
--------------------------------------------------------------------------------
1 | name: 🐛 Bug
2 | description: Report an issue with the guide itself.
3 | title: "🐛 "
4 | labels: ["bug"]
5 | body:
6 | - type: markdown
7 | attributes:
8 | value: |
9 | Make sure to [search for duplicate issues](https://github.com/nchristopher/steamdeck-emulation/issues?q=label%3Abug) before opening a new one.
10 |
11 | This form is for issues with the guide itself; bugs in the emulators themselves should be reported to the emulator's maintainer(s).
12 | - type: textarea
13 | attributes:
14 | label: Description
15 | description: Describe the bug in detail. Provide examples of what the issue is, if applicable.
16 | validations:
17 | required: true
18 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | blank_issues_enabled: false
2 | contact_links:
3 | - name: "💬 GitHub Discussions"
4 | url: "https://github.com/nchristopher/steamdeck-emulation/discussions"
5 | about: "For questions or issues you're having, open a GitHub Discussion."
6 | - name: "👥 Steam Deck Discord"
7 | url: "https://discord.gg/myS7JkUtvA"
8 | about: "Check out the #emulation channel on the Steam Deck Discord."
9 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/enhance.yml:
--------------------------------------------------------------------------------
1 | name: 💡 Enhancement
2 | description: Suggest an improvement to the guide.
3 | title: "💡 "
4 | labels: ["enhancement"]
5 | body:
6 | - type: markdown
7 | attributes:
8 | value: Make sure to [search for duplicate issues](https://github.com/nchristopher/steamdeck-emulation/issues?q=label%3Aenhancement) before opening a new one.
9 | - type: textarea
10 | attributes:
11 | label: Description
12 | description: Describe the enhancement in detail.
13 | validations:
14 | required: true
15 | - type: textarea
16 | attributes:
17 | label: Why
18 | description: Why should this improvement be added to the guide? Does it solve any problems?
19 | validations:
20 | required: true
21 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/guide.yml:
--------------------------------------------------------------------------------
1 | name: 🎮 Guide Request
2 | description: Request a guide for a new system or emulator.
3 | title: "🎮 "
4 | labels: ["guide"]
5 | body:
6 | - type: markdown
7 | attributes:
8 | value: Make sure to [search for duplicate issues](https://github.com/nchristopher/steamdeck-emulation/issues?q=label%3A%22guide+request%22) before opening a new one.
9 | - type: input
10 | attributes:
11 | label: System
12 | description: What system are you requesting a guide for? If your preferred emulator supports multiple systems, open multiple issues.
13 | placeholder: Wii
14 | validations:
15 | required: true
16 | - type: input
17 | attributes:
18 | label: Emulator
19 | description: If you have a specific emulator the guide should use, put it here.
20 | placeholder: Dolphin
21 | - type: textarea
22 | attributes:
23 | label: Additional info
24 | description: Is there anything else we should know?
25 |
--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
1 |
6 |
7 | ### Proposed changes
8 |
9 |
12 |
13 | ### Tasks
14 |
15 |
18 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our
6 | community a harassment-free experience for everyone, regardless of age, body
7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
8 | identity and expression, level of experience, education, socio-economic status,
9 | nationality, personal appearance, race, religion, or sexual identity
10 | and orientation.
11 |
12 | We pledge to act and interact in ways that contribute to an open, welcoming,
13 | diverse, inclusive, and healthy community.
14 |
15 | ## Our Standards
16 |
17 | Examples of behavior that contributes to a positive environment for our
18 | community include:
19 |
20 | * Demonstrating empathy and kindness toward other people
21 | * Being respectful of differing opinions, viewpoints, and experiences
22 | * Giving and gracefully accepting constructive feedback
23 | * Accepting responsibility and apologizing to those affected by our mistakes,
24 | and learning from the experience
25 | * Focusing on what is best not just for us as individuals, but for the
26 | overall community
27 |
28 | Examples of unacceptable behavior include:
29 |
30 | * The use of sexualized language or imagery, and sexual attention or
31 | advances of any kind
32 | * Trolling, insulting or derogatory comments, and personal or political attacks
33 | * Public or private harassment
34 | * Publishing others' private information, such as a physical or email
35 | address, without their explicit permission
36 | * Other conduct which could reasonably be considered inappropriate in a
37 | professional setting
38 |
39 | ## Enforcement Responsibilities
40 |
41 | Community leaders are responsible for clarifying and enforcing our standards of
42 | acceptable behavior and will take appropriate and fair corrective action in
43 | response to any behavior that they deem inappropriate, threatening, offensive,
44 | or harmful.
45 |
46 | Community leaders have the right and responsibility to remove, edit, or reject
47 | comments, commits, code, wiki edits, issues, and other contributions that are
48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
49 | decisions when appropriate.
50 |
51 | ## Scope
52 |
53 | This Code of Conduct applies within all community spaces, and also applies when
54 | an individual is officially representing the community in public spaces.
55 | Examples of representing our community include using an official e-mail address,
56 | posting via an official social media account, or acting as an appointed
57 | representative at an online or offline event.
58 |
59 | ## Enforcement
60 |
61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 | reported to the community leaders responsible for enforcement at
63 | nchristopher@tuta.io.
64 | All complaints will be reviewed and investigated promptly and fairly.
65 |
66 | All community leaders are obligated to respect the privacy and security of the
67 | reporter of any incident.
68 |
69 | ## Enforcement Guidelines
70 |
71 | Community leaders will follow these Community Impact Guidelines in determining
72 | the consequences for any action they deem in violation of this Code of Conduct:
73 |
74 | ### 1. Correction
75 |
76 | **Community Impact**: Use of inappropriate language or other behavior deemed
77 | unprofessional or unwelcome in the community.
78 |
79 | **Consequence**: A private, written warning from community leaders, providing
80 | clarity around the nature of the violation and an explanation of why the
81 | behavior was inappropriate. A public apology may be requested.
82 |
83 | ### 2. Warning
84 |
85 | **Community Impact**: A violation through a single incident or series
86 | of actions.
87 |
88 | **Consequence**: A warning with consequences for continued behavior. No
89 | interaction with the people involved, including unsolicited interaction with
90 | those enforcing the Code of Conduct, for a specified period of time. This
91 | includes avoiding interactions in community spaces as well as external channels
92 | like social media. Violating these terms may lead to a temporary or
93 | permanent ban.
94 |
95 | ### 3. Temporary Ban
96 |
97 | **Community Impact**: A serious violation of community standards, including
98 | sustained inappropriate behavior.
99 |
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 |
106 | ### 4. Permanent Ban
107 |
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior, harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 |
112 | **Consequence**: A permanent ban from any sort of public interaction within
113 | the community.
114 |
115 | ## Attribution
116 |
117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 | version 2.0, available at
119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120 |
121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct
122 | enforcement ladder](https://github.com/mozilla/diversity).
123 |
124 | [homepage]: https://www.contributor-covenant.org
125 |
126 | For answers to common questions about this code of conduct, see the FAQ at
127 | https://www.contributor-covenant.org/faq. Translations are available at
128 | https://www.contributor-covenant.org/translations.
129 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | Thanks for your interest in contributing to the guide! Everyone is welcome to submit pull requests and issues, as long as you follow the [Contributor Code of Conduct](./CODE_OF_CONDUCT.md).
4 |
5 | ## Formatting
6 |
7 | All markdown should be formatted using [Prettier](https://prettier.io).
8 |
9 | ## Guide structure
10 |
11 | Each guide follows the same rough structure; you can view any of the guides to get an idea of it. Each guide should have the following sections
12 |
13 | - Introduction, explaining what the emulator is for, with a screenshot of the emulator itself.
14 | - Installation, explaining how to install the emulator through Discover and the terminal.
15 | - Configuring, showing optimal and required configuration for the emulator.
16 | - Steam ROM Manager, explaining how to setup the respective emulator in SRM.
17 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Attribution 4.0 International
2 |
3 | =======================================================================
4 |
5 | Creative Commons Corporation ("Creative Commons") is not a law firm and
6 | does not provide legal services or legal advice. Distribution of
7 | Creative Commons public licenses does not create a lawyer-client or
8 | other relationship. Creative Commons makes its licenses and related
9 | information available on an "as-is" basis. Creative Commons gives no
10 | warranties regarding its licenses, any material licensed under their
11 | terms and conditions, or any related information. Creative Commons
12 | disclaims all liability for damages resulting from their use to the
13 | fullest extent possible.
14 |
15 | Using Creative Commons Public Licenses
16 |
17 | Creative Commons public licenses provide a standard set of terms and
18 | conditions that creators and other rights holders may use to share
19 | original works of authorship and other material subject to copyright
20 | and certain other rights specified in the public license below. The
21 | following considerations are for informational purposes only, are not
22 | exhaustive, and do not form part of our licenses.
23 |
24 | Considerations for licensors: Our public licenses are
25 | intended for use by those authorized to give the public
26 | permission to use material in ways otherwise restricted by
27 | copyright and certain other rights. Our licenses are
28 | irrevocable. Licensors should read and understand the terms
29 | and conditions of the license they choose before applying it.
30 | Licensors should also secure all rights necessary before
31 | applying our licenses so that the public can reuse the
32 | material as expected. Licensors should clearly mark any
33 | material not subject to the license. This includes other CC-
34 | licensed material, or material used under an exception or
35 | limitation to copyright. More considerations for licensors:
36 | wiki.creativecommons.org/Considerations_for_licensors
37 |
38 | Considerations for the public: By using one of our public
39 | licenses, a licensor grants the public permission to use the
40 | licensed material under specified terms and conditions. If
41 | the licensor's permission is not necessary for any reason--for
42 | example, because of any applicable exception or limitation to
43 | copyright--then that use is not regulated by the license. Our
44 | licenses grant only permissions under copyright and certain
45 | other rights that a licensor has authority to grant. Use of
46 | the licensed material may still be restricted for other
47 | reasons, including because others have copyright or other
48 | rights in the material. A licensor may make special requests,
49 | such as asking that all changes be marked or described.
50 | Although not required by our licenses, you are encouraged to
51 | respect those requests where reasonable. More considerations
52 | for the public:
53 | wiki.creativecommons.org/Considerations_for_licensees
54 |
55 | =======================================================================
56 |
57 | Creative Commons Attribution 4.0 International Public License
58 |
59 | By exercising the Licensed Rights (defined below), You accept and agree
60 | to be bound by the terms and conditions of this Creative Commons
61 | Attribution 4.0 International Public License ("Public License"). To the
62 | extent this Public License may be interpreted as a contract, You are
63 | granted the Licensed Rights in consideration of Your acceptance of
64 | these terms and conditions, and the Licensor grants You such rights in
65 | consideration of benefits the Licensor receives from making the
66 | Licensed Material available under these terms and conditions.
67 |
68 |
69 | Section 1 -- Definitions.
70 |
71 | a. Adapted Material means material subject to Copyright and Similar
72 | Rights that is derived from or based upon the Licensed Material
73 | and in which the Licensed Material is translated, altered,
74 | arranged, transformed, or otherwise modified in a manner requiring
75 | permission under the Copyright and Similar Rights held by the
76 | Licensor. For purposes of this Public License, where the Licensed
77 | Material is a musical work, performance, or sound recording,
78 | Adapted Material is always produced where the Licensed Material is
79 | synched in timed relation with a moving image.
80 |
81 | b. Adapter's License means the license You apply to Your Copyright
82 | and Similar Rights in Your contributions to Adapted Material in
83 | accordance with the terms and conditions of this Public License.
84 |
85 | c. Copyright and Similar Rights means copyright and/or similar rights
86 | closely related to copyright including, without limitation,
87 | performance, broadcast, sound recording, and Sui Generis Database
88 | Rights, without regard to how the rights are labeled or
89 | categorized. For purposes of this Public License, the rights
90 | specified in Section 2(b)(1)-(2) are not Copyright and Similar
91 | Rights.
92 |
93 | d. Effective Technological Measures means those measures that, in the
94 | absence of proper authority, may not be circumvented under laws
95 | fulfilling obligations under Article 11 of the WIPO Copyright
96 | Treaty adopted on December 20, 1996, and/or similar international
97 | agreements.
98 |
99 | e. Exceptions and Limitations means fair use, fair dealing, and/or
100 | any other exception or limitation to Copyright and Similar Rights
101 | that applies to Your use of the Licensed Material.
102 |
103 | f. Licensed Material means the artistic or literary work, database,
104 | or other material to which the Licensor applied this Public
105 | License.
106 |
107 | g. Licensed Rights means the rights granted to You subject to the
108 | terms and conditions of this Public License, which are limited to
109 | all Copyright and Similar Rights that apply to Your use of the
110 | Licensed Material and that the Licensor has authority to license.
111 |
112 | h. Licensor means the individual(s) or entity(ies) granting rights
113 | under this Public License.
114 |
115 | i. Share means to provide material to the public by any means or
116 | process that requires permission under the Licensed Rights, such
117 | as reproduction, public display, public performance, distribution,
118 | dissemination, communication, or importation, and to make material
119 | available to the public including in ways that members of the
120 | public may access the material from a place and at a time
121 | individually chosen by them.
122 |
123 | j. Sui Generis Database Rights means rights other than copyright
124 | resulting from Directive 96/9/EC of the European Parliament and of
125 | the Council of 11 March 1996 on the legal protection of databases,
126 | as amended and/or succeeded, as well as other essentially
127 | equivalent rights anywhere in the world.
128 |
129 | k. You means the individual or entity exercising the Licensed Rights
130 | under this Public License. Your has a corresponding meaning.
131 |
132 |
133 | Section 2 -- Scope.
134 |
135 | a. License grant.
136 |
137 | 1. Subject to the terms and conditions of this Public License,
138 | the Licensor hereby grants You a worldwide, royalty-free,
139 | non-sublicensable, non-exclusive, irrevocable license to
140 | exercise the Licensed Rights in the Licensed Material to:
141 |
142 | a. reproduce and Share the Licensed Material, in whole or
143 | in part; and
144 |
145 | b. produce, reproduce, and Share Adapted Material.
146 |
147 | 2. Exceptions and Limitations. For the avoidance of doubt, where
148 | Exceptions and Limitations apply to Your use, this Public
149 | License does not apply, and You do not need to comply with
150 | its terms and conditions.
151 |
152 | 3. Term. The term of this Public License is specified in Section
153 | 6(a).
154 |
155 | 4. Media and formats; technical modifications allowed. The
156 | Licensor authorizes You to exercise the Licensed Rights in
157 | all media and formats whether now known or hereafter created,
158 | and to make technical modifications necessary to do so. The
159 | Licensor waives and/or agrees not to assert any right or
160 | authority to forbid You from making technical modifications
161 | necessary to exercise the Licensed Rights, including
162 | technical modifications necessary to circumvent Effective
163 | Technological Measures. For purposes of this Public License,
164 | simply making modifications authorized by this Section 2(a)
165 | (4) never produces Adapted Material.
166 |
167 | 5. Downstream recipients.
168 |
169 | a. Offer from the Licensor -- Licensed Material. Every
170 | recipient of the Licensed Material automatically
171 | receives an offer from the Licensor to exercise the
172 | Licensed Rights under the terms and conditions of this
173 | Public License.
174 |
175 | b. No downstream restrictions. You may not offer or impose
176 | any additional or different terms or conditions on, or
177 | apply any Effective Technological Measures to, the
178 | Licensed Material if doing so restricts exercise of the
179 | Licensed Rights by any recipient of the Licensed
180 | Material.
181 |
182 | 6. No endorsement. Nothing in this Public License constitutes or
183 | may be construed as permission to assert or imply that You
184 | are, or that Your use of the Licensed Material is, connected
185 | with, or sponsored, endorsed, or granted official status by,
186 | the Licensor or others designated to receive attribution as
187 | provided in Section 3(a)(1)(A)(i).
188 |
189 | b. Other rights.
190 |
191 | 1. Moral rights, such as the right of integrity, are not
192 | licensed under this Public License, nor are publicity,
193 | privacy, and/or other similar personality rights; however, to
194 | the extent possible, the Licensor waives and/or agrees not to
195 | assert any such rights held by the Licensor to the limited
196 | extent necessary to allow You to exercise the Licensed
197 | Rights, but not otherwise.
198 |
199 | 2. Patent and trademark rights are not licensed under this
200 | Public License.
201 |
202 | 3. To the extent possible, the Licensor waives any right to
203 | collect royalties from You for the exercise of the Licensed
204 | Rights, whether directly or through a collecting society
205 | under any voluntary or waivable statutory or compulsory
206 | licensing scheme. In all other cases the Licensor expressly
207 | reserves any right to collect such royalties.
208 |
209 |
210 | Section 3 -- License Conditions.
211 |
212 | Your exercise of the Licensed Rights is expressly made subject to the
213 | following conditions.
214 |
215 | a. Attribution.
216 |
217 | 1. If You Share the Licensed Material (including in modified
218 | form), You must:
219 |
220 | a. retain the following if it is supplied by the Licensor
221 | with the Licensed Material:
222 |
223 | i. identification of the creator(s) of the Licensed
224 | Material and any others designated to receive
225 | attribution, in any reasonable manner requested by
226 | the Licensor (including by pseudonym if
227 | designated);
228 |
229 | ii. a copyright notice;
230 |
231 | iii. a notice that refers to this Public License;
232 |
233 | iv. a notice that refers to the disclaimer of
234 | warranties;
235 |
236 | v. a URI or hyperlink to the Licensed Material to the
237 | extent reasonably practicable;
238 |
239 | b. indicate if You modified the Licensed Material and
240 | retain an indication of any previous modifications; and
241 |
242 | c. indicate the Licensed Material is licensed under this
243 | Public License, and include the text of, or the URI or
244 | hyperlink to, this Public License.
245 |
246 | 2. You may satisfy the conditions in Section 3(a)(1) in any
247 | reasonable manner based on the medium, means, and context in
248 | which You Share the Licensed Material. For example, it may be
249 | reasonable to satisfy the conditions by providing a URI or
250 | hyperlink to a resource that includes the required
251 | information.
252 |
253 | 3. If requested by the Licensor, You must remove any of the
254 | information required by Section 3(a)(1)(A) to the extent
255 | reasonably practicable.
256 |
257 | 4. If You Share Adapted Material You produce, the Adapter's
258 | License You apply must not prevent recipients of the Adapted
259 | Material from complying with this Public License.
260 |
261 |
262 | Section 4 -- Sui Generis Database Rights.
263 |
264 | Where the Licensed Rights include Sui Generis Database Rights that
265 | apply to Your use of the Licensed Material:
266 |
267 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right
268 | to extract, reuse, reproduce, and Share all or a substantial
269 | portion of the contents of the database;
270 |
271 | b. if You include all or a substantial portion of the database
272 | contents in a database in which You have Sui Generis Database
273 | Rights, then the database in which You have Sui Generis Database
274 | Rights (but not its individual contents) is Adapted Material; and
275 |
276 | c. You must comply with the conditions in Section 3(a) if You Share
277 | all or a substantial portion of the contents of the database.
278 |
279 | For the avoidance of doubt, this Section 4 supplements and does not
280 | replace Your obligations under this Public License where the Licensed
281 | Rights include other Copyright and Similar Rights.
282 |
283 |
284 | Section 5 -- Disclaimer of Warranties and Limitation of Liability.
285 |
286 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
287 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
288 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
289 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
290 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
291 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
292 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
293 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
294 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
295 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
296 |
297 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
298 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
299 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
300 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
301 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
302 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
303 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
304 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
305 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
306 |
307 | c. The disclaimer of warranties and limitation of liability provided
308 | above shall be interpreted in a manner that, to the extent
309 | possible, most closely approximates an absolute disclaimer and
310 | waiver of all liability.
311 |
312 |
313 | Section 6 -- Term and Termination.
314 |
315 | a. This Public License applies for the term of the Copyright and
316 | Similar Rights licensed here. However, if You fail to comply with
317 | this Public License, then Your rights under this Public License
318 | terminate automatically.
319 |
320 | b. Where Your right to use the Licensed Material has terminated under
321 | Section 6(a), it reinstates:
322 |
323 | 1. automatically as of the date the violation is cured, provided
324 | it is cured within 30 days of Your discovery of the
325 | violation; or
326 |
327 | 2. upon express reinstatement by the Licensor.
328 |
329 | For the avoidance of doubt, this Section 6(b) does not affect any
330 | right the Licensor may have to seek remedies for Your violations
331 | of this Public License.
332 |
333 | c. For the avoidance of doubt, the Licensor may also offer the
334 | Licensed Material under separate terms or conditions or stop
335 | distributing the Licensed Material at any time; however, doing so
336 | will not terminate this Public License.
337 |
338 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
339 | License.
340 |
341 |
342 | Section 7 -- Other Terms and Conditions.
343 |
344 | a. The Licensor shall not be bound by any additional or different
345 | terms or conditions communicated by You unless expressly agreed.
346 |
347 | b. Any arrangements, understandings, or agreements regarding the
348 | Licensed Material not stated herein are separate from and
349 | independent of the terms and conditions of this Public License.
350 |
351 |
352 | Section 8 -- Interpretation.
353 |
354 | a. For the avoidance of doubt, this Public License does not, and
355 | shall not be interpreted to, reduce, limit, restrict, or impose
356 | conditions on any use of the Licensed Material that could lawfully
357 | be made without permission under this Public License.
358 |
359 | b. To the extent possible, if any provision of this Public License is
360 | deemed unenforceable, it shall be automatically reformed to the
361 | minimum extent necessary to make it enforceable. If the provision
362 | cannot be reformed, it shall be severed from this Public License
363 | without affecting the enforceability of the remaining terms and
364 | conditions.
365 |
366 | c. No term or condition of this Public License will be waived and no
367 | failure to comply consented to unless expressly agreed to by the
368 | Licensor.
369 |
370 | d. Nothing in this Public License constitutes or may be interpreted
371 | as a limitation upon, or waiver of, any privileges and immunities
372 | that apply to the Licensor or You, including from the legal
373 | processes of any jurisdiction or authority.
374 |
375 |
376 | =======================================================================
377 |
378 | Creative Commons is not a party to its public licenses.
379 | Notwithstanding, Creative Commons may elect to apply one of its public
380 | licenses to material it publishes and in those instances will be
381 | considered the “Licensor.” The text of the Creative Commons public
382 | licenses is dedicated to the public domain under the CC0 Public Domain
383 | Dedication. Except for the limited purpose of indicating that material
384 | is shared under a Creative Commons public license or as otherwise
385 | permitted by the Creative Commons policies published at
386 | creativecommons.org/policies, Creative Commons does not authorize the
387 | use of the trademark "Creative Commons" or any other trademark or logo
388 | of Creative Commons without its prior written consent including,
389 | without limitation, in connection with any unauthorized modifications
390 | to any of its public licenses or any other arrangements,
391 | understandings, or agreements concerning use of licensed material. For
392 | the avoidance of doubt, this paragraph does not form part of the public
393 | licenses.
394 |
395 | Creative Commons may be contacted at creativecommons.org.
396 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
Steam Deck Emulation Guide
2 |
3 | This guide covers how to install emulators on a Steam Deck, setting up controls, playing games with optimal settings, and integrating them into Steam itself. It uses [Steam ROM Manager](https://steamgriddb.github.io/steam-rom-manager/), which automatically downloads cover art for each game and adds a shortcut to Steam. The end result will look like this, with Steam collections for each system:
4 |
5 | 
6 |
7 | **This is an unofficial guide**, not affiliated with Valve or any of the emulator developers. To my knowledge, it's not possible to mess up your Deck from this guide, but I take no responsibility if you do. This guide **does not** cover getting ROMs or other copyrighted material.
8 |
9 | > **Want to automate all of this?** Check out [EmuDeck](https://www.emudeck.com/), a program that sets all of this - and more - up for you.
10 |
11 | ### Current Systems Supported
12 |
13 | - [x] Nintendo Switch (Yuzu)
14 | - [x] Wii (Dolphin)
15 | - [x] GameCube (Dolphin)
16 | - [x] Nintendo 64 (simple64)
17 | - [x] SNES (Snes9x)
18 | - [x] PlayStation 2 (PCSX2)
19 | - [x] 3DS (Citra)
20 | - [x] DS (melonDS)
21 | - [x] PSP (PPSSPP)
22 | - [x] PC Engine (CD) / TurboGrafx-16 (-CD) / SuperGrafx (Mednaffe)
23 |
24 | [Open a GitHub issue](https://github.com/nchristopher/steamdeck-emulation/issues/new) to request support for a system.
25 |
26 | ### Storage
27 |
28 | This guide assumes your ROMs are under `~/roms` (a folder in your home directory), with a file structure like this:
29 |
30 | ```
31 | roms
32 | ├── switch
33 | ├── wii
34 | ├── gamecube
35 | ├── n64
36 | ├── snes
37 | ├── ps2
38 | ├── 3ds
39 | ├── ds
40 | ├── psp
41 | └── pce
42 | ```
43 |
44 | ### SD Cards
45 |
46 | If you store your roms on an SD card, substitute `~/roms` with `/run/media/mmcblk0p1/roms` in each guide. You'll have to give each Flatpak access to your SD card. Open up a terminal and run
47 |
48 | ```bash
49 | flatpak override --filesystem=/run/media/
50 | ```
51 |
52 | Substitute `` with the emulator's Flatpak name (specified in each guide). For example, Snes9x's Flatpak name is `com.snes9x.Snes9x`, so you'd run
53 |
54 | ```bash
55 | flatpak override com.snes9x.Snes9x --filesystem=/run/media/
56 | ```
57 |
58 | ## Getting Started
59 |
60 | To start off, switch to Desktop mode by pressing the **Steam** button, navigating to **Power**, then **Switch to Desktop**.
61 |
62 | Open Firefox, then navigate to [Steam ROM Manager's latest release](https://github.com/SteamGridDB/steam-rom-manager/releases/latest), and download the file ending in `.AppImage` that **DOES NOT** contain `i386`. It should be named something like `Steam-ROM-Manager-2.3.40.AppImage`.
63 |
64 | Open SteamOS' file manager Dolphin (it's different from the emulator Dolphin), then navigate to wherever you saved the file, probably in **Downloads**. You can run it by just double-tapping the file. If prompted for Steam's directory, enter `/home/deck/.local/share/Steam`.
65 |
66 | From here, the guide branches off for each system you want to emulate:
67 |
68 | - [Nintendo Switch](./emulators/yuzu.md)
69 | - [GameCube and/or Wii](./emulators/dolphin.md)
70 | - [Nintendo 64](./emulators/simple64.md)
71 | - [SNES](./emulators/snes9x.md)
72 | - [PC Engine (CD) / TurboGrafx-16 (-CD) / SuperGrafx](./emulators/mednaffe.md)
73 | - [PlayStation 2](./emulators/pcsx2.md)
74 | - [Nintendo DS](./emulators/melonds.md)
75 | - [Nintendo 3DS](./emulators/citra.md)
76 | - [PlayStation Portable (PSP)](./emulators/ppsspp.md)
77 |
78 | ## ⚠ Common Issues
79 |
80 | - If you've successfully performed the setup steps for an emulator but you get a blank screen when booting a ROM, the emulator may not have access to your ROMs directory. Open a terminal and run `flatpak override --filesystem=~/roms` to allow it to find your ROMs. Replace `` with the Flatpak name found in the guide for the emulator.
81 |
82 | ## ❓ Support
83 |
84 | If you need any help, try asking in the `#emulation` channel over in the [Steam Deck Discord](https://discord.gg/myS7JkUtvA).
85 |
86 | ## 📜 License
87 |
88 | Copyright © 2022-2023 Nicholas Christopher
89 |
90 | Unless otherwise stated, this guide is licensed under [Creative Commons BY 4.0](https://creativecommons.org/licenses/by/4.0/).
91 |
--------------------------------------------------------------------------------
/emulators/citra.md:
--------------------------------------------------------------------------------
1 | # Citra Guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [Citra](https://citra-emu.org/), a Nintendo 3DS emulator.
6 |
7 | ## Installing Citra
8 |
9 | Open Discover, SteamOS' app store, then search for **Citra**, then click on it.
10 |
11 | 
12 |
13 | In the top right, select **Sources**, then **Flatpak**, then press **Install**.
14 |
15 | Alternatively, open up a terminal and run
16 |
17 | ```bash
18 | flatpak install --user -y org.citra_emu.citra
19 | ```
20 |
21 | ## Configuring Citra
22 |
23 | Open up the emulator and navigate to **Emulation > Configure**, then switch to the **Graphics** tab on the sidebar. In the Enhancements tab, set **Internal Resolution** to **3x native**.
24 |
25 | Switch to the **Controls** tab on the sidebar, and configure controls as you wish.
26 |
27 | To load encrypted games, you'll need to dump some keys from your 3ds, then add them to Citra. You can find [instructions on Citra's website](https://citra-emu.org/wiki/aes-keys/).
28 |
29 | ## Steam ROM Manager
30 |
31 | Open Steam ROM Manager, press Parsers, then enter the following settings:
32 |
33 | - Select `Nintendo 3DS - Citra(Flatpak)` under Community Presets.
34 | - You can add additional categories to Steam category using the format `${category name}`, this is case-sensitive.
35 | - Set ROMs directory to wherever your 3DS ROMs are - if you're using the recommended path, this should be `~/roms/3ds`.
36 | - If you added AES keys to load encrypted games (see above), add `.cia` to User's glob. It should look something like this:
37 |
38 | ```
39 | ${title}@(.3ds|.3DS|.3dsx|.3DSX|.app|.APP|.axf|.AXF|.cci|.CCI|.cxi|.CXI|.elf|.ELF|.cia)
40 | ```
41 |
42 | - Press save.
43 |
44 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
45 |
46 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your 3DS games!
47 |
--------------------------------------------------------------------------------
/emulators/dolphin.md:
--------------------------------------------------------------------------------
1 | # Dolphin Guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [Dolphin](https://dolphin-emu.org), a Wii and GameCube emulator.
6 |
7 | 
8 |
9 | ## Installing Dolphin
10 |
11 | Open Discover, SteamOS' app store, then search for **Dolphin**. Click on the one labeled "A Wii/Gamecube Emulator."
12 |
13 | 
14 |
15 | In the top right, select **Sources**, then **Flatpak**, then press **Install**.
16 |
17 | Alternatively, open up a terminal and run
18 |
19 | ```bash
20 | flatpak install --user -y org.DolphinEmu.dolphin-emu
21 | ```
22 |
23 | ## Configuring Dolphin
24 |
25 | Open up the emulator and press **Config**, then the **Paths** tab. Press Add, then navigate to wherever your Wii ROMs are - if you used the recommended path, this should be `~/roms/wii`.
26 |
27 | Press Add again, this time navigating to your GameCube roms - this should be `~/roms/gamecube`.
28 |
29 | Switch to the **Audio** tab, and select "Pulse" under the drop down for "Audio Backend". Now audio will work.
30 |
31 | Switch to the **Interface** tab, and uncheck the box for "Confirm on Stop". This will allow games to close without a prompt.
32 |
33 | Press Close; your games should appear in Dolphin now.
34 |
35 | Press **Graphics**, then change Backend to Vulkan. Switch to the Enhancements tab, then change Internal Resolution to 3x Native. This will upscale titles to 1080p from the base 480p. Check the box "Render to Main Window" to keep the game window active when starting a game. Press Close.
36 |
37 | Press **Controllers**. You can configure this as you wish, but most people will want to:
38 |
39 | - Select Standard Controller for Port 1 under GameCube Controllers.
40 | - Press Configure. Make sure the controller type is "SDL/0/Microsoft X-Box 360 Pad 0", then bind the buttons to your preference. Save your setup as a profile.
41 | - Select Emulate the Wii's Bluetooth adapter under Wii Controllers.
42 | - Press Configure, then bind the buttons to your preference. Some games require extensions, and some games map better to the Deck's controller with an extension (eg. Mario Kart Wii works best mapped to a Classic Controller.)
43 |
44 | Press Close, then Close again. At this point, you can load a game to test it.
45 |
46 | Most games should work fine out-of-the-box, but for some, you might want to configure them more. Refer to the [Dolphin wiki](https://wiki.dolphin-emu.org/index.php?title=Main_Page) for more information.
47 |
48 | ## Steam ROM Manager
49 |
50 | Open Steam ROM Manager, press Parsers, then enter the following settings:
51 |
52 | - Select `Nintendo Wii - Dolphin` under Community Presets.
53 | - You can add additional categories to Steam category using the format `${category name}`, this is case-sensitive.
54 | - Set executable to `/usr/bin/flatpak`.
55 | - Set command line arguments to `run org.DolphinEmu.dolphin-emu -b -e "${filePath}"`
56 | - Set ROMs directory to wherever your Wii ROMs are. This is the same location from before.
57 | - Press save.
58 |
59 | Do the same thing again, but select `Nintendo GameCube - Dolphin` instead for Community Presets, and change your ROMs directory to your GameCube one.
60 |
61 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
62 |
63 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your Wii and GameCube games!
64 |
--------------------------------------------------------------------------------
/emulators/mednaffe.md:
--------------------------------------------------------------------------------
1 | # Mednaffe guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [Mednaffe](https://github.com/AmatCoder/mednaffe), a front-end for [Mednafen](https://mednafen.github.io/), a multi-system emulator.
6 |
7 | 
8 |
9 | ## Installing Mednaffe
10 |
11 | Open Discover, SteamOS' app store, then search for **Mednaffe**, then click on it.
12 |
13 | 
14 |
15 | In the top right, select **Sources**, then **Flatpak**, then press **Install**.
16 |
17 | Alternatively, open up a terminal and run
18 |
19 | ```
20 | flatpak install --user -y com.github.AmatCoder.mednaffe
21 | ```
22 |
23 | ## Configuring Mednaffe
24 |
25 | ### Issues with sound
26 |
27 | Open up the emulator, then navigate to **Global Settings > Sound**. Make sure `Enable sound output` is ticked, and that `Driver` is set to `sdl`, otherwise you won't get any sound.
28 |
29 | ### Input mapping
30 |
31 | Switch to the **Systems** tab. For each system, you can map various controllers under the **Input** sub-tab. In Desktop mode, you'll need to launch Steam before mapping Steam Deck inputs properly, otherwise it won't be recognized as a controller.
32 |
33 | 
34 |
35 | (Input device refers to the emulated system's controller, not the real one you're using)
36 |
37 | ### Graphics (optional)
38 |
39 | From the same **Systems** tab, you can access a **Graphics** sub-tab for each system, in which I'd recommend making the following changes:
40 |
41 | - In **Fullscreen**, set `Stretch to fill screen` to `aspect`, otherwise by default the output will be integer-scaled (to the nearest multiple of 2), so it won't fill your Steam Deck's screen.
42 |
43 | - This one is quite personal, but making changes to either the **Scaler/Filter** or **Shader** tabs might suit you, if you're looking for a specific feel. My recommended setting would be `autoipsharper` for `OpenGL shader` in **Shader**, but you might want to tweak and read [Mednafen's documentation](https://mednafen.github.io/documentation/).
44 |
45 | ### CD BIOS (optional)
46 |
47 | You will need to get `syscard3.pce` (BIOS) for PC Engine CD / TurboGrafx-CD emulation and set the correct path in the **Systems > Emulation** tab (`CD BIOS`).
48 |
49 | ## Steam ROM Manager
50 |
51 | Open Steam ROM Manager, press Parsers, then enter the following settings:
52 |
53 | - Select `NEC PC Engine/TurboGrafx 16 - Retroarch - Beetle PCE` under Community Presets.
54 |
55 | - Steam ROM Manager doesn't have a preset for non-RetroArch PCE (Mednafen), so we're going to modify the RetroArch one.
56 |
57 | - You can add additional categories to Steam category using the format `${category name}`, this is case-sensitive.
58 | - Change configuration title to `NEC PC Engine/TurboGrafx 16 - Mednafen` to make it less confusing.
59 | - Tick `Show advanced options` and untick `Append arguments to executable`.
60 | - Set executable to `/usr/bin/flatpak`.
61 | - Set command line arguments to `run --branch=stable --arch=x86_64 --command=mednafen com.github.AmatCoder.mednaffe "${filepath}"`.
62 | - NB: `--command=mednafen` is important here, as we're effectively launching the `Mednafen` CLI from within the `Mednaffe` flatpak.
63 | - Set ROMs directory to wherever your PC Engine/TurboGrafx-16 ROMs are - if you're using the recommended path, this should be `~/roms/pce`.
64 | - If you have `.pce` ROMs, you will need to change User's glob to take those into account, eg. `${title}@(.7z|.7Z|.ccd|.CCD|.chd|.CHD|.cue|.CUE|.iso|.ISO|.pce|.PCE|.zip|.ZIP)`.
65 | - If you have sub-directories for your ROMs (eg: PC Engine CD ROMs in the `.cue/bin` format), then an appropriate User's glob would be: `${title}/*.@(cue|CUE)`.
66 | - Press save.
67 |
68 | 
69 |
70 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
71 |
72 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your PC Engine/TurboGrafx-16 games!
73 |
74 | If you have separate ROMs directories for PC Engine CD/TurboGrafx-CD/SuperGrafx games, then repeat the same process with a different parser.
75 |
--------------------------------------------------------------------------------
/emulators/melonds.md:
--------------------------------------------------------------------------------
1 | # melonDS Guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [melonDS](https://melonds.kuribo64.net/), a Nintendo DS emulator.
6 |
7 | 
8 |
9 | ## Installing melonDS
10 |
11 | Open Discover, SteamOS' app store, then search for **melonDS**, then click on it.
12 | 
13 |
14 | In the top right, select **Sources**, then **Flatpak**, then press **Install**.
15 |
16 | Alternatively, open up a terminal and run
17 |
18 | ```bash
19 | flatpak install --user -y net.kuribo64.melonDS
20 | ```
21 |
22 | ## Configuring melonDS
23 |
24 | Open up the emulator, then navigate to **Config > Input and hotkeys**. From here, you can map the controls as you wish. Press OK when you're done.
25 |
26 | Navigate to **Config > Video settings**. Set 3D renderer to OpenGL (if it's not already), then under OpenGL renderer, set Internal resolution to 6x native. This will upscale the game to the Steam Deck's resolution.
27 |
28 | ## Steam ROM Manager
29 |
30 | Open Steam ROM Manager, press Parsers, then enter the following settings:
31 |
32 | - Select `Nintendo DS - Retroarch - melonDS` under Community Presets.
33 | - Steam ROM Manager doesn't have a preset for non-RetroArch melonDS, so we're going to modify the RetroArch one.
34 | - You can add additional categories to Steam category using the format `${category name}`, this is case-sensitive.
35 | - Change configuration title to `Nintendo DS - melonDS` to make it less confusing.
36 | - Set executable to `/usr/bin/flatpak`.
37 | - Set command line arguments to `run net.kuribo64.melonDS -f "${filePath}"`
38 | - Set ROMs directory to wherever your DS ROMs are - if you're using the recommended path, this should be `~/roms/ds`.
39 | - Press save.
40 |
41 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
42 |
43 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your DS games!
44 |
--------------------------------------------------------------------------------
/emulators/pcsx2.md:
--------------------------------------------------------------------------------
1 | # PCSX2 Guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [PCSX2](https://pcsx2.net/), a PlayStation 2 emulator.
6 |
7 | ## Installing PCSX2
8 |
9 | Open Discover, SteamOS' app store, then search for **PCSX2**, then click on it.
10 |
11 | 
12 |
13 | In the top right, select **Sources**, then **Flatpak**, then press **Install**.
14 |
15 | Alternatively, open up a terminal and run
16 |
17 | ```bash
18 | flatpak install --user -y net.pcsx2.PCSX2
19 | ```
20 |
21 | ## Configuring PCSX2
22 |
23 | Open up the emulator, then navigate through the initial setup. You'll have to provide your own PS2 BIOS file.
24 |
25 | Under the **Debug** menu, uncheck **Show Program Log**.
26 |
27 | Navigate to **Config > General Settings**, then in the Speedhacks menu, enable MTVU under the microVU Hacks section.
28 |
29 | Open GS Window in General Settings, then change the aspect ratio to "Fit to Window/Screen", then apply & close general settings.
30 |
31 | Navigate to **Config > Graphics Settings**, then set the following:
32 |
33 | - Internal Resolution: 2x Native
34 | - CRC Hack Level: Aggressive
35 |
36 | Open the Hacks tab, then set the following:
37 |
38 | - Manual HW Hacks: toggle ON
39 | - Fast Texture Invalidation: toggle ON
40 |
41 | Open Advanced settings, then set the following:
42 |
43 | - Precache Textures: toggle ON
44 |
45 | ## Steam ROM Manager
46 |
47 | Open Steam ROM Manager, press Parsers, then enter the following settings:
48 |
49 | - Select `Sony Playstation 2 - PCSX2` under Community Presets.
50 | - You can add additional categories to Steam category using the format `${category name}`, this is case-sensitive.
51 | - Set executable to `/usr/bin/flatpak`.
52 | - Set command line arguments to `run net.pcsx2.PCSX2 "${filepath}" --nogui --fullscreen`
53 | - Set ROMs directory to wherever your PS2 ROMs are - if you're using the recommended path, this should be `~/roms/ps2`.
54 | - Press save.
55 |
56 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
57 |
58 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your PS2 games!
59 |
--------------------------------------------------------------------------------
/emulators/ppsspp.md:
--------------------------------------------------------------------------------
1 | # PPSSPP Guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [PPSSPP](https://www.ppsspp.org), a PSP emulator.
6 |
7 | 
8 |
9 | ## Installing PPSSPP
10 |
11 | Open Discover, SteamOS' app store, then search for **PPSSPP**. Click on the one labeled "A PlayStation Portable emulator"
12 |
13 | In the top right, press **Install**.
14 |
15 | Alternatively, open up a terminal and run
16 |
17 | ```bash
18 | flatpak install --user -y org.ppsspp.PPSSPP
19 | ```
20 |
21 | ## Configuring PPSSPP
22 |
23 | Open up the emulator, then navigate to **Settings > Graphics**.
24 | * Set **Backend** to **Vulkan**, then press **Yes** to restart now. Launch PPSSPP again.
25 | * Set **Device** to **AMD RADV VANGOGH**.
26 | * Turn on **Fullscreen**.
27 | * Turn on **VSync**.
28 | * Set **Rendering resolution** to **Auto (1:1)**.
29 | * Set **Upscale level** to **2x**.
30 | * Set **Upscale type** to **Hybrid + Bicubic**.
31 | * Turn on **Deposterize**.
32 |
33 | ## Steam ROM Manager
34 |
35 | Open Steam ROM Manager, press Parsers, then enter the following settings:
36 |
37 | - Select `Sony PlayStation Portable - PPSSPP (Flatpak)` under Community Presets.
38 | - You can add additional categories to Steam category using the format `${category name}`, this is case-sensitive.
39 | - Set ROMs directory to wherever your PSP ROMs are - if you're using the recommended path, this should be `~/roms/psp`.
40 | - Press save.
41 |
42 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
43 |
44 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your PSP games!
45 |
--------------------------------------------------------------------------------
/emulators/simple64.md:
--------------------------------------------------------------------------------
1 | # simple64 Guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [simple64](https://simple64.github.io/), a Nintendo 64 emulator. The emulator is based on [simple64-gui](https://github.com/simple64/simple64-gui), which itself is a frontend for [mupen64plus](https://mupen64plus.orgsimple64-gui
6 | 
7 |
8 | ## Installing simple64
9 |
10 | Open Discover, SteamOS' app store, then search for **simple64**, then click on it.
11 | 
12 |
13 | In the top right, select **Sources**, then **Flatpak**, then press **Install**.
14 |
15 | Alternatively, open up a terminal and run
16 |
17 | ```bash
18 | flatpak install --user -y io.github.simple64.simple64
19 | ```
20 |
21 | ## Configuring simple64
22 |
23 | Open up the emulator and navigate to **Settings > Core and Video Settings**, then switch to the ParaLLel Video tab. Enable Fullscreen, then set Upscaling to `4`, then exit out of this menu.
24 |
25 | Go to **Settings > Controller Configuration**. Under Controller 1, set Gamepad to Auto. Switch to the Manage Profiles tab, then press "New Profile (Gamepad). From here, you can map the controls as you wish.
26 |
27 | 
28 |
29 | ## Steam ROM Manager
30 |
31 | Open Steam ROM Manager, press Parsers, then enter the following settings:
32 |
33 | - Select `Nintendo 64 - Mupen64Plus` under Community Presets.
34 | - You can add additional categories to Steam category using the format `${category name}`, this is case-sensitive.
35 | - Set executable to `/usr/bin/flatpak`.
36 | - Set command line arguments to `run io.github.simple64.simple64 "${filePath}"`
37 | - Set ROMs directory to wherever your N64 ROMs are - if you're using the recommended path, this should be `~/roms/n64`.
38 | - Press save.
39 |
40 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
41 |
42 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your N64 games!
43 |
--------------------------------------------------------------------------------
/emulators/snes9x.md:
--------------------------------------------------------------------------------
1 | # Snes9x Guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [Snes9x](https://snes9x.com), a Super NES/Super Famicom emulator.
6 |
7 | 
8 |
9 | ## Installing Snes9x
10 |
11 | Open Discover, SteamOS' app store, then search for **Snes9x**, then click on it.
12 |
13 | 
14 |
15 | In the top right, select **Sources**, then **Flatpak**, then press **Install**.
16 |
17 | Alternatively, open up a terminal and run
18 |
19 | ```bash
20 | flatpak install --user -y com.snes9x.Snes9x
21 | ```
22 |
23 | ## Configuring Snes9x
24 |
25 | Open up the emulator, then navigate to **Options > Preferences**. Switch to the Display tab and check "Use fullscreen on ROM open".
26 |
27 | Switch to the Joypads tab and map the controller as you wish. You can also map hotkeys in the Shortcuts tab. You can configure any other options as you wish.
28 |
29 | ## Steam ROM Manager
30 |
31 | Open Steam ROM Manager, press Parsers, then enter the following settings:
32 |
33 | - Select `Nintendo SNES - Retroarch - Snes9x` under Community Presets.
34 | - Steam ROM Manager doesn't have a preset for non-RetroArch Snes9x, so we're going to modify the RetroArch one.
35 | - You can add additional categories to Steam category using the format `${category name}`, this is case-sensitive.
36 | - Change configuration title to `Nintendo SNES - Snes9x` to make it less confusing.
37 | - Set executable to `/usr/bin/flatpak`.
38 | - Set command line arguments to `run com.snes9x.Snes9x "${filePath}"`
39 | - Set ROMs directory to wherever your SNES ROMs are - if you're using the recommended path, this should be `~/roms/snes`.
40 | - Press save.
41 |
42 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
43 |
44 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your SNES games!
45 |
--------------------------------------------------------------------------------
/emulators/yuzu.md:
--------------------------------------------------------------------------------
1 | # Yuzu Guide
2 |
3 | ❗ Follow the [Getting Started section](../README.md#getting-started) of `README.md` first.
4 |
5 | This section of the guide explains how to setup [Yuzu](https://yuzu-emu.org/), a Nintendo Switch emulator.
6 |
7 | 
8 |
9 | ## Installing Yuzu
10 |
11 | Open Discover, SteamOS' app store, then search for **Yuzu**, then click on it.
12 |
13 | 
14 |
15 | In the top right, select **Sources**, then **Flatpak**, then press **Install**.
16 |
17 | Alternatively, open up a terminal and run
18 |
19 | ```bash
20 | flatpak install --user -y org.yuzu_emu.yuzu
21 | ```
22 |
23 | ## Configuring Yuzu
24 |
25 | You'll need to dump your keys from your Switch before proceeding. This is out of scope for this guide, but Yuzu has [a guide for it](https://yuzu-emu.org/help/quickstart/#yuzu-quickstart-guide). Once you have `prod.keys` and `title.keys`, go to **File > Open Yuzu folder**. In the directory opened, create a folder named `keys`, then place the two files there.
26 |
27 | Back in Yuzu, press **Add New Game Directory**. Navigate to wherever your Switch ROMs are - if you used the recommended path, this should be `~/roms/switch`. Your games should appear in Yuzu now.
28 |
29 | Go to **Emulation > Configure**, then **Controls**. You can map your Deck's controller to a Switch controller as you wish.
30 |
31 | ## Steam ROM Manager
32 |
33 | Open Steam ROM Manager, press Parsers, then enter the following settings:
34 |
35 | - Select `Nintendo Switch - Yuzu` under Community Presets.
36 | - Set Steam category to `${Switch}`. You can add additional categories by using the format `${category name}`, this is case-sensitive.
37 | - Set executable to `/usr/bin/flatpak`.
38 | - Set command line arguments to `run org.yuzu_emu.yuzu -f -g "${filePath}"`
39 | - Set ROMs directory to wherever your Switch ROMs are. This is the same location from before.
40 | - Press save.
41 |
42 | Go to the Preview tab, then press Generate App List. You should see your games populated. You can change the cover art used by hovering over the game and pressing the arrows.
43 |
44 | If it looks fine, press Save app list. Load up Steam or switch out of desktop mode, then check your library - you should see your Switch games!
45 |
--------------------------------------------------------------------------------