kamiext

README

KamiExt

KamiReader Extension basic methods to use in extensions. Here follow the guide on how to use it, if you want to make an extension witouth using kamiext scroll down.

KamiExt provide easy and type safe methods to make an extension. Just follow the template inside "template/extension.go" in this repository.

TLDR for users that doesn't have to use KamiExt

• Commands are executed by KamiExt as a normal CLI program. You will take input in this format:

  'your_program.exe CommandName --arg_name argdata --arg_name2 argdata2'
  

• Different methods receive different arguments in different types:
  • GetComicByHandle:

    sourceid        string
    comic_handle    string
    

  • SearchComicByTitle:

    sourceid        string
    title           string
    

  • GetPagesByChapterHandle:

    sourceid        string
    chapter_handle  string
    

  • GetPageByHandle:

    sourceid        string
    page_handle     string
    

• Data should be sent back to standard output in json format. The json response is command dependant but the "data" key is were you put the response, the "error" key is where you put the error string (this will change in the future) and the "dataversion" key is where you write the current DataVersion (current version is "1.0"). Here is the current different responses (You could also check types.go):
  • GetComicByHandle:

    {
        "data":{
            "title":"",
            "id":"",
            "url":"",
            "comictype":"",
            "releasestatus":"",
            "summary":"",
            "cover":"",
            "authors":"",
            "artists":"",
            "altnames":"",
            "genres":"",
            "year":"",
            "chapters":[
                {
                    "name":"",
                    "number":"",
                    "timestamp":"",
                    "handle":"",
                    "pages":[""]
                }
            ]
        },
        "error":""
    }
    

  • SearchComicByTitle:

    {
        "data": {
            "title":"",
            "id":"",
            "handle":"",
            "cover":""
        },
        "error":""
    }
    

  • GetPagesByChapterHandle:

    {
        "data": [""],
        "error":""
    }
    

  • GetPageByHandle:

    {
        "data": "base64_encoded_image",
        "error":""
    }
    

Documentation

Index

• Constants
• func NewExtension() *ext
• type Chapter
• type Comic
• type Extension
• type ExtensionSetup
• type GetComicByHandleResponse
  • func GetComicByHandleError(err string) GetComicByHandleResponse
  • func GetComicByHandleResult(result Comic) GetComicByHandleResponse
• type GetPageByHandleResponse
  • func GetPageByHandleError(err string) GetPageByHandleResponse
  • func GetPageByHandleResult(result string) GetPageByHandleResponse
• type GetPagesByChapterHandleResponse
  • func GetPagesByChapterHandleError(err string) GetPagesByChapterHandleResponse
  • func GetPagesByChapterHandleResult(result []string) GetPagesByChapterHandleResponse
• type Response
• type SearchComic
• type SearchComicByTitleResponse
  • func SearchComicByTitleError(err string) SearchComicByTitleResponse
  • func SearchComicByTitleResult(result []SearchComic) SearchComicByTitleResponse
• type Source
• type SourceSetup

Constants

const DATAVERSION = "1.0"

Functions

func NewExtension

func NewExtension() *ext

Types

type Chapter

type Chapter struct {
	Name      string   `json:"name"`
	Number    string   `json:"number"`
	Timestamp int      `json:"timestamp"`
	Handle    string   `json:"handle"`
	Pages     []string `json:"pages"`
}

type Comic

type Comic struct {
	Title         string    `json:"title"`
	Id            string    `json:"id"`
	Url           string    `json:"url"`
	ComicType     string    `json:"comictype"`
	ReleaseStatus string    `json:"releasestatus"`
	Summary       string    `json:"summary"`
	Cover         string    `json:"cover"`
	Authors       []string  `json:"authors"`
	Artists       []string  `json:"artists"`
	Altnames      []string  `json:"altnames"`
	Genres        []string  `json:"genres"`
	Year          string    `json:"year"`
	Chapters      []Chapter `json:"chapters"`
}

type Extension

type Extension struct {
	Name            string   `json:"name"`
	ExtensionId     string   `json:"id"`
	Author          string   `json:"author"`
	ExtensionSource string   `json:"source"`
	Sources         []Source `json:"sources"`
	Logo            string   `json:"logo"`
	Executable      string   `json:"executable"`
	UpdatesUrl      string   `json:"updatesurl"`
	Updater         string   `json:"updater"`
	Version         string   `json:"version"`
}

type ExtensionSetup

type ExtensionSetup struct {
	Name       string `json:"name"`
	Author     string `json:"author"`
	Source     string `json:"source"`
	Logo       string `json:"logo"`
	UpdatesUrl string `json:"updatesurl"`
	Updater    string `json:"updater"`
	Version    string `json:"version"`
}

type GetComicByHandleResponse

type GetComicByHandleResponse struct {
	Data        Comic  `json:"data"`
	Error       string `json:"error"`
	DataVersion string `json:"dataversion"`
}

func GetComicByHandleError

func GetComicByHandleError(err string) GetComicByHandleResponse

error public methods

func GetComicByHandleResult

func GetComicByHandleResult(result Comic) GetComicByHandleResponse

result public methods

type GetPageByHandleResponse

type GetPageByHandleResponse struct {
	Data        string `json:"data"`
	Error       string `json:"error"`
	DataVersion string `json:"dataversion"`
}

func GetPageByHandleError

func GetPageByHandleError(err string) GetPageByHandleResponse

func GetPageByHandleResult

func GetPageByHandleResult(result string) GetPageByHandleResponse

type GetPagesByChapterHandleResponse

type GetPagesByChapterHandleResponse struct {
	Data        []string `json:"data"`
	Error       string   `json:"error"`
	DataVersion string   `json:"dataversion"`
}

func GetPagesByChapterHandleError

func GetPagesByChapterHandleError(err string) GetPagesByChapterHandleResponse

func GetPagesByChapterHandleResult

func GetPagesByChapterHandleResult(result []string) GetPagesByChapterHandleResponse

type Response

type Response struct {
	Data        any    `json:"data"`
	Error       string `json:"error"`
	DataVersion string `json:"dataversion"`
}

type SearchComic

type SearchComic struct {
	Title  string `json:"title"`
	Id     string `json:"id"`
	Handle string `json:"handle"`
	Cover  string `json:"cover"`
}

type SearchComicByTitleResponse

type SearchComicByTitleResponse struct {
	Data        []SearchComic `json:"data"`
	Error       string        `json:"error"`
	DataVersion string        `json:"dataversion"`
}

func SearchComicByTitleError

func SearchComicByTitleError(err string) SearchComicByTitleResponse

func SearchComicByTitleResult

func SearchComicByTitleResult(result []SearchComic) SearchComicByTitleResponse

type Source

type Source struct {
	Name        string   `json:"name"`
	Methods     []string `json:"methods"`
	Id          string   `json:"id"`
	Logo        string   `json:"logo"`
	Domain      string   `json:"domain"`
	ExtensionId string   `json:"extensionid"`
}

type SourceSetup

type SourceSetup struct {
	Name    string   `json:"name"`
	Domain  string   `json:"domain"`
	Methods []string `json:"methods"`
	Logo    string   `json:"logo"`
	Id      string   `json:"id"`
}