1.0.0 • Published 7 months ago

komomo-extra v1.0.0

Weekly downloads
-
License
CC0-1.0
Repository
github
Last release
7 months ago

Komomo-Extra

Extra Library for the LeviLamina JavaScript mod with Komomo

English | 简体中文

Introduction 🚀

This library provides extra features for the LeviLamina JavaScript mod with Komomo, such as:

  • Processing JSON configuration files conveniently
  • Easily translating text using a language dictionary(i18n)
  • ...

Usage 🛠️

Install as a mod 🎮

  • Install Komomo-Extra as a mod by lip:

    lip install github.com/TelluriumDev/Komomo-Extra
  • then import it in your mod:

    import * as KomomoExtra from "./KomomoExtra/index.js";

    also you can use

    import { ... } from "./KomomoExtra/index.js";

    to import specific functions.

don't forget to add KomomoExtra to your dependencies in your manifest.json to ensure it works properly:

{
// manifest.json
//...
   "dependencies": [
         {
            "name": "KomomoExtra"
      }
   ]
//...
}

Install as a npm package 📦

  • Join this repository as a npm by running the following command in the terminal in your project directory:

    npm i komomo-extra
  • then import it in your mod in a similar way:

    import * as KomomoExtra from "komomo-extra"

    also you can use

    import { ... } from "komomo-extra";

    to import specific functions.

Contact Us 📞

Build 🏗️

you can build the library by running the following command in the terminal in your project directory:

git clone https://github.com/TelluriumDev/Komomo-Extra.git
cd Komomo-Extra
npm i
git clone https://github.com/TelluriumDev/KomomoHelperLib.git
npx gulp build

if you want to build it as a plugin, run npx gulp plugin instead of npx gulp build.

Then, the build output of this repository will be exported to the /dist/KomomoExtra folder.

License 📜

This repository is released under the CC0-1.0 license.

PR or suggestions are welcome!🥵