cp437-tools 0.4.1

Small collection of tools to handle CP437 files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

<div align="center">
  <!-- nix run nixpkgs#imagemagick -- logo/full.png -resize 5% logo/small.png -->
  <a href="https://github.com/kip93/cp437-tools"><img src="logo/small.png" width="256" alt="logo"/></a>
</div><div align="center">
  <b>CP437 tools</b>

  A small collection of tools to handle CP437 files.
</div><div align="center">
  <!-- Badges -->
  <a href="https://github.com/kip93/cp437-tools">
    <img src="https://img.shields.io/github/languages/code-size/kip93/cp437-tools?style=flat&label=Size&color=067CC1&cacheSeconds=3600" alt="Code size badge"/>
  </a>
  <a href="https://github.com/kip93/cp437-tools/graphs/commit-activity">
    <img src="https://img.shields.io/github/commit-activity/m/kip93/cp437-tools?style=flat&label=Commit%20activity&color=067CC1&cacheSeconds=300" alt="Commit activity badge"/>
  </a>
  <a href="https://github.com/kip93/cp437-tools/commits/main">
    <img src="https://img.shields.io/github/last-commit/kip93/cp437-tools?style=flat&label=Last%20commit&color=067CC1&cacheSeconds=300" alt="Last commit badge"/>
  </a>
</div>


## Commands

### cp437-read-meta

Prints the metadata of a file to stdout. Useful for finding issues, since it
will highlight potential problems, marking assumptions or default values with
yellow, problems in red, and successes in green. Inconsequential fields are just
shown in the default foreground colour.

<img src="screenshots/read-meta.png" width="256" alt="meta output"/>

### cp437-remove-meta

Takes a file and creates a copy without its metadata.

### cp437-set-meta

Change a single field of metadata in a file.

### cp437-to-txt

Simply strips metadata and maps CP437 to UTF-8. Takes an optional argument to
the output file, but defaults to showing the result in the terminal.

<img src="screenshots/to-txt.png" width="256" alt="TXT output"/>

### cp437-to-png

Renders the CP437 as a PNG image. Takes an optional argument to the output file,
but if not given it allows piping to other programs such as imagemagick.

<img src="screenshots/to-png.png" width="256" alt="PNG output"/>


## lib

While not intended for use as a library, it may still prove useful. Be warned
though that no guarantees are made about the stability of the API.


## Development

The repo comes with a [nix flake](./flake.nix), so simply type `nix develop` and
you'll have a bash terminal with all tools needed for building this codebase.

You have an [example file](./example.ans) for simple tests (the same used for
the screenshots above), but if you need more:

```shell
$ nix build '.#test_files'
$ ls ./result/
comments.ans  large.ans  meta.ans  simple.ans
```


## Licenses

This project's code is made freely available under the [GPLv3+](./LICENSE.md)
license. The [fonts](./res/fonts) used are provided by
[int10h.org](https://int10h.org/oldschool-pc-fonts) under the
[CC-BY-SA-4.0](./res/fonts/LICENSE) license.