7.2 KiB
Getting Started with the Stormux Gaming Image
Welcome to the Stormux Gaming Image - a specialized Linux distribution designed for blind gamers. This guide will help you understand the basics and get started with your new system.
What is the Stormux Gaming Image?
The Stormux Gaming Image is an accessible Linux system that prioritizes gaming and entertainment. It's designed to work entirely through speech and keyboard navigation. It turns your old desktop or laptop computer or Raspberry Pi 4, 400, 5 or 500 into a gaming console for the blind.
Basic Concepts
Live System
Your gaming image can run directly from a USB drive without installing to your computer's hard drive. This is called "live mode." You can also install it permanently to your hard drive if desired.
Speech Feedback
The system uses speech-dispatcher to provide voice feedback for all interactions. You'll hear confirmation sounds and spoken text as you navigate menus and applications.
Self-Voiced Applications
Most applications on the system are "self-voiced," meaning they provide their own speech output without requiring a separate screen reader.
First Boot
When you first boot the Stormux Gaming Image:
- Volume Adjustment: You'll hear a message, "If this is loud enough, press enter." Press Enter when the sound is at a comfortable level. You can adjust it from the main menu as well. This only happens the first time the image is booted.
- Boot Sound: You'll hear a startup sound indicating the system is loading
- Automatic Login: The system logs you in automatically as the "stormux" user
- Main Menu: The game launcher menu will open and announce itself
- Speech Ready: You can immediately start navigating with the arrow keys
Main Interface: The Game Launcher
The game launcher is your home base. Here's how it works:
Navigation
- Up/Down Arrows: Move through items in the current category
- Left/Right Arrows: Change categories (Arcade, Text Games, Web, Media, etc.)
- Enter: Select the highlighted item
- Escape: Refresh the menu if speech stops working
Volume and Speech Control
- 9: Decrease system volume
- 0: Increase system volume
- Left Bracket: Decrease speech rate
- Right Bracket: Increase speech rate
Connecting to the Internet
Likely, one of the first things you will want to do is connect to the internet. To do so, when the menu comes up, press Left Arrow until you get to the System menu. If you are not automatically placed on "Connect to Internet", use Down Arrow to find that option and press Enter. The Fenrir screen reader will play its startup sound, and you will be placed in a menu of available WiFi connections. Navigate with Up and Down arrows to find the one you want and press Enter. At this point, you can either press the button on your router, or enter the WiFi password. If successful, you will be returned to the menu of connections. At this point, you can press Right Arrow twice to focus the "Quit" button. Press Enter to close NetworkManager and return to the menu.
Help and Documentation
- Access this and other help files
- Contact information for support
Media
- Music Player for playing your music collection
- BookStorm for reading eBooks
- DLNA Server toggle for streaming media to other devices
- Upload Files for adding media to your system
Essential Services
Speech System
The system uses RHVoice BDL voice by default. You can change this in the System menu under "Set Default Voice." This requires voices to be installed through the upload server. Currently the image supports voices purchased from oralux.org.
Screen Readers
- Fenrir: Available for terminal use (TTY2). Launch Fenrir from the System menu.
- Braille Support: Available if you use a braille display
Upload Server
Upload files to your system through a web interface. Start it from the Media menu and it will announce the IP address and port to use.
Getting Around
Switching Between Applications
- Most games and applications return you to the main menu when you exit
- Use Alt+Control+Backspace if a game gets stuck
- The main menu will announce when it regains focus
Terminal Access (Advanced Users)
- Control+Alt+F2: Switch to terminal (TTY2)
- Control+Alt+F1: Return to the main menu
- Enable Fenrir screen reader before using the terminal
Storage and Files
Default Directories
- ~/Music: Store your music files here for the music player
- ~/Roms: Store ROM files here for emulators (organized by system)
- ~/Downloads: Files downloaded through the upload server. These files are typically handled by the upload server and placed where needed automatically.
- ~/Audio: Recordings from the built-in recording feature
File Organization
- Music works best organized as Artist/Album folders
- ROM files should be placed in subfolders by system type
- Use the upload server for easy file transfers
Common Tasks
Adding Music
- Start the Upload Server from the Media menu
- Note the IP address and port announced
- Use a web browser on another device to upload music files
- Organize by artist folders with album subfolders for best results
Playing Games
- Navigate to the desired game category
- Select a game with Enter
- Follow any specific instructions that appear
- Games typically return to the menu when you exit
Configuring Internet
- Go to System menu
- Select "Configure Internet"
- Follow the prompts to connect to WiFi
- This enables the upload server and web browsing
Global Shortcuts
These work from anywhere in the system:
- Alt+F5: Perform OCR (read what's on screen)
- Alt+Shift+F5: Stop speech
- Shift+F3: Toggle audio recording
- Super: Toggle Mumble voice chat transmission
Getting Help
Built-in Help
- Use the "Help and Documentation" menu for guides on specific topics
- Each major application has its own help file
Community Support
- IRC: Connect to irc.stormux.org, channels #stormux and #a11y
- Mailing List: Subscribe at https://groups.io/g/stormux
- Mastodon: Follow https://social.stormux.org/@stormux
Important Notes
- The system prioritizes ease of use over security for gaming purposes
- See the Security Notice document if you plan to use this as your main system
- Keep the system on a trusted network
- Default passwords are "stormux" for the user and "root" for root
Next Steps
- Explore the menus to familiarize yourself with available applications
- Set up internet if you want to upload files or browse the web
- Try some games to get a feel for how they work
- Read specific help files for applications you're interested in
- Configure speech settings to your preference
Troubleshooting
Speech Stops Working
- Press Escape in the main menu to refresh speech
- Restart the system if problems persist
Game Gets Stuck
- Use Alt+Control+Backspace to force close
- You'll return to the main menu
Can't Connect to WiFi
- Try the "Configure Internet" option in the System menu
- Make sure you have the correct network password
The Stormux Gaming Image is designed to be intuitive once you understand these basics. Take your time exploring, and don't hesitate to reach out for help through the community channels listed above.