Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@
"markedjs",
"mauris",
"mcaddon",
"MCBE",
"mcdirectory",
"mcextract",
"mcfunction",
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
name: Lint
description: Lint and build the project to check for errors.
on:
- pull_request
- push
pull_request:
branches: [develop]
push:
branches: [develop]

jobs:
lint:
Expand Down
5 changes: 5 additions & 0 deletions .vscode/docs.code-snippets
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
{
"Tab": {
"scope": "md,markdown",
"prefix": "tabs",
"body": [":::tabs key:${1}", "", "== ${2}", "", "${0}", ":::"],
},
"PythonInstallation": {
"scope": "md,markdown",
"prefix": "PythonInstallation",
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
},
"peacock.color": "#42b883",
"markdownlint.config": {
"no-inline-html": false
"no-inline-html": false,
"first-line-h1": false
},
"cSpell.words": ["fencegate"]
}
16 changes: 16 additions & 0 deletions docs/.vitepress/sidebar.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import root from "../sidebar.json";
import lpsmodsMcUtils from "../@lpsmods/mc-utils/sidebar.json";
import lpsmodsMcCommon from "../@lpsmods/mc-common/sidebar.json";
import lpsmodsMcDev from "../@lpsmods/mc-dev/sidebar.json";
import lpsmodsMcBridge from "../@lpsmods/mcaddon-bridge/sidebar.json";
import accentcolordetect from "../accentcolordetect/sidebar.json";
import armor_stand_poses from "../armor-stand-poses/sidebar.json";
Expand Down Expand Up @@ -60,6 +62,20 @@ export const sidebar = {
items: ftb_sd,
},
],
"/@lpsmods/mc-common": [
{
text: "@lpsmods/mc-common",
base: "/@lpsmods/mc-common/",
items: lpsmodsMcCommon,
},
],
"/@lpsmods/mc-dev": [
{
text: "@lpsmods/mc-dev",
base: "/@lpsmods/mc-dev/",
items: lpsmodsMcDev,
},
],
"/@lpsmods/mc-utils": [
{
text: "@lpsmods/mc-utils",
Expand Down
43 changes: 43 additions & 0 deletions docs/@lpsmods/mc-common/guide/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Frequently Asked Questions | @lpsmods/mc-common Documentation
description: Frequently asked questions about @lpsmods/mc-common
prev:
text: Getting Started
link: ./getting-started
next: false
---

# Frequently Asked Questions

Below are answers to questions you might have.

## What is `@lpsmods/mc-common`?

`@lpsmods/mc-common` is a package for Minecraft modding utilities, providing:

- Data storage and utils
- UI utils and text utils
- Math utils
- Ticking

## How do I report bugs or request features?

You can submit a bug report or feature request via the [GitHub Repository](https://github.com/lpsmods/mc-common/issues)

## How do I contribute?

See the [CONTRIBUTING.md](https://github.com/lpsmods/mc-common/blob/main/CONTRIBUTING.md) file for more information about contributing.

## How to I use this for my JavaScript project?

You can find the bundled JavaScript file via the [GitHub Releases](https://github.com/lpsmods/mc-common/releases) page.

## Does this work for Minecraft: Java Edition?

No, This package is for the Bedrock scripting API only.

## What versions of the scripting API are supported?

`@lpsmods/mc-common` will always support the latest scripting API version and will not work for older versions.

<!--@include: @/common/marketplace-faq.md -->
23 changes: 23 additions & 0 deletions docs/@lpsmods/mc-common/guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Getting Started | @lpsmods/mc-common Documentation
description: desc
prev: false
next:
text: FAQ
link: ./faq
---

# Getting Started

> [!WARNING]
> This project is still under heavy development. Features may be removed or changed in future releases.

## Installation

<NodeInstallation packageName="@lpsmods/mc-common" />

## Using it in your project

To use `@lpsmods/mc-common` in your project you'll need to bundle and merge it with your packs code. You can do this with [esbuild](https://esbuild.github.io/getting-started/#your-first-bundle)

A bundled build of mc-common can be downloaded from the Releases page on GitHub.
39 changes: 39 additions & 0 deletions docs/@lpsmods/mc-common/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "@lpsmods/mc-common Documentation"
description: Common utilities for @lpsmods packages.
layout: home

hero:
name: "mc-common"
text: Common utilities for @lpsmods packages.
actions:
- theme: brand
text: Getting Started
link: ./guide/getting-started
- theme: alt
text: NPM
link: https://www.npmjs.com/package/@lpsmods/mc-common
- theme: alt
text: Source Code
link: https://github.com/lpsmods/mc-common

features:
- icon: 💾
title: Data Storage
details: Utilities for persisting and retrieving data directly within the Minecraft world.
- icon: 🖥️
title: UI Components
details: Ready to use action forms, modal forms, and progress bars for player interaction.
- icon: 📝
title: Text Utilities
details: Helpers for translations, color codes, and consistent message formatting.
- icon: ⚙️
title: Settings Management
details: Versioned settings storage with safe upgrades and backward compatibility.
- icon: ⏱️
title: Ticking Utilities
details: Schedule repeating tasks, delays, and interval based logic with ease.
- icon: 📐
title: Types and Validation
details: Strong type definitions and validators for common Minecraft objects.
---
11 changes: 11 additions & 0 deletions docs/@lpsmods/mc-common/sidebar.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[
{
"text": "Guide",
"collapsed": false,
"items": [
{ "text": "Getting Started", "link": "/guide/getting-started" },
{ "text": "FAQ", "link": "/guide/faq" }
]
},
{ "text": "Script API", "collapsed": true, "items": [{ "text": "UNDOCUMENTED" }] }
]
38 changes: 38 additions & 0 deletions docs/@lpsmods/mc-dev/guide/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Frequently Asked Questions | @lpsmods/mc-dev Documentation
description: Frequently asked questions about @lpsmods/mc-dev
prev:
text: Getting Started
link: ./getting-started
next: false
---

# Frequently Asked Questions

Below are answers to questions you might have.

## What is `@lpsmods/mc-dev`?

`@lpsmods/mc-dev` is a package providing debug utilities for Minecraft Bedrock Edition Add-On development. It includes tools like a developer UI command, block info display, player info, item info, and configurable debug modes.

## How do I report bugs or request features?

You can submit a bug report or feature request via the [GitHub Repository](https://github.com/lpsmods/mc-dev/issues)

## How do I contribute?

See the [CONTRIBUTING.md](https://github.com/lpsmods/mc-dev/blob/main/CONTRIBUTING.md) file for more information about contributing.

## How to I use this for my JavaScript project?

You can find the bundled JavaScript file via the [GitHub Releases](https://github.com/lpsmods/mc-dev/releases) page.

## Does this work for Minecraft: Java Edition?

No, This package is for the Bedrock scripting API only.

## What versions of the scripting API are supported?

`@lpsmods/mc-dev` will always support the latest scripting API version and will not work for older versions.

<!--@include: @/common/marketplace-faq.md -->
23 changes: 23 additions & 0 deletions docs/@lpsmods/mc-dev/guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Getting Started | @lpsmods/mc-dev Documentation
description: desc
prev: false
next:
text: FAQ
link: ./faq
---

# Getting Started

> [!WARNING]
> This project is still under heavy development. Features may be removed or changed in future releases.

## Installation

<NodeInstallation packageName="@lpsmods/mc-dev" />

## Using it in your project

To use `@lpsmods/mc-dev` in your project you'll need to bundle and merge it with your packs code. You can do this with [esbuild](https://esbuild.github.io/getting-started/#your-first-bundle)

A bundled build of mc-dev can be downloaded from the Releases page on GitHub.
39 changes: 39 additions & 0 deletions docs/@lpsmods/mc-dev/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "@lpsmods/mc-dev Documentation"
description: Debug utilities for MCBE Add-On development.
layout: home

hero:
name: "mc-dev"
text: Debug utilities for MCBE Add-On development.
actions:
- theme: brand
text: Getting Started
link: ./guide/getting-started
- theme: alt
text: NPM
link: https://www.npmjs.com/package/@lpsmods/mc-dev
- theme: alt
text: Source Code
link: https://github.com/lpsmods/mc-dev

features:
- icon: 🧰
title: Developer Tools Command
details: Includes the mcdev:dev show command to open the in game developer tools UI.
- icon: 🧱
title: Block Info Tool
details: Displays detailed block data directly in the action bar.
- icon: 🧍
title: Player Info Tool
details: Shows player location, rotation, and key properties in real time.
- icon: 🪓
title: Item Info Tool
details: Displays information about the currently held item.
- icon: 🐞
title: Debug Mode
details: Optional debug mode for exposing additional development and diagnostic data.
- icon: 🔧
title: Configurable Tools
details: Enable or disable individual tools through a simple settings system.
---
11 changes: 11 additions & 0 deletions docs/@lpsmods/mc-dev/sidebar.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[
{
"text": "Guide",
"collapsed": false,
"items": [
{ "text": "Getting Started", "link": "/guide/getting-started" },
{ "text": "FAQ", "link": "/guide/faq" }
]
},
{ "text": "Script API", "collapsed": true, "items": [{ "text": "UNDOCUMENTED" }] }
]
38 changes: 38 additions & 0 deletions docs/@lpsmods/mc-utils/guide/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Frequently Asked Questions | @lpsmods/mc-utils Documentation
description: Frequently asked questions about @lpsmods/mc-utils
prev:
text: Getting Started
link: ./getting-started
next: false
---

# Frequently Asked Questions

Below are answers to questions you might have.

## What is `@lpsmods/mc-utils`?

`@lpsmods/mc-utils` is a package for Minecraft Bedrock Edition server scripting, providing helper functions and tools to simplify development with the `@minecraft/server` and `@minecraft/server-ui` APIs.

## How do I report bugs or request features?

You can submit a bug report or feature request via the [GitHub Repository](https://github.com/lpsmods/mc-utils/issues)

## How do I contribute?

See the [CONTRIBUTING.md](https://github.com/lpsmods/mc-utils/blob/main/CONTRIBUTING.md) file for more information about contributing.

## How to I use this for my JavaScript project?

You can find the bundled JavaScript file via the [GitHub Releases](https://github.com/lpsmods/mc-utils/releases) page.

## Does this work for Minecraft: Java Edition?

No, This package is for the Bedrock scripting API only.

## What versions of the scripting API are supported?

`@lpsmods/mc-utils` will always support the latest scripting API version and will not work for older versions.

<!--@include: @/common/marketplace-faq.md -->
3 changes: 2 additions & 1 deletion docs/@lpsmods/mc-utils/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
{ "text": "Getting Started", "link": "/guide/getting-started" },
{ "text": "Custom Components", "link": "/guide/custom-components" },
{ "text": "Custom Effect", "link": "/guide/custom-effect" },
{ "text": "Custom Enchantment", "link": "/guide/custom-enchantment" }
{ "text": "Custom Enchantment", "link": "/guide/custom-enchantment" },
{ "text": "FAQ", "link": "/guide/faq" }
]
},
{ "text": "Script API", "collapsed": true, "items": [{ "text": "UNDOCUMENTED" }] },
Expand Down
22 changes: 22 additions & 0 deletions docs/armor-stand-poses/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Frequently Asked Questions | Armor Stand Poses Wiki
description: Frequently asked questions about Armor Stand Poses
prev: false
next: false
---

# Frequently Asked Questions

Below are answers to questions you might have.

## What is `Armor Stand Poses`?

**Armor Stand Poses** is a Minecraft mod, and datapack that adds Bedrock-style arms and pose support to Java Edition armor stands, letting you pose stands in many expressive ways. It provides data-driven custom poses and built-in presets, enhancing decorative and display possibilities for builds.

## What mods does `Armor Stand Poses` support?

**Armor Stand Poses** supports the below mods.

- [Armor Poser](https://www.curseforge.com/minecraft/mc-mods/armor-poser)

<!--@include: @/common/mod-faq.md -->
3 changes: 2 additions & 1 deletion docs/armor-stand-poses/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@
{ "text": "Custom Poses", "link": "/custom-poses" },
{ "text": "Pose Format", "link": "/pose-format" }
]
}
},
{ "text": "FAQ", "link": "/faq" }
]
Loading