Skip to content

Tool to encode and decode icondata.vms files for the Dreamcast VMS

License

Notifications You must be signed in to change notification settings

HugoSmits86/dreamcast-vms-icondata-tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

License: MIT GoDoc Go Report Card Build Status codecov

Introduction

Icondata is a Go package for decoding and encoding ICONDATA.VMS file format.

I suspect that most users of this project are likely hobbyists instead of full-blown programmers.
For them I have included a command-line tool in the form of main.go. This is a stand-alone
program that lets users encode and decode ICONDATA.VMS files from the command-line.

Currently only the black and white icons are supported.

Install package

The package includes a make file that can install the package for multiple platforms.

#compile and install package for Windows
make install-windows
#compile and install package for MacOs
make install-macos
#compile and install package for Linux
make install-linux

Usage package

Encoding image into ICONDATA.VMS file example:

err = icondata.Encode(file, img)
if err != nil {
    log.Fatal(err)
}

Decoding ICONDATA.VMS file example:

desc, img, err := icondata.Decode(file)
if err != nil {
    log.Fatal(err)
}

Build tool

The command-line tool includes a make file that can build the tool for multiple platforms.

#compile and install package for Windows
make install-windows
#compile and install package for MacOs
make install-macos
#compile and install package for Linux
make install-linux

Usage tool

The tool program can be used from the command-line. Here is an example:

./icontool_macos -i test.vms -o test.png

⚠️ NOTE: Currently only the PNG image format is supported.

Todo

  • Support color icons.
  • Generate VMI file for VMS file.

Disclaimer

THIS PROJECT IS OFFERED ON A "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
EITHER EXPRESS OR IMPLIED. USAGE AND RELIANCE IS ENTIRELY AT YOUR OWN RISK.

About

Tool to encode and decode icondata.vms files for the Dreamcast VMS

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published