AddonCreator.h

Go to the documentation of this file.

#pragma once
 
#if EDITOR
 
#include "NativeAddonManager.h"
 
#include <string>
#include <vector>
 
struct AddonCreateInfo
{
    std::string mName;
    std::string mId;           // Auto-generated from name if empty
    std::string mAuthor;
    std::string mDescription;
    std::string mVersion = "1.0.0";
    std::string mType;         // "template" or "addon"
};
 
struct PackageJsonData
{
    std::string mName;
    std::string mAuthor;
    std::string mDescription;
    std::string mVersion;
    std::string mUrl;
    std::string mType;         // "template", "addon", or empty
    std::string mTags;         // Comma-separated
 
    // Native section
    bool mHasNative = false;
    std::string mNativeTarget; // "editor" or "engine"
    std::string mSourceDir = "Source";
    std::string mBinaryName;
    std::string mEntrySymbol = "PolyphasePlugin_GetDesc";
    int mApiVersion = 1;
};
 
struct UserAddonInfo
{
    std::string mId;
    std::string mName;
    std::string mPath;
    std::string mType;         // "template", "addon", "native", or empty
};
 
namespace AddonCreator
{
    // ===== Creation =====
 
    bool CreateTemplate(const AddonCreateInfo& info, const std::string& targetDir, std::string& outError);
 
    bool CreateAddon(const AddonCreateInfo& info, const std::string& targetDir, std::string& outError);
 
    bool CreateNativeAddon(const NativeAddonCreateInfo& info, const std::string& targetDir,
                           std::string& outError, std::string* outPath = nullptr);
 
    // ===== Initialization =====
 
    bool InitializeAsTemplate(const std::string& projectDir, std::string& outError);
 
    bool InitializeAsAddon(const std::string& projectDir, std::string& outError);
 
    bool InitializeAsNativeAddon(const std::string& projectDir, std::string& outError);
 
    // ===== Publishing =====
 
    bool PublishViaGit(const std::string& addonDir, const std::string& commitMessage,
                       bool push, std::string& outError, std::string& outLog);
 
    bool PublishAsZip(const std::string& addonDir, const std::string& outputPath, std::string& outError);
 
    // ===== Package.json Operations =====
 
    bool ReadPackageJson(const std::string& path, PackageJsonData& outData, std::string& outError);
 
    bool WritePackageJson(const std::string& path, const PackageJsonData& data, std::string& outError);
 
    void OpenInExternalEditor(const std::string& path);
 
    // ===== Utilities =====
 
    std::string GenerateIdFromName(const std::string& name);
 
    std::vector<UserAddonInfo> GetUserCreatedAddons(const std::string& projectDir);
 
    bool IsGitAvailable();
 
    bool HasGitRepo(const std::string& dir);
 
    bool InitGitRepo(const std::string& dir, std::string& outError);
 
    bool HasGitRemote(const std::string& dir);
};
 
#endif // EDITOR