Major updates to the help system. New files added for getting started and for the upload server.
This commit is contained in:
@@ -1,10 +1,11 @@
|
||||
# Change log for the gaming image
|
||||
|
||||
Dates are given for the image. All items listed are available for the listed image version coinciding with the listed date. For example, everything listed under may 7, 2025 are available in the imaged named stormux_gaming_image-2025.05.07.img.xz.
|
||||
Dates are given for the image. All items listed are available for the listed image version coinciding with the listed date. For example, everything listed under may 7, 2025 are available in the image named stormux_gaming_image-2025.05.07.img.xz.
|
||||
|
||||
|
||||
## September 1, 2025
|
||||
|
||||
- Major review and fixes to help files. Added getting started and upload server help files
|
||||
- Updated xlibre stack. Required almost total reinstall because of some package naming issues in the AUR
|
||||
- Made booting from USB image with image also installed to internal hard drive much more reliable
|
||||
- Added fex-emu-git to stormux package repository
|
||||
@@ -157,3 +158,4 @@ During this release cycle the AUR experienced a DoS attack along with other Arch
|
||||
|
||||
- Initial image released for Patrons
|
||||
- Still pre-alpha, some things are broken, but most of the main interfaces work
|
||||
|
||||
|
||||
@@ -29,3 +29,4 @@ For updates, announcements, and occasional conversation, you can follow Stormux
|
||||
https://social.stormux.org/@stormux
|
||||
|
||||
Feel free to reply to posts or mention the account if you have questions or feedback.
|
||||
|
||||
|
||||
@@ -10,3 +10,4 @@ The version of minidlna shipped with the Stormux Gaming Image has been patched t
|
||||
Currently music can be added from the upload server. Magic-wormhole is also available on the image. Videos and pictures that are uploaded through the server will be placed in ~/Downloads and must be moved to their folders manually.
|
||||
|
||||
For those who are unfamiliar with DLNA, it allows you to stream the media stored on the device with the server, in this case the Stormux Gaming image, to a DLNA compatible device such as a smart TV, a computer or phone with compatible software such as vlc, etc.
|
||||
|
||||
|
||||
@@ -7,15 +7,15 @@ The menus for the game launcher are quite simple. In order to move through items
|
||||
|
||||
This is the menu that opens when you first boot the Raspberry pi. It also is where you are placed after closing an application or document such as this help file.
|
||||
|
||||
- UpArrow: Move up an item.
|
||||
- DownArrow: Move down an item.
|
||||
- Up Arrow: Move up an item.
|
||||
- Down Arrow: Move down an item.
|
||||
- Enter: Activate the currently selected item.
|
||||
- LeftArrow: Change category, Arcade, Text Games, Web, etc.
|
||||
- RightArrow: Change category, Arcade, Text Games, Web, etc.
|
||||
- 9: Decrease sysstem volume.
|
||||
- 0: Increase sysstem volume.
|
||||
- LeftBracket: Decrease speech rate.
|
||||
- RightBracket: Increase speech rate.
|
||||
- Left Arrow: Change category, Arcade, Text Games, Web, etc.
|
||||
- Right Arrow: Change category, Arcade, Text Games, Web, etc.
|
||||
- 9: Decrease system volume.
|
||||
- 0: Increase system volume.
|
||||
- Left Bracket: Decrease speech rate.
|
||||
- Right Bracket: Increase speech rate.
|
||||
- Escape: Refresh the menu. Use this if for some reason you lose speech in the menu.
|
||||
|
||||
|
||||
@@ -23,45 +23,46 @@ This is the menu that opens when you first boot the Raspberry pi. It also is whe
|
||||
|
||||
This is the menu that opens when you select "Apple 2e with Disk."
|
||||
|
||||
- UpArrow: Move up an item.
|
||||
- DownArrow: Move down an item.
|
||||
- Up Arrow: Move up an item.
|
||||
- Down Arrow: Move down an item.
|
||||
- Enter: Activate the currently selected item.
|
||||
- Escape: Close the menu.
|
||||
- 9: Decrease sysstem volume.
|
||||
- 0: Increase sysstem volume.
|
||||
- LeftBracket: Decrease speech rate.
|
||||
- RightBracket: Increase speech rate.
|
||||
- 9: Decrease system volume.
|
||||
- 0: Increase system volume.
|
||||
- Left Bracket: Decrease speech rate.
|
||||
- Right Bracket: Increase speech rate.
|
||||
|
||||
|
||||
## Game Console Menu
|
||||
|
||||
This is the menu that opens from the Emulators menu. It only has categories for games it can find. If there are no games, it will say "no games found," and return to the main menu.
|
||||
|
||||
- UpArrow: Move up an item.
|
||||
- DownArrow: Move down an item.
|
||||
- Up Arrow: Move up an item.
|
||||
- Down Arrow: Move down an item.
|
||||
- Enter: Activate the currently selected item.
|
||||
- LeftArrow: Change game system, Nintendo Entertainment System, Sega Master System, etc.
|
||||
- RightArrow: Change game system, Nintendo Entertainment System, Sega Master System, etc.
|
||||
- Left Arrow: Change game system, Nintendo Entertainment System, Sega Master System, etc.
|
||||
- Right Arrow: Change game system, Nintendo Entertainment System, Sega Master System, etc.
|
||||
- Escape: Close the menu.
|
||||
- 9: Decrease sysstem volume.
|
||||
- 0: Increase sysstem volume.
|
||||
- LeftBracket: Decrease speech rate.
|
||||
- RightBracket: Increase speech rate.
|
||||
- 9: Decrease system volume.
|
||||
- 0: Increase system volume.
|
||||
- Left Bracket: Decrease speech rate.
|
||||
- Right Bracket: Increase speech rate.
|
||||
|
||||
## Music Player Menu
|
||||
|
||||
This is a menu of music you have put on the Pi. You can use the Upload Server to add music. Recommended folder structure is artist folder/albums. So, select artist folder when uploading and it will pull in all the album subdirectories. Other formats will work, but this is the optimal layout.
|
||||
|
||||
- UpArrow: Move up an album or song if in album view.
|
||||
- DownArrow: Move down an album or song if in album view.
|
||||
- Up Arrow: Move up an album or song if in album view.
|
||||
- Down Arrow: Move down an album or song if in album view.
|
||||
- Enter: Activate the currently selected item. If it's an album, show contents, if it's a song, play it.
|
||||
- LeftArrow: Change artist view, special note, to play all music, press left once when the menu opens.
|
||||
- RightArrow: Change artist view.
|
||||
- Left Arrow: Change artist view, special note, to play all music, press left once when the menu opens.
|
||||
- Right Arrow: Change artist view.
|
||||
- q: Close the menu.
|
||||
- Escape: Close the menu.
|
||||
- 9: Decrease sysstem volume.
|
||||
- 0: Increase sysstem volume.
|
||||
- LeftBracket: Decrease speech rate.
|
||||
- RightBracket: Increase speech rate.
|
||||
- 9: Decrease system volume.
|
||||
- 0: Increase system volume.
|
||||
- Left Bracket: Decrease speech rate.
|
||||
- Right Bracket: Increase speech rate.
|
||||
|
||||
The main menu will announce when it has gained focus. There is a sound that plays when the image boots as well as when the image is powering down. The sound for power on always plays, but the image for power off may not play every time. This is a problem with how quickly shutdown disables things, and currently there is no reliable solution for making it work constantly.
|
||||
|
||||
|
||||
@@ -6,9 +6,9 @@ Here are notes on games. These notes are things of interest for the Stormux Game
|
||||
## Global Keybindings
|
||||
|
||||
- Alt+F5: Perform simple OCR. This may be a bit slow.
|
||||
- Alt+Shift+F5: Intterrupt speech
|
||||
- Alt+Control+BackSpace: Close a game if it gets stuck
|
||||
- Super: Toggle transmit on or off for Mumble. Notes for configuring Mumble are available in the Terminal document from the Help and Documentation menu.
|
||||
- Alt+Shift+F5: Interrupt speech
|
||||
- Alt+Control+Backspace: Close a game if it gets stuck
|
||||
- Super: Toggle Mumble voice chat transmission on or off. Notes for configuring Mumble are available in the Terminal document from the Help and Documentation menu.
|
||||
- Shift+F3: Toggle recording. Records all sound, even through mic, so great for recording games with commentary. Recordings are in ~/Audio
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ I have had the readme files for each game translated to English. Hopefully the t
|
||||
|
||||
## Crazy Party
|
||||
|
||||
This game takes a while to load. The responsiveness when it is loaded is ok though. Because it's using nvda2speechd, sometimes messages get interrupted by the next incoming message. You can use page up and down to review the messages. On the Raspberry Pi 400 or 500 the key is Fn+Up or Down Arrow.
|
||||
This game takes a while to load. The responsiveness when it is loaded is ok though. Because it's using nvda2speechd, sometimes messages get interrupted by the next incoming message. You can use Page Up and Page Down to review the messages. On the Raspberry Pi 400 or 500 the keys are Function+Up Arrow or Function+Down Arrow.
|
||||
|
||||
- [Crazy Party Website](http://pragmapragma.free.fr/crazy-party)
|
||||
- [Change Log](file:///home/stormux/.local/games/Crazy-Party-beta82/changelog.txt)
|
||||
@@ -60,7 +60,7 @@ Documentation translated to English.
|
||||
|
||||
## Side Party
|
||||
|
||||
The first time you launch Side Party, the itch.io page will open. Download the game, and when it has finished, close the browser. Relaunch the game and the game will be installed and opened.
|
||||
The first time you launch Side Party, the itch.io page will open. Download the game, and when it has finished, close the browser. Relaunch the game and the game will be installed and opened.
|
||||
|
||||
The username dialog does not speak. To enter your user name, wait about thirty seconds, then type your name and press enter. The main menu should open after that. Thirty seconds is actually probably way to long, but I recommend it to be absolutely sure the game has opened.
|
||||
|
||||
@@ -90,3 +90,4 @@ When downloading the game, be sure to choose the portable Windows version.
|
||||
The game may freeze on first launch. To avoid this, press escape to refresh the game menu or restart the Pi.
|
||||
|
||||
- Follow these [instructions to turn off ascii art](/home/stormux/.local/games/Warsim/Blind Players of Warsim Please Read!.txt).
|
||||
|
||||
|
||||
161
home/stormux/Documents/getting_started.md
Normal file
161
home/stormux/Documents/getting_started.md
Normal file
@@ -0,0 +1,161 @@
|
||||
# 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:
|
||||
|
||||
1. **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.
|
||||
2. **Boot Sound**: You'll hear a startup sound indicating the system is loading
|
||||
3. **Automatic Login**: The system logs you in automatically as the "stormux" user
|
||||
4. **Main Menu**: The game launcher menu will open and announce itself
|
||||
5. **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, 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
|
||||
|
||||
## 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](https://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 System 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
|
||||
1. Start the Upload Server from the System menu
|
||||
2. Note the IP address and port announced
|
||||
3. Use a web browser on another device to upload music files
|
||||
4. Organize by artist folders with album subfolders for best results
|
||||
|
||||
### Playing Games
|
||||
1. Navigate to the desired game category
|
||||
2. Select a game with Enter
|
||||
3. Follow any specific instructions that appear
|
||||
4. Games typically return to the menu when you exit
|
||||
|
||||
### Configuring Internet
|
||||
1. Go to System menu
|
||||
2. Select "Configure Internet"
|
||||
3. Follow the prompts to connect to WiFi
|
||||
4. 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
|
||||
|
||||
1. **Explore the menus** to familiarize yourself with available applications
|
||||
2. **Set up internet** if you want to upload files or browse the web
|
||||
3. **Try some games** to get a feel for how they work
|
||||
4. **Read specific help files** for applications you're interested in
|
||||
5. **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.
|
||||
|
||||
@@ -7,8 +7,8 @@ Behind the scenes, music is handled with the mpv media player. This gives you th
|
||||
- F1: Announce current track information.
|
||||
- 9: Decrease volume.
|
||||
- 0: Increase volume.
|
||||
- Less Than: Previous track.
|
||||
- Greater Than: Next track.
|
||||
- Less Than: Previous track.
|
||||
- Greater Than: Next track.
|
||||
- Left Arrow: Seek backward.
|
||||
- Right Arrow: Seek forward.
|
||||
- Down Arrow: Seek backward by a larger increment.
|
||||
@@ -17,3 +17,4 @@ Behind the scenes, music is handled with the mpv media player. This gives you th
|
||||
- Right Bracket: Speed up playback.
|
||||
- q: Close mpv.
|
||||
- Shift+Q: Save your position in the current track and close mpv.
|
||||
|
||||
|
||||
@@ -14,8 +14,8 @@ This guide introduces navigation in the `w3m` web browser, as used in the Stormu
|
||||
|
||||
## Understanding Key Notation
|
||||
|
||||
- `C-x` means **hold Control and press x**.
|
||||
- `ESC-x` means **press Escape**, then press **x** (not at the same time).
|
||||
- `Control+x` means **hold Control and press x**.
|
||||
- `Escape then x` means **press Escape**, then press **x** (not at the same time).
|
||||
|
||||
|
||||
## Useful Keybindings
|
||||
@@ -29,22 +29,22 @@ This guide introduces navigation in the `w3m` web browser, as used in the Stormu
|
||||
- **Shift+B**: Return to the previous page.
|
||||
|
||||
- **PageUp**: Move up one screen.
|
||||
On Raspberry Pi 400 or 500: **Fn+LeftArrow**
|
||||
On Raspberry Pi 400 or 500: **Function+Left Arrow**
|
||||
|
||||
- **PageDown**: Move down one screen.
|
||||
On Raspberry Pi 400 or 500: **Fn+RightArrow**
|
||||
On Raspberry Pi 400 or 500: **Function+Right Arrow**
|
||||
|
||||
- **Home**: Jump to the top of the page.
|
||||
On Raspberry Pi 400 or 500: **Fn+UpArrow**
|
||||
On Raspberry Pi 400 or 500: **Function+Up Arrow**
|
||||
|
||||
- **End**: Jump to the bottom of the page.
|
||||
On Raspberry Pi 400 or 500: **Fn+DownArrow**
|
||||
On Raspberry Pi 400 or 500: **Function+Down Arrow**
|
||||
|
||||
- **q**: Quit `w3m`.
|
||||
|
||||
- **Shift+H**: Show the full list of keybindings.
|
||||
|
||||
- **ESC-l**: Open a list of all links on the page.
|
||||
- **Escape then l**: Open a list of all links on the page.
|
||||
|
||||
|
||||
## Additional Help
|
||||
@@ -52,3 +52,4 @@ This guide introduces navigation in the `w3m` web browser, as used in the Stormu
|
||||
To read the full built-in help for `w3m`, press `Shift+H` or visit the [W3M Help File](/usr/share/w3m/w3mhelp.html).
|
||||
|
||||
To return to this help page after viewing the built-in help, press `Shift+B` (to go back up one page).
|
||||
|
||||
|
||||
@@ -127,3 +127,4 @@ If you need assistance with security hardening or have questions:
|
||||
The Stormux Gaming Image prioritizes accessibility and ease of use for gaming. While it can function as a daily-use system, this requires careful consideration of the security implications and potentially implementing additional security measures.
|
||||
|
||||
**The choice is yours** - just make sure it's an informed choice based on your specific needs, environment, and risk tolerance.
|
||||
|
||||
|
||||
@@ -1,18 +1,19 @@
|
||||
# Terminal for Advanced Users
|
||||
|
||||
TTY2, a terminal, is available by pressing control+alt+f2. Before switching, it is a good idea to enable the Fenrir screen reader from the system menu so the terminal will be accessible.
|
||||
TTY2, a terminal, is available by pressing Control+Alt+F2. Before switching, it is a good idea to enable the Fenrir screen reader from the system menu so the terminal will be accessible.
|
||||
|
||||
When you are finished with the terminal, you can get back to the menu by pressing control+alt+f1. Fenrir and the menu will clash, so you may want to turn off fenrir. To do this, press Fenrir+q. On the game image, the Fenrir key is either capslock or the super key, pick which ever you like.
|
||||
When you are finished with the terminal, you can get back to the menu by pressing Control+Alt+F1. Fenrir and the menu will clash, so you may want to turn off fenrir. To do this, press Fenrir+q. On the game image, the Fenrir key is either Caps Lock or the Super key, pick whichever you like.
|
||||
|
||||
If you are not all that familiar with Linux, you probably won't spend all that much time in the terminal. The one exception is if you want to connect to a Mumble server. To do this:
|
||||
|
||||
- Start fenrir from the system menu.
|
||||
- Switch to TTY2 with control+alt+f2.
|
||||
- Switch to TTY2 with Control+Alt+F2.
|
||||
- Log in with the username stormux and the password stormux
|
||||
- type barnard-ui
|
||||
- Use up and down arrows to navigate the options, you will likely want to first add a server.
|
||||
- Choose connect to connect to a server. You will see a list of available servers. Find the one you want and press enter.
|
||||
|
||||
Transmission mode is toggled with the F1 key. To close the barnard application, press F10. You will be placed back in the menu for adding servers, connecting, etc.
|
||||
Voice transmission mode is toggled with the F1 key. To close the barnard application, press F10. You will be placed back in the menu for adding servers, connecting, etc.
|
||||
|
||||
If you are playing a game that requires the graphical user interface, any of the windows games, doom, wicked quest, etc you can use the Super key to toggle Mumble voice chat transmission on and off. The Super key is sometimes referred to as the Windows key. It is the key to the left of the left Alt key.
|
||||
|
||||
If you are playing a game that requires the graphical user interface, any of the windows games, doom, wicked quest, etc you can use the Super key to toggle transmit on and off. The super key is sometimes referred to as the Windows key. It is the key to the left of the left alt key.
|
||||
|
||||
182
home/stormux/Documents/upload_server.md
Normal file
182
home/stormux/Documents/upload_server.md
Normal file
@@ -0,0 +1,182 @@
|
||||
# Upload Server
|
||||
|
||||
The upload server provides a simple way to transfer files from other devices to your Stormux Gaming Image through a web browser. This is especially useful for adding music, ROM files, and other content to your system.
|
||||
|
||||
## Starting the Upload Server
|
||||
|
||||
1. Navigate to the **System** menu in the main game launcher
|
||||
2. Select **Upload Server**
|
||||
3. The server will start and announce the IP address and port
|
||||
4. Example: "Server running on 192.168.1.100 port 8000"
|
||||
5. **Press any key** while the server is running to hear the address and port again
|
||||
|
||||
The server will continue running until you press **Control+C** to stop it, or until you restart the system.
|
||||
|
||||
## Using the Upload Server
|
||||
|
||||
### From Another Device
|
||||
1. Make sure both devices are on the same network
|
||||
2. Open a web browser on your phone, tablet, or computer
|
||||
3. Go to the address announced by the server
|
||||
4. Example: `http://192.168.1.100:8000`
|
||||
|
||||
### Web Interface
|
||||
The upload page provides several options for different file types:
|
||||
|
||||
#### Music Files
|
||||
- **Purpose**: Add music to your ~/Music directory
|
||||
- **Best Practice**: Upload artist folders containing album subdirectories
|
||||
- **Supported Formats**: MP3, FLAC, OGG, Opus, and other common audio formats
|
||||
- **Organization**: The music player works best with Artist/Album folder structure
|
||||
|
||||
#### ROM Files
|
||||
- **Purpose**: Add game ROMs for emulators
|
||||
- **Destination**: Files go to ~/Roms directory
|
||||
- **Organization**: Create subdirectories by console type (e.g., nes, snes, gameboy)
|
||||
- **Supported Formats**: Varies by emulator system
|
||||
|
||||
#### Voxin Voice Packages
|
||||
- **Purpose**: Install additional TTS voices
|
||||
- **Format**: Must follow the pattern `voxin-language-name-quality-4version.tgz`
|
||||
- **Installation**: Automatic after upload
|
||||
- **Note**: First voice uploaded becomes the default
|
||||
- **Recommendation**: Only upload one voice package
|
||||
|
||||
#### Other Files
|
||||
- **Purpose**: General file uploads
|
||||
- **Destination**: Files are placed in ~/Downloads
|
||||
- **Manual Organization**: You'll need to move files to appropriate directories manually
|
||||
- **Use Cases**:
|
||||
- Game translation files (like dict.dat for Bokurano Daibouken 3)
|
||||
- Application installers
|
||||
- Documents and other files
|
||||
|
||||
## File Upload Process
|
||||
|
||||
1. **Select File Type**: Choose the appropriate category for your file
|
||||
2. **Choose Files**: Click "Choose Files" or "Browse" to select files from your device
|
||||
3. **Multiple Files**: You can select multiple files at once if supported
|
||||
4. **Upload**: Click the upload button to begin transfer
|
||||
5. **Progress**: You'll see upload progress for each file
|
||||
6. **Completion**: The server will confirm successful uploads
|
||||
|
||||
## Supported File Operations
|
||||
|
||||
### Music Upload
|
||||
- **Individual Files**: Upload single songs
|
||||
- **Album Folders**: Upload entire album directories
|
||||
- **Artist Folders**: Upload artist folders with multiple albums (recommended)
|
||||
- **Automatic Organization**: Files maintain their folder structure
|
||||
|
||||
### ROM Upload
|
||||
- **Individual ROMs**: Upload single game files
|
||||
|
||||
### Voice Package Installation
|
||||
- **Automatic Detection**: Server recognizes Voxin package format
|
||||
- **Automatic Installation**: Extracts and configures voice without user intervention
|
||||
- **Voice Activation**: New voice becomes active immediately
|
||||
- **Confirmation**: You'll hear a message in the new voice if installation succeeds
|
||||
|
||||
## Network Requirements
|
||||
|
||||
### Same Network
|
||||
Both your Stormux Gaming Image and the device you're uploading from must be connected to the same network:
|
||||
- **WiFi**: Both devices on the same WiFi network
|
||||
- **Ethernet**: Gaming image connected via Ethernet, other device on same router
|
||||
- **Mixed Connection**: One device WiFi, one Ethernet, but same router
|
||||
|
||||
### Internet Connection
|
||||
- **Not Required**: The upload server works on local network only
|
||||
- **WiFi Setup**: Use "Configure Internet" in System menu to connect to WiFi
|
||||
- **Network Tools**: IP address information available in Accessories menu
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Can't Access Upload Page
|
||||
- **Check Network**: Ensure both devices are on the same network
|
||||
- **Verify Address**: Press any key while server is running to hear the address again
|
||||
- **Firewall**: Server may be blocked by network firewall
|
||||
- **Restart Server**: Stop with Control+C and restart from System menu
|
||||
|
||||
### Upload Fails
|
||||
- **File Size**: Very large files may timeout
|
||||
- **Network Stability**: Ensure stable network connection
|
||||
- **File Format**: Some file types may not be supported
|
||||
- **Storage Space**: Check available disk space on gaming image
|
||||
|
||||
### Voxin Voice Not Working
|
||||
- **File Format**: Ensure filename matches exact pattern required
|
||||
- **File Integrity**: Re-download voice package if corrupted
|
||||
- **Multiple Voices**: Only first uploaded voice becomes default
|
||||
- **Manual Configuration**: Additional voices require manual setup
|
||||
|
||||
### Files Not Appearing
|
||||
- **Music**: Check ~/Music directory, may need to restart music player
|
||||
- **ROMs**: Check ~/Roms directory and appropriate system subdirectory
|
||||
- **Other Files**: Check ~/Downloads directory
|
||||
- **Permissions**: Files should have correct user ownership automatically
|
||||
|
||||
## File Organization Tips
|
||||
|
||||
### Music Organization
|
||||
```
|
||||
~/Music/
|
||||
├── Artist Name/
|
||||
│ ├── Album 1/
|
||||
│ │ ├── 01 - Song Title.mp3
|
||||
│ │ └── 02 - Another Song.mp3
|
||||
│ └── Album 2/
|
||||
│ ├── 01 - Track One.mp3
|
||||
│ └── 02 - Track Two.mp3
|
||||
```
|
||||
|
||||
### ROM Organization
|
||||
```
|
||||
~/Roms/
|
||||
├── nes/
|
||||
│ ├── Super Mario Bros.nes
|
||||
│ └── Legend of Zelda.nes
|
||||
├── snes/
|
||||
│ ├── Super Metroid.sfc
|
||||
│ └── Chrono Trigger.smc
|
||||
└── gameboy/
|
||||
├── Tetris.gb
|
||||
└── Pokemon Red.gb
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
### Local Network Only
|
||||
- The upload server only accepts connections from the local network
|
||||
- Files cannot be uploaded from the internet
|
||||
- Server stops when you close it or restart the system
|
||||
|
||||
### File Safety
|
||||
- Only upload files from trusted sources
|
||||
- Be cautious with executable files
|
||||
- Scan files for malware on the source device before uploading
|
||||
|
||||
### Network Safety
|
||||
- Only run the upload server on trusted networks
|
||||
- Stop the server when not actively uploading files
|
||||
- Be aware that anyone on your network can access the upload page while it's running
|
||||
|
||||
## Alternative File Transfer Methods
|
||||
|
||||
### Magic Wormhole
|
||||
- Available on the system for secure file transfers
|
||||
- Use from terminal (TTY2) for direct device-to-device transfer
|
||||
- More secure than upload server for sensitive files
|
||||
|
||||
### USB Storage
|
||||
- Files can be copied directly via USB drives
|
||||
- Mount USB drives manually from terminal if needed
|
||||
- Good for large file transfers or offline situations
|
||||
|
||||
### Network File Sharing
|
||||
- DLNA server available for media sharing
|
||||
- Can serve files to other network devices
|
||||
- One-way sharing from gaming image to other devices
|
||||
|
||||
The upload server is the easiest way to get files onto your Stormux Gaming Image, especially for music and game content. Keep it running only when needed, and enjoy the convenience of wireless file transfers.
|
||||
|
||||
@@ -2,10 +2,11 @@
|
||||
|
||||
By default, the gaming image uses the RHVoice BDL voice. This voice is clear and easily understandable without costing too much in the way of resources. If you do not like the default voice, and would like to change it, you can use the upload server to upload a [Voxin voice](https://oralux.org) of your choosing.
|
||||
|
||||
To do this, simply upload the file as it was saved, they follow the pattern:
|
||||
To do this, simply upload the file as it was saved, they follow the pattern:
|
||||
|
||||
voxin-language-name-quality-4version.tgz
|
||||
|
||||
This is the format the server expects. After uploading the file, installation is handled automatically. If everything goes like it should, you will hear a message in the new voice. Note that the first voice will be used, so it is recommended to only upload one Voxin package. If you want to set specific different screen reader voices, more packages may be uploaded, but screen reader configuration must be done manually.
|
||||
This is the format the server expects. After uploading the file, installation is handled automatically. If everything goes like it should, you will hear a message in the new voice. Note that the first voice will be used, so it is recommended to only upload one Voxin package. If you want to set specific different screen reader voices, more packages may be uploaded, but screen reader configuration must be done manually.
|
||||
|
||||
Changing the default voice can be done from the system menu with the set default voice option.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user