Update Readme

This commit is contained in:
Christophe Meneboeuf 2020-11-13 01:03:50 +01:00
parent 46ada95121
commit d2799ed3c9
1 changed files with 20 additions and 19 deletions

View File

@ -1,33 +1,34 @@
#Rgb2Hires
This program converts an RGB image to the Apple II's "HiRes" format. Provided it complies with this format's constraints:
# Rgb2Hires
* Source image must be 140x192. Pixels are anamorphic: twice wider than tall.
* Source image must contains six colors : BLACK, WHITE, ORANGE, GREEN, BLUE and PURPLE
This repository contains three windows projects:
* **libRgb2Hires**: a library to convert RGB image to the Apple II's HIRES format
* **Picture**: a program to convert a RGB png to a binary or an ASM that can be loaded to the HIRES memory pages of an Apple II.
* Source image must be 140x192. Pixels are anamorphic: twice wider than tall.
* Source image must contains six colors : BLACK, WHITE, ORANGE, GREEN, BLUE and PURPLE. The color may be approximation of the Apple II 6 colors. Please refer to the provided pic.
* **Tile**: given a RGB png tile sheet that statifies the same requirement as above, it extracts a 14x16 tile and converts it to ASM data. This data is not interleaved.
For more information about the "Hires" format and its limitations, please refer to Wikipedia: https://en.wikipedia.org/wiki/Apple_II_graphics#High-Resolution_.28Hi-Res.29_graphics
And one Apple II project:
* **Loader**: a program that will load and display a picture generated by the *Picture* program. A bash scripts is provided as an exemple to load the picture and the loader on an image disk. [AppleCommander](https://applecommander.github.io/) is required to do so.
## Compiling
For more information about the "Hires" format and its limitations, you can refer to my [website](https://www.xtof.info/blog/?p=768).
This repository contains two projects:
* Rgb2Hires, the conversion programm running on a PC
* Loader, for testing purposes. This program runs on Apple II hardware and displays an HiRes binary file named *test.picture* and located on the same disk.
__Note:__
### Rgb2Hires
The source is provided as a Visual Studio project. Howerver, it is standard C++11 without any Windows dependency, so it should compile on Linux and macOs without any modification.
The Windows project should compile as is on other plateforms.
#### Dependencies
## Dependencies
### Windows / Linux projects (libHires, Picture, Tile)
* Magick++
* On Windows, you have provide an environment variable called *MAGICK_HOME* and pointing to the ImageMagick folder.
* On Linux, install libmagick++-dev
* **Only ImageMagick 6 is supported**
### Loader (for Apple II)
This program will compile as an Apple II executable that you can run on the actual hardware.
It is a Makefile project and must be crosscompiled using **[CC65](https://cc65.github.io/cc65/)**
### Apple II project (Loader)
#### Dependencies
* CC65: The crosscompiler suit. Please provide an environment variable, *CC65_HOME* pointing to your CC65 folder.
### Dependencies
* [CC65](https://cc65.github.io/cc65/)
* The crosscompiler suit. Please provide an environment variable, *CC65_HOME* pointing to your CC65 folder.
# Running
A correct source image, *test.png*, is provided as an example. Convert it into a file named *test.picture* and copy it along the Apple II *Loader*, then execute on the actual hardware ;)
A correct source image, *test.png*, is provided as an example. Convert it using Picture, then copy it on a dsk image along with the Apple II loader. You can use or refer to the provided script.