Skip to content

Understanding the Limited Source Kit (LSK)#

The Limited Source Kit (LSK) is a valuable resource for developers building Miva Merchant Modules. Let’s explore its features and how it aids module development:

Overview#

  • What is the LSK?:

    • The LSK provides access to a substantial portion of the Miva Merchant source code.
    • While Miva Merchant is not open source, the LSK offers insight into its foundational code without exposing all source code.

  • Purpose:

    • It serves as a reference and starting point for building modules.
    • Developers can explore example code, functions, and snippets for module development.

Accessing the LSK#

  • Downloading:

  • Contents:

    • The LSK includes various folders, such as Modules, containing sample files for different module types.

Exploring LSK Files#

  • Sample Files:

    • Example files within the LSK provide templates for different module types.
    • These files serve as starting points for building custom modules.

  • Functionality:

    • Each module type contains essential functions required for module operation.
    • Functions are documented within the sample files, providing insight into their purpose.

Utilizing LSK Functions#

  • Function Lookup:
    • Developers can search for existing functions within the LSK for reuse in their modules.
    • Text editors like Sublime Text facilitate searching within the entire LSK for specific functions.

Module API Documentation#

  • Resource:

    • In addition to the LSK, the Module API Documentation offers comprehensive guidance.
    • It can be downloaded from the Miva Merchant website and serves as a reference guide for module development.

  • Understanding LSK Structure:

    • The API Documentation provides insights into the structure of the LSK, aiding developers in understanding Miva Merchant’s file organization and API components.

Conclusion#

The Limited Source Kit, coupled with the Module API Documentation, provides invaluable resources for Miva Merchant Module development. These tools offer guidance, example code, and function references, facilitating the creation of robust and feature-rich modules. Understanding these resources is crucial before delving into the Miva Merchant API and the MivaScript language.