https://github.com/gerph/riscos-dumpsprites
Display information about RISC OS sprites.
https://github.com/gerph/riscos-dumpsprites
riscos
Last synced: 14 days ago
JSON representation
Display information about RISC OS sprites.
- Host: GitHub
- URL: https://github.com/gerph/riscos-dumpsprites
- Owner: gerph
- Created: 2026-05-25T15:29:34.000Z (28 days ago)
- Default Branch: master
- Last Pushed: 2026-05-26T01:56:48.000Z (28 days ago)
- Last Synced: 2026-05-26T03:29:45.761Z (28 days ago)
- Topics: riscos
- Language: Python
- Homepage:
- Size: 55.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# riscos-dumpsprites
`riscos-dumpsprites` is a Python command line tool for inspecting RISC OS Sprite files.
It supports two output modes:
- A column summary of all sprites in a sprite file.
- A field-by-field report for a single named sprite.
- Machine-readable JSON output for either form.
- Validation reporting for malformed or suspicious sprite structures.
## Usage
Summarise the contents of a sprite file:
```bash
./riscos-dumpsprites sprites/wavytile,ff9
```
Describe a single sprite:
```bash
./riscos-dumpsprites sprites/basi3p02,ff9 basi3p02
```
Emit JSON:
```bash
./riscos-dumpsprites --json sprites/manysprites,ff9
./riscos-dumpsprites --json sprites/basi3p02,ff9 basi3p02
```
Validate a file:
```bash
./riscos-dumpsprites --check sprites/wavytile,ff9
```
Show richer text output:
```bash
./riscos-dumpsprites --verbose sprites/manysprites,ff9
```
Filter the sprite list:
```bash
./riscos-dumpsprites --name 'basi4*' sprites/manysprites,ff9
./riscos-dumpsprites --type 32bpp+a --has-mask sprites/manysprites,ff9
./riscos-dumpsprites --mode 27 sprites/wavytile,ff9
```
Extract a single sprite into its own sprite file:
```bash
./riscos-dumpsprites sprites/wavytile,ff9 tile_1r --extract tile_1r,ff9
```
The parser understands both old-format sprite mode words and the newer sprite mode word format, including alpha-channel and CMYK-related sprite type handling.
Detailed reports and JSON output include decoded palette entries. Text output previews the first 16 palette entries for large palettes.
For documented old-format mode numbers, the tool also reports standard mode metadata such as text resolution, graphics resolution, OS units, and logical colour count.
Summary output distinguishes sprites with no mask, classic 1bpp masks, and 8bpp alpha masks.
## Development
Run the test suite with:
```bash
python3 -m unittest discover -s tests
```
Sample sprite files used for testing live in [`sprites/`](sprites/).
## Publishing
To publish a new version to PyPI:
1. Update the version in `pyproject.toml`.
2. Build and publish using `make`:
```bash
make publish
```
*Note: This requires `twine` to be configured with your PyPI credentials.*
## References
-
-
-
-