Skip to content

README.md

Latest commit

 

History

History
80 lines (65 loc) · 2.51 KB

README.md

File metadata and controls

80 lines (65 loc) · 2.51 KB
Raw

PL2

Package for creating PL2 palette transform files

Report Bug · Request Feature

About

This package provides a PL2 palette transformation codec.

This package also contains command-line and graphical applications for working with PL2 files.

Project Structure

  • pkg/ - This directory contains the core PL2 library. 
    import (
    pl2 "github.com/OpenDiablo2/pl2/pkg"
)
  • cmd/ - This directory contains command-line and graphical applications, each having their own sub-directory.
  • assets/ - This directory contains files, like the images displayed in this README, or test pl2 file data.

Getting Started

Prerequisites

You need to install Go 1.16, as well as set up your go environment. In order to install the applications inside of cmd/, you will need to make sure that $GOBIN is defined and points to a valid directory, and this will also need to be added to your $PATH environment variable.

export GOBIN=$HOME/.gobin
mkdir -p $GOBIN
PATH=$PATH:$GOBIN

Installation

As long as $GOBIN is defined and on your $PATH, you can build and install all apps inside of cmd/ by running these commands:

# clone the repo, enter the dir
git clone http://github.com/OpenDiablo2/pl2
cd pl2

# build and install inside of $GOBIN
go build ./cmd/...
go install ./cmd/...

At this point, you should be able to run the apps inside of cmd/ from the command-line, like pl2-to-gpl.

Contributing

I've set up all of the repos with a similar project structure. ~/pkg/ is where the actual transcoder library is, and ~/cmd/ has subdirectories for each CLI/GUI application that can be compiled.

Any contributions are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request