kustom-mc 0.1.9 → 1.0.0

package/README.md

@@ -22,8 +22,8 @@ npx kustom-mc build
 # Build and watch for changes
 npx kustom-mc build --watch
 
-# Build and deploy to server
-npx kustom-mc build --deploy
+# Push to development server
+npx kustom-mc push
 ```
 
 ## Table of Contents
@@ -264,8 +264,8 @@ export default defineScript({
 
     // Create a 27-slot screen (3 rows)
     const screen = new Screen(27, {
-      hidePlayerInventory: true,  // Hide player's items
-      autoCover: true,            // Auto-fill empty slots
+      usePlayerInventorySlots: true,  // Use player inv for GUI components
+      persistenceKey: "my-gui",       // Enable persistence
     });
 
     // Or with custom texture
@@ -296,12 +296,11 @@ export default defineScript({
 
 ```typescript
 new Screen(size, {
-  hidePlayerInventory: boolean,     // Store and hide player inventory
-  playerInventoryEnabled: boolean,  // Allow inventory interaction
-  usePlayerInventorySlots: boolean, // Use player inv for buttons
-  autoCover: boolean,               // Cover empty slots
-  coverTexture: string,             // Custom cover texture
-  persistenceKey: string,           // Enable persistence
+  persistenceKey: string,           // Enable persistence with this key
+  usePlayerInventorySlots: boolean, // Use player inv for GUI components
+  id: string,                       // Unique identifier for persistence path
+  persist: boolean,                 // Enable content slot persistence
+  persistScroll: boolean,           // Enable scroll position persistence
 });
 ```
 
@@ -312,7 +311,6 @@ Use player inventory slots for extended GUIs (like numpad):
 ```typescript
 const screen = new Screen(9, {
   usePlayerInventorySlots: true,  // Enable player inv slots
-  autoCover: false,
 });
 
 // Chest slots: 0-8 (for 9-slot screen)
@@ -669,8 +667,8 @@ Compile TypeScript to JavaScript.
 ```bash
 npx kustom-mc build              # Build all scripts
 npx kustom-mc build --watch      # Watch mode
-npx kustom-mc build --deploy     # Build and copy to server
 npx kustom-mc build --no-validate # Skip validation
+npx kustom-mc build --clean      # Clean output before building
 ```
 
 #### `kustom bundle`
@@ -750,12 +748,17 @@ run({ process, props, command }) {
   ],
   "outDir": "dist",
   "lib": ["scripts/lib"],
-  "deploy": {
-    "target": "../run/plugins/kustom-plugin/kustompack",
-    "reloadCommand": "/kustom reload"
+  "manifest": {
+    "id": "my-pack",
+    "name": "My Pack",
+    "version": "1.0.0",
+    "scope": "global"
+  },
+  "server": {
+    "url": "http://localhost:8765"
   },
   "bundle": {
-    "output": "bundle/kustompack.zip",
+    "output": "dist/kustompack.zip",
     "include": ["**/*.js", "textures/**/*", "gui/**/*", "models/**/*"]
   }
 }
@@ -769,8 +772,11 @@ run({ process, props, command }) {
 | `exclude` | Patterns to exclude |
 | `outDir` | Output directory for compiled scripts |
 | `lib` | Directories containing shared libraries |
-| `deploy.target` | Server kustompack directory |
-| `deploy.reloadCommand` | Command to reload scripts |
+| `manifest.id` | Unique pack identifier (required) |
+| `manifest.name` | Human-readable pack name |
+| `manifest.version` | Pack version (semver) |
+| `manifest.scope` | Pack scope: `"global"`, `"world"`, or `"player"` |
+| `server.url` | Server URL for `kustom push` deployment |
 | `bundle.output` | Output path for bundle zip |
 | `bundle.include` | Files to include in bundle |
 

package/dist/block.d.ts

@@ -0,0 +1,21 @@
+/**
+ * kustom-mc/block — Custom block definition.
+ *
+ * @example
+ * ```ts
+ * import { defineBlock } from 'kustom-mc/block';
+ *
+ * export default defineBlock({
+ *   id: "tower",
+ *   model: "kustom:block/tower",
+ *   collision: "full",
+ *   autoPlace: true,
+ *   onClick(event) {
+ *     event.player.sendMessage("Clicked!");
+ *   }
+ * });
+ * ```
+ */
+import type { BlockConfig, BlockDefinition } from './types/index.js';
+export declare function defineBlock(config: BlockConfig): BlockDefinition;
+export type { BlockConfig, BlockDefinition, CollisionConfig, BlockClickEvent, BlockBreakEvent, BlockPlaceEvent, BlockScriptContext, ShaperAPI, ShaperTemplateBuilder, ShaperTemplateWrapper, ShaperBlockInstance, ShaperClickEvent, ShaperBreakEvent, ShaperPlaceEvent, ScriptableCollisionInfo, DefinitionBuilder, ModelNode, ModelRef, ConditionNode, SelectNode, RangeDispatchNode, CompositeNode, } from './types/index.js';

package/dist/block.js

@@ -0,0 +1,24 @@
+/**
+ * kustom-mc/block — Custom block definition.
+ *
+ * @example
+ * ```ts
+ * import { defineBlock } from 'kustom-mc/block';
+ *
+ * export default defineBlock({
+ *   id: "tower",
+ *   model: "kustom:block/tower",
+ *   collision: "full",
+ *   autoPlace: true,
+ *   onClick(event) {
+ *     event.player.sendMessage("Clicked!");
+ *   }
+ * });
+ * ```
+ */
+// ============================================
+// defineBlock
+// ============================================
+export function defineBlock(config) {
+    return config;
+}

package/dist/camera.d.ts

@@ -0,0 +1,21 @@
+/**
+ * kustom-mc/camera — Camera and Animation classes.
+ *
+ * @example
+ * ```ts
+ * import { Camera, Animation } from 'kustom-mc/camera';
+ *
+ * const cam = new Camera(100, 65, 200);
+ * cam.startCameraMode("Steve");
+ *
+ * const anim = Animation.create()
+ *   .start(100, 65, 200)
+ *   .end(150, 70, 250)
+ *   .duration(5)
+ *   .camera(cam.getId())
+ *   .build();
+ * anim.start();
+ * ```
+ */
+export { Camera, Animation } from './classes.js';
+export type { CameraAnimationBuilder, TargetAnimationBuilder, EntityTargetAnimationBuilder, AnimationSetBuilder, CameraAnimation, TargetAnimation, EntityTargetAnimation, AnimationSet, PathAPI, Path, CurveAPI, Curve, } from './types/index.js';

package/dist/camera.js

@@ -0,0 +1,23 @@
+/**
+ * kustom-mc/camera — Camera and Animation classes.
+ *
+ * @example
+ * ```ts
+ * import { Camera, Animation } from 'kustom-mc/camera';
+ *
+ * const cam = new Camera(100, 65, 200);
+ * cam.startCameraMode("Steve");
+ *
+ * const anim = Animation.create()
+ *   .start(100, 65, 200)
+ *   .end(150, 70, 250)
+ *   .duration(5)
+ *   .camera(cam.getId())
+ *   .build();
+ * anim.start();
+ * ```
+ */
+// ============================================
+// Value Exports
+// ============================================
+export { Camera, Animation } from './classes.js';

package/dist/chat.d.ts

@@ -0,0 +1,19 @@
+/**
+ * kustom-mc/chat — ChatGUI and ChatSession classes.
+ *
+ * @example
+ * ```ts
+ * import { ChatGUI, ChatSession } from 'kustom-mc/chat';
+ *
+ * const gui = new ChatGUI();
+ * gui.addLine("Welcome!");
+ * gui.open("Steve");
+ *
+ * const session = new ChatSession("lobby", (player, msg) => {
+ *   console.log(player + ": " + msg);
+ * });
+ * session.addPlayer("Steve");
+ * ```
+ */
+export { ChatGUI, ChatSession } from './classes.js';
+export type { ChatGUILine, ColumnConfig, } from './types/index.js';

package/dist/chat.js

@@ -0,0 +1,21 @@
+/**
+ * kustom-mc/chat — ChatGUI and ChatSession classes.
+ *
+ * @example
+ * ```ts
+ * import { ChatGUI, ChatSession } from 'kustom-mc/chat';
+ *
+ * const gui = new ChatGUI();
+ * gui.addLine("Welcome!");
+ * gui.open("Steve");
+ *
+ * const session = new ChatSession("lobby", (player, msg) => {
+ *   console.log(player + ": " + msg);
+ * });
+ * session.addPlayer("Steve");
+ * ```
+ */
+// ============================================
+// Value Exports
+// ============================================
+export { ChatGUI, ChatSession } from './classes.js';

package/dist/classes.d.ts

@@ -0,0 +1,206 @@
+import type { ScreenOptions, ContainerConfig, ScriptablePlayer, ElementClickEvent, GuiText, BackgroundSlot, CellState, Element, ChatGUILine, CameraAnimationBuilder, AnimationSetBuilder, TargetAnimationBuilder, EntityTargetAnimationBuilder, PathAPI, CurveAPI, GuiComponentType } from './types/index.js';
+export declare class Camera {
+    constructor(x: number, y: number, z: number, yaw?: number, pitch?: number);
+    getId(): string;
+    getLocation(): [number, number, number];
+    setLocation(x: number, y: number, z: number, yaw?: number, pitch?: number): void;
+    getYaw(): number;
+    setYaw(yaw: number): void;
+    getPitch(): number;
+    setPitch(pitch: number): void;
+    setRotation(yaw: number, pitch: number): void;
+    getDirection(): [number, number, number];
+    setDirection(x: number, y: number, z: number): void;
+    isActive(): boolean;
+    getSpectator(): string | null;
+    getSpectatorCount(): number;
+    startCameraMode(playerName: string): boolean;
+    move(dx: number, dy: number, dz: number): void;
+    moveTo(x: number, y: number, z: number): void;
+    rotate(yaw: number, pitch: number): void;
+    lookAt(x: number, y: number, z: number): void;
+    lookAtPlayer(playerName: string): void;
+    isTransparentViewEnabled(): boolean;
+    setTransparentView(enabled: boolean): void;
+    toggleTransparentView(): void;
+    clearTransparentView(): void;
+    forceUpdateTransparentView(): void;
+    setTarget(x: number, y: number, z: number): void;
+    setTargetPlayer(playerName: string): void;
+    clearTarget(): void;
+    hasTarget(): boolean;
+    stopSpectating(): boolean;
+    remove(): boolean;
+    forceUpdate(): void;
+    createFakeEntity(): void;
+    toString(): string;
+}
+export declare class Animation {
+    constructor();
+    static create(): CameraAnimationBuilder;
+    static createSet(): AnimationSetBuilder;
+    static createTargetAnimation(x: number, y: number, z: number): TargetAnimationBuilder;
+    static createEntityTargetAnimation(playerName: string): EntityTargetAnimationBuilder | null;
+    startFollowing(cameraId: string, playerName: string, xOffset: number, yOffset: number, zOffset: number): boolean;
+    stopFollowing(cameraId: string): boolean;
+    isFollowing(cameraId: string): boolean;
+    stopAllFollowing(): void;
+    getPath(): PathAPI;
+    getCurve(): CurveAPI;
+    stopAllAnimations(): void;
+}
+export declare class ChatGUI {
+    constructor();
+    onInput(callback: (playerName: string, message: string, guiId: string) => void): void;
+    setId(guiId: string): void;
+    getId(): string;
+    setBlocking(blocking: boolean): void;
+    isBlocking(): boolean;
+    addLine(content: string | ((line: ChatGUILine) => void) | ChatGUILine): void;
+    addEmptyLine(): void;
+    createLine(): ChatGUILine;
+    setLine(index: number, callback: (line: ChatGUILine) => void): void;
+    updateLine(lineIndex: number, callback: (line: ChatGUILine) => void): void;
+    removeLine(index: number): void;
+    clear(): void;
+    size(): number;
+    ensureSize(minSize: number): void;
+    addLineAt(index: number, content: ((line: ChatGUILine) => void) | ChatGUILine): void;
+    setGlobalBackground(color: string): void;
+    removeGlobalBackground(): void;
+    open(playerName: string): void;
+    close(playerName?: string): void;
+    rerender(): void;
+    rerenderForPlayer(playerName: string): void;
+}
+export declare class ChatSession {
+    constructor(sessionId: string, callback: (playerName: string, message: string, sessionId: string) => void);
+    getSessionId(): string;
+    getViewerCount(): number;
+    getPlayerCount(): number;
+    hasPlayer(playerName: string): boolean;
+    addPlayer(playerName: string): void;
+    removePlayer(playerName: string): void;
+    sendMessage(message: string): void;
+    sendMessageToPlayer(playerName: string, message: string): void;
+    close(): void;
+    setClusterMode(clusterMode: boolean): void;
+    isClusterMode(): boolean;
+    clearPlayerChat(playerName: string): void;
+    static isPlayerInSession(playerName: string): boolean;
+}
+export declare class Storage {
+    constructor(namespace?: string);
+    set(key: string, value: unknown): void;
+    get<T = unknown>(key: string): T | undefined;
+    remove(key: string): boolean;
+    has(key: string): boolean;
+    keys(): string[];
+    clear(): number;
+    size(): number;
+}
+export declare class Screen {
+    constructor(sizeOrTexture: number | string, sizeOrOptions?: number | ScreenOptions, options?: ScreenOptions);
+    createContainer(config: ContainerConfig): Container;
+    add(component: GuiComponentType): this;
+    addButton(slot: number, texture: string, title: string | null, onClick?: (event: ElementClickEvent) => void): Element;
+    removeButton(slot: number): void;
+    getButton(slot: number): Element | null;
+    appendText(text: string, size: number, y: number, centered: boolean): GuiText;
+    clearText(): void;
+    setBackgroundColor(hex: string): void;
+    putBackground(slot: number): BackgroundSlot;
+    open(player: ScriptablePlayer | string): void;
+    close(): void;
+    refresh(): void;
+    setTexture(texture: string | null): void;
+    getTexture(): string | null;
+    getSize(): number;
+    getId(): string;
+    getPersistenceKey(): string | null;
+    isPersistent(): boolean;
+    getViewerCount(): number;
+    getTotalSlots(): number;
+    isPlayerInventorySlot(screenSlot: number): boolean;
+    toPlayerInventorySlot(screenSlot: number): number;
+    fromPlayerInventorySlot(playerSlot: number): number;
+    isUsingPlayerInventorySlots(): boolean;
+    setUsePlayerInventorySlots(enabled: boolean): void;
+    getCellState(slot: number): CellState;
+    save(): void;
+    load(): void;
+    destroy(): void;
+    onEvent(eventName: "open" | "close", callback: (player: ScriptablePlayer) => void): this;
+    on(eventName: string, callback: (...args: unknown[]) => void): void;
+}
+export declare class Container {
+    constructor(config: ContainerConfig);
+    addChild(child: Element | Container): this;
+    addChildAt(index: number, child: Element | Container): this;
+    removeChildAt(index: number): this;
+    getChildAt(index: number): Element | Container | null;
+    getChildCount(): number;
+    clear(): this;
+    addButton(texture: string, title: string | null, onClick?: (event: ElementClickEvent) => void): Element;
+    addButtonAt(index: number, texture: string, title: string | null, onClick?: (event: ElementClickEvent) => void): Element;
+    addContentSlot(): Element;
+    addContentSlotAt(index: number): Element;
+    addContainer(config: ContainerConfig): Container;
+    addContainerAt(index: number, config: ContainerConfig): Container;
+    add(element: Element | Container): this;
+    addAt(index: number, element: Element | Container): this;
+    pushButton(texture: string, title: string | null, onClick?: (event: ElementClickEvent) => void): Element;
+    putButton(index: number, texture: string, title: string | null, onClick?: (event: ElementClickEvent) => void): Element;
+    pushContentSlot(): Element;
+    putContentSlot(index: number): Element;
+    pushContainer(config: ContainerConfig): Container;
+    putContainer(index: number, config: ContainerConfig): Container;
+    setBackgroundColor(hex: string): void;
+    putBackground(localIndex: number): BackgroundSlot;
+    setLayout(layout: "grid" | "flex"): this;
+    setDirection(direction: "row" | "column"): this;
+    setGap(gap: number): this;
+    setStartSlot(slot: number): this;
+    setRows(rows: number): this;
+    setCols(cols: number): this;
+    getLayout(): "grid" | "flex";
+    getDirection(): "row" | "column";
+    getGap(): number;
+    getStartSlot(): number;
+    getRows(): number;
+    getCols(): number;
+    getSlotCount(): number;
+    getElementCount(): number;
+    getElementAt(index: number): Element | Container | null;
+    getElement(index: number): Element | Container | null;
+    getIndex(): number;
+    setId(id: string): this;
+    getId(): string | null;
+    setPersist(persist: boolean): this;
+    isPersist(): boolean;
+    setPersistScroll(persistScroll: boolean): this;
+    isPersistScroll(): boolean;
+    setScrollable(scrollable: boolean): this;
+    isScrollable(): boolean;
+    setMaxCapacity(max: number): this;
+    getMaxCapacity(): number;
+    isFull(): boolean;
+    getRemainingCapacity(): number;
+    scroll(offset: number): void;
+    scrollPage(direction: 1 | -1): void;
+    scrollTo(virtualIndex: number): void;
+    scrollToPage(page: number): void;
+    getPageSize(): number;
+    getPageCount(): number;
+    getCurrentPage(): number;
+    getScrollOffset(): number;
+    getVirtualSize(): number;
+    hasNextPage(): boolean;
+    hasPreviousPage(): boolean;
+    toAbsoluteSlot(relativeSlot: number): number;
+    toRelativeSlot(absoluteSlot: number): number;
+    virtualIndexToSlot(virtualIndex: number): number;
+    slotToVirtualIndex(slot: number): number;
+    getCellState(slot: number): CellState;
+    on(eventName: string, callback: (...args: unknown[]) => void): void;
+}