Skip to content

Latest commit

 

History

History
57 lines (46 loc) · 4.66 KB

README.md

File metadata and controls

57 lines (46 loc) · 4.66 KB
Raw

Like my work?

Support me on https://ko-fi.com/natrox !

Last updated on: 2022-10-30

Extra utilities for your MiSTer FPGA

This repository is an ongoing effort to create extra scripts, programs, documents and more for the MiSTer FPGA. Please feel free to use them as you see fit - if you wish to integrate these resources into your own repository and/or pack, please comply with the LICENSE.

Directories

These are subject to change, but right now this is how I have things set up:

Directory Description
scripts Scripts and binaries for use ON the MiSTer FPGA.
docs Documentation and tutorials generally related to MiSTer.
host Scripts and binaries for use on Linux I think are useful.

Each entry in each folder will have some description in this README.

How to use

For scripts, you can clone this repository or directly download the raw files. Put them in /media/fat/Scripts. If you cherry-pick your downloads, some of the programs in scripts may have dependencies - these will be checked for at run-time, so you can figure out which other files you should download. These dependencies are strictly limited to this repository. I also recommend to try and read the scripts. Although I will do my best to explain them in this README, it is always good to know what you are installing.

The docs folder will have tutorials and documentation in either markdown or PDF format. Some of these documents are related to the programs found in this repository - while others are not. All documents do relate to either MiSTer FPGA, or relate to procedures that help you accomplish certain goals useful for your MiSTer. docs does not follow the GPLv3 license - everything within is Public Domain.

Utilities for use on your computer can be found in host. Although some of these may work on MiSTer's embedded operating system, they are principally designed for use on computers running some flavor of Linux. As with the programs in scripts, the programs in host may have dependencies (including external ones). It is recommended to download/clone the entire folder. For external dependencies, I aim to include dependency checking within each program, but I can not guarantee it. As usual, please read the source code to get a better idea of how these programs function.

Descriptions

This is a complete list of everything found in this repository. It will be updated as more data is added.

scripts

  • migrate_sd.sh This utility can be used on a running MiSTer system to migrate to a new SD card. A USB SD card adapter is required to be connected to your MiSTer. The target SD card can be of any size - as long as it can fit all of the data on the source SD card. It performs a number of checks to make sure that the migration will be successful. A key feature of this utility is that it looks at the source SD card's disk geometry and reproduces the required geometry on the new SD card. This means that the U-Boot partition located at the tail-end of the disk is copied over, while the rest of the card is formatted to exFAT for data use. All of the original data is copied over by default - version 0.2.0 introduces folder filtering, giving you the option to skip folders if you so desire. This utility is designed to be run from the MiSTer main menu, it will guide you through disk selection and it performs the necessary checks. During the process, it will freeze the main MiSTer binary to ensure file integrity. It can also be used to make a backup SD - although it is not suitable for incremental backups.
  • psx_chd_organize.sh An extremely simple utility that will organize loose .chd images in /media/fat/games/PSX into folders. Includes support for multi-disk games. To be expanded some day.
  • auto_downclock.sh This utility automatically downclocks the MiSTer to 400MHz if a wireless controller loses connection. The idea behind it is that whenever the controller disconnects, it is likely that I am not using the MiSTer. When the controller reconnects, the MiSTer is clocked back up to what is normally runs at. It is compatible with the overclocking scripts. However, it is ultimately a fairly useless utility since running at a lower clock speed does not seem to impact thermals at all. Use at your own risk, I have only tested this with the wireless Xbox 360 dongle.

Where is the rest?

More is coming soon! I will continuously update this repository as I create more stuff for MiSTer. Please feel free to watch this repository.