1.0.4 • Published 8 months ago

@kubejs/core

Licence

—

Version

1.0.4

Deps

Size

42 kB

Vulns

Weekly

Stars

Summary Dependency Versions

bundled-kubejs

A long time ago when first time I met KubeJS mod I was so excited about it. I first looked to mod but couldn't use it cause time and knowledge. But now when I improved my self as JavaScript developer I decided to make a modpack with KubeJS mod. But regular usage of KubeJS mod is not enough for me. For that I decided to use vite as bundler for KubeJS scripts. It's small and scratch project. Please give a feedback if you have any idea.

Monorepo for writing KubeJS modpack scripts in TypeScript with a modern Vite-based workflow.

Packages

Package	Name	Description
`libs/core`	`@kubejs/core`	Shared types, CurseForge API client, manifest generation, archiving utilities
`libs/plugin`	`@kubejs/plugin`	Vite plugin + `kubejs` CLI that compiles TypeScript into KubeJS script folders
`libs/generator`	`@kubejs/generator`	Interactive CLI to scaffold new modpack projects from templates
`apps/cf-server`	`@kubejs/cf-server`	Internal NestJS server that proxies CurseForge API calls with a secure token

Stack

TypeScript — all source code
Vite — bundling for libs and end-user modpack scripts
NestJS — cf-server backend
Nx — monorepo task orchestration and build caching
Yarn 4 — workspace management
Zod — runtime validation

Setup

yarn

Building

Build all packages:

nx run-many -t vite:build

Build a single package:

nx run @kubejs/plugin:vite:build

cf-server

The server proxies CurseForge API requests so the token never reaches CLI tools, generated files, or the browser.

Environment variables

Variable	Required	Description
`CURSEFORGE_API_KEY`		CurseForge API token
`PORT`	—	Port to listen on (default: `3000`)
`NODE_ENV`	—	`development` / `production` / `test` (default: `development`)

Create a .env file inside apps/cf-server:

CURSEFORGE_API_KEY=your-token-here

Running

cd apps/cf-server
yarn start:dev   # watch mode
yarn start:prod  # production

Endpoints

Method	Path	Description
`GET`	`/api/health`	Liveness check
`GET`	`/api/curseforge/mods/search`	Search mods
`GET`	`/api/curseforge/mods/:id`	Get mod by ID
`GET`	`/api/curseforge/mods/:id/files`	Get mod files
`POST`	`/api/curseforge/mods/resolve`	Resolve mod IDs into metadata + files
`POST`	`/api/curseforge/manifest`	Generate a CurseForge `manifest.json`
`GET`	`/api/minecraft/modloaders`	Get modloaders for a Minecraft version

Generator

Scaffold a new modpack project interactively:

yarn kubejs:generator

Or with flags:

yarn generate:1.21.1:neoforge