Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

One-page "quick start" #12

Open
tomxp411 opened this issue Feb 19, 2023 · 3 comments
Open

One-page "quick start" #12

tomxp411 opened this issue Feb 19, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@tomxp411
Copy link
Contributor

Add a quick start to the docs, for new users who keep asking "how do I run a game?" in the forums or Discord.

  • move programs into the right place (as image or loose files)
  • start the emulator
  • load and run a program

Also, discuss how to organize different programs into directories in your emulator folder, using scripts to launch games from the command line.

@mooinglemur mooinglemur added the documentation Improvements or additions to documentation label Feb 20, 2023
@irmen
Copy link
Contributor

irmen commented Feb 27, 2023

Would you like this for Windows or also for Linux and Mac users?

@tomxp411
Copy link
Contributor Author

tomxp411 commented Feb 27, 2023

This was mostly a reminder for me to work on it, since there are some new features in the dev fork that are not published in an official release yet (specifically the -fsroot switch and the new file handling.)

However, if you want to take it on, then that would be great.

The basic process would be the same for all platforms:

  • Install the emulator into some place appropriate: I use /home/x16/emulator on Linux and C:\cx16\emulator on Windows.
  • Create a directory for the files (/home/x16/fsroot or C:\cx16\fsroot)
  • Create a shell script that starts the program with something like /home/x16/emulator/x16emu -fsroot /home/x16/fsroot -scale 2 -echo -rtc
  • The art of unzipping and organizing files into directories into /home/x16/fsroot
  • Start the emulator, DOS"CD:/FOLDER", LOAD "GAME", RUN

And I'd write this separately for each platform: Windows, MacOS, and Linux. It might also be useful to write a fourth version for Steam Deck, if it different significantly from the general Linux case. (I have a Steam Deck, so I can validate the Linux steps and add the SteamDeck specific stuff.)

The trick is to keep it short enough for ADD brains while making it detailed enough that someone who doesn't really understand what "zip" and "command script" can be successful.

@irmen
Copy link
Contributor

irmen commented Mar 4, 2023

I've created a proposal for the quickstart guide for Linux, see PR #25

Eventually the README itself has to link to the quickstart guides I guess, otherwise they're kinda hard to find?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants