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

DOCS: Document autostart feature #4743

Merged
merged 2 commits into from Mar 3, 2023
Merged

DOCS: Document autostart feature #4743

merged 2 commits into from Mar 3, 2023

Conversation

cadihowley
Copy link
Contributor

No description provided.

@lotharsm
Copy link
Member

lotharsm commented Mar 1, 2023

Looks good to me :-)

doc/docportal/advanced_topics/autostart.rst Outdated Show resolved Hide resolved
There are two ways to use the autostart feature:

- Rename the executable file to ``scummvm-auto.xxx``, where ``xxx`` is the file type extension.
- Create an empty file named ``scummvm-autorun`` in the same folder as both the executable and the chosen game. Either leave the file empty, or use it to specify any further command line options. Specify one option per line.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If not empty, the scummvm-autorun file content does not specify further command line options, but replaces the default autorun --path=. --auto-detect.

So a better example of non-empty file might be:

--fullscreen
--shader=crt/crt-lottes.glslp
--path=./game/
--auto-detect


There are two ways to use the autostart feature:

- Rename the executable file to ``scummvm-auto.xxx``, where ``xxx`` is the file type extension.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it would be worth mentioning that on macOS the executable to rename is ScummVM.app/Contents/MacOS/scummvm and not the ScummVM.app application? As written here that seems ambiguous for the macOS case.

Co-authored-by: Thierry Crozat <criezy@scummvm.org>
@sev-
Copy link
Member

sev- commented Mar 3, 2023

I am merging this and will add the requested changes in-tree.

@sev- sev- merged commit f0089a7 into scummvm:master Mar 3, 2023
5 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants