ejpasco / yam

A User Interface System for Game

Yam

A User Interface System for Game. It belongs to Code4Game.

Overview

• Projects
• Ready
• Build
• Usage
• Credits
• License
• Links

Status

In developing.

Projects

• Yam Library
• Yam Editor
• Photoshop Plug-In (only compiled by Visual C++)

Yam Library

The core of yam, is a static library, was linked by other projects.

It will include the basic element of UI system, likes widget, panel, layout and layer.

Yam Editor

A executable file, to edit/save the yam file(.yui).

You can use it to edit/save the yam file and export the new format file.

Photoshop Plug-In (only compiled by Visual C++)

The plugin of Adobe Photoshop, is the file format module, can save the yam to file.

It can save all layers and images of .psd file to yam format(.yui) by Adobe Photoshop.

Ready

Requirement

• CMake
• Visual C++ or MinGW
• Qt
• Photoshop SDK (only compiled by Visual C++)

Environment

• Add the MinGW installation directory to the "PATH" environment variable if you want compile by MinGW.

Build

1. Configure the environment by CMake.

   • Set QT_SDK_PATH to the Qt SDK installation directory.
   • Set PHOTOSHOP_SDK_PATH to the Photoshop SDK installation directory.

2. Generate the solution by CMake.

   • Generate the Visual C++ soluction or MinGW Makefile.

3. Compile/Build the project/makefile.

Usage

You can find all compiled files in "/out" directory.

Yam Editor

1. Find the yeditor.exe in "/out" directory.
2. Run and use it.

Photoshop Plug-In (only compiled by Visual C++)

1. Find the plugin file(pstoyam.8bi) in "/out" directory.
2. Copy it to the "/Plug-ins/File Formats" directory in the Photoshop directory or Set the external plugin directory to the directory what contain the pstoyam.8bi file in Photoshop

Credits

It is part of Code4Game and was created by Alex Chi.

License

See MIT License or LICENSE file

Links

1. MIT License
2. CMake
3. Visual C++
4. MinGW
5. Qt
6. Photoshop SDK