Resource packs working!

README.md

@@ -26,7 +26,7 @@ You don't need to remember commands syntax anymore.
 This autocompletion works for all resources: commands, predicates, loot tables, advancements...
 
 ## 📂 Better organisation of resources
-You can have multiple functions, advancements, loot tables per files - or you can keep the vanilla organisation, and have only 1 per file. Sandstone allows you to organise your data pack as you prefer, without sticking to Mojang's conventions.
+You can have multiple functions, advancements, loot tables per files - or you can keep the vanilla organisation, and have only 1 per file. Sandstone allows you to organise your datapack as you prefer, without sticking to Mojang's conventions.
 
 You also benefit from all the capabilities of a real programming language: multiline comments, indentation, documentation...
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "sandstone",
   "description": "Sandstone, a Typescript library for Minecraft datapacks.",
-  "version": "0.14.0-alpha.19",
+  "version": "0.14.0-alpha.20",
   "contributors": [
     {
       "name": "TheMrZZ - Florian ERNST",
@@ -17,9 +17,12 @@
     "url": "https://github.com/sandstone-mc/sandstone/issues"
   },
   "dependencies": {
+    "@sinclair/typebox": "^0.25.24",
+    "@smithed-mc/data-types": "^0.1.2",
     "@types/adm-zip": "^0.5.0",
     "@types/fs-extra": "^11.0.1",
     "@types/lodash": "^4.14.191",
+    "@types/semver": "^7.3.13",
     "@typescript/analyze-trace": "^0.4.0",
     "adm-zip": "^0.5.10",
     "chalk": "^4",

src/arguments/resources/datapack/criteria/ItemCriterion.ts

@@ -26,6 +26,6 @@ export type ItemCriterion = Partial<{
   /** A brewed potion ID. */
   potion: string
 
-  /** An item data pack tag. */
+  /** An item datapack tag. */
   tag: string | TagClass<'items'>
 }>

src/arguments/resources/datapack/recipe.ts

@@ -71,7 +71,7 @@ type RecipeKind<NAME extends string, VALUES extends Record<string, unknown> | un
    * - `crafting_shape`: Represents a shaped crafting recipe in a crafting table.
    * - `crafting_shapeless`: Represents a shapeless crafting recipe in a crafting table.
    * - `crafting_special_*`: Represents a crafting recipe in a crafting table that is handled with builtin logic instead of being data-driven.
-   *    When the "vanilla" data pack is disabled, they can be used to reenable desired builtin crafting recipes.
+   *    When the "vanilla" datapack is disabled, they can be used to reenable desired builtin crafting recipes.
    * - `smelting`: Represents a recipe in a furnace.
    * - `smithing`: Represents a recipe in a smithing table.
    * - `smoking`: Represents a recipe in a smoker.

src/arguments/resources/datapack/structure.ts

@@ -1,5 +1,5 @@
 import type { LiteralUnion } from 'sandstone/utils'
-import type { BLOCKS, RootNBT } from '../index'
+import type { BLOCKS, RootNBT } from '../../index'
 
 type Vec3 = [number, number, number]
 

src/arguments/resources/datapack/trimMaterial.ts

@@ -1,6 +1,6 @@
-import type { LiteralUnion } from 'sandstone/utils'
-import type { JSONTextComponent } from '../jsonTextComponent'
-import type { ITEMS } from '#arguments/generated'
+import type { ITEMS } from '../../generated'
+import type { JSONTextComponent } from '../../jsonTextComponent'
+import type { LiteralUnion } from '#utils'
 
 /** Key is armor material, value is a string which will be used in the resource pack. */
 export type OverrideArmorMaterials = Record<LiteralUnion<'leather' | 'chainmail' | 'iron' | 'gold' | 'diamond' | 'turtle' | 'netherite'>, string>

src/arguments/resources/datapack/trimPattern.ts

@@ -1,6 +1,6 @@
-import type { LiteralUnion } from 'sandstone/utils'
-import type { JSONTextComponent } from '../jsonTextComponent'
-import type { ITEMS } from '#arguments/generated'
+import type { ITEMS } from '../../generated'
+import type { JSONTextComponent } from '../../jsonTextComponent'
+import type { LiteralUnion } from '#utils'
 
 export type TrimPatternJSON = {
   /** A resource location (In the resource pack) of the pattern that will be used as an overlay on the armor. */

src/commands/implementations/server/datapack.ts

@@ -40,14 +40,14 @@ export class DataPackCommand extends CommandArguments {
   /**
    * Disable the specified pack.
    *
-   * @param name Specifies the name of the data pack.
+   * @param name Specifies the name of the datapack.
    */
   disable = (name: string) => this.finalCommand([name])
 
   /**
    * Enable the specified pack.
    *
-   * @param name Specifies the name of the data pack.
+   * @param name Specifies the name of the datapack.
    *
    * @example
    *
@@ -61,9 +61,9 @@ export class DataPackCommand extends CommandArguments {
   enable = (name: string) => this.subCommand(['enable', name], DataPackEnableCommand, false)
 
   /**
-   * List all data packs, or list only the available/enabled ones.
+   * List all datapacks, or list only the available/enabled ones.
    *
-   * Hovering over the data packs in the chat output shows their description defined in their pack.mcmeta.
+   * Hovering over the datapacks in the chat output shows their description defined in their pack.mcmeta.
    *
    * @param typ `"available"` to only show available datapacks, `"enabled"` to only show enabled ones.
    */

src/commands/implementations/server/reload.ts

@@ -10,9 +10,9 @@ export class ReloadCommand extends CommandArguments {
   protected NodeType = ReloadCommandNode
 
   /**
-   * Reloads the current data packs.
+   * Reloads the current datapacks.
    *
-   * If a data pack has invalid data (such as an invalid recipe format),
+   * If a datapack has invalid data (such as an invalid recipe format),
    * changes are not applied and the game continues using the previous data.
    */
   reload = () => this.finalCommand([])

src/core/mcmeta.ts

@@ -11,11 +11,11 @@ const fetch = import('node-fetch')
 export type MCMetaBranches = 'assets' | 'atlas' | 'data' | 'registries' | 'summary'
 
 export class MCMetaCache {
-  readonly baseURL = 'https://raw.githubusercontent.com/misode/mcmeta/'
+  readonly base = '/misode/mcmeta/'
 
   readonly path = path.join(process.env.WORKING_DIR as string, 'resources', 'cache', 'mcmeta')
 
-  readonly manifest = path.join(this.path, '..', 'mcmeta.json')
+  readonly manifest = path.join(this.path, '..', '..', 'mcmeta.json')
 
   readonly lockFile = path.join(this.path, '..', 'lock-mcmeta.json')
 
@@ -32,7 +32,7 @@ export class MCMetaCache {
   async load() {
     this.loaded = true
 
-    if (await fs.pathExists(this.manifest)) {
+    if (!(await fs.pathExists(this.manifest))) {
       return
     }
 
@@ -42,7 +42,7 @@ export class MCMetaCache {
 
     this.version = manifest.version
 
-    const getZip = async (branch: string) => new AdmZip(await (await (await fetch).default(`https://github.com/misode/mcmeta/archive/refs/heads/${branch}.zip`)).buffer())
+    const getZip = async (branch: string) => new AdmZip(await (await (await fetch).default(`https://github.com${this.base}archive/refs/heads/${branch}.zip`)).buffer())
 
     if (!(await fs.pathExists(this.lockFile))) {
       if (manifest.files.length > 10) {
@@ -172,10 +172,18 @@ export class MCMetaCache {
   }
 
   async save() {
-    await fs.writeFile(this.manifest, JSON.stringify({
-      branches: this.branches,
-      files: iterateEntries(this.files, (val) => val.text),
-    }))
+    if (this.files.size !== 0) {
+      await fs.writeFile(this.manifest, JSON.stringify({
+        branches: this.branches,
+        files: iterateEntries(this.files, (val) => val.text),
+      }))
+
+      await fs.writeFile(this.lockFile, JSON.stringify({
+        files: this.files,
+        version: this.version,
+        versionDate: this.versionDate,
+      }))
+    }
   }
 
   async get(branch: MCMetaBranches, relativePath: string): Promise<string>
@@ -200,7 +208,7 @@ export class MCMetaCache {
       return existing
     }
 
-    const req = await (await fetch).default(`${this.baseURL}/${branch}/${relativePath}`)
+    const req = await (await fetch).default(`https://raw.githubusercontent.com${this.base}${branch}/${relativePath}`)
 
     const file = await (text ? req.text() : req.buffer())
 
@@ -210,7 +218,7 @@ export class MCMetaCache {
   }
 
   async getVersion(lockFile?: any) {
-    const fetchVersion = async () => JSON.parse(await (await (await fetch).default('https://api.github.com/repos/misode/mcmeta/commits?sha=summary')).text()).sha as string
+    const fetchVersion = async () => JSON.parse(await (await (await fetch).default(`https://api.github.com/repos${this.base}commits?sha=summary`)).text()).sha as string
 
     const currentDate = Date()
 

src/core/resources/custom.ts

@@ -47,7 +47,7 @@ export abstract class CustomResourceClass extends ResourceClass<CustomResourceNo
 
     super(
       sandstoneCore,
-      { packType: args.packType || sandstoneCore.pack.dataPack, extension: args.extension || 'json', encoding: args.encoding },
+      { packType: args.packType || sandstoneCore.pack.dataPack(), extension: args.extension || 'json', encoding: args.encoding },
       CustomResourceNode,
       // eslint-disable-next-line no-nested-ternary
       args.folder ? name.includes('/') ? name.split('/') : [name] : sandstoneCore.pack.resourceToPath(name, args.folder),

src/core/resources/datapack/advancement.ts

@@ -28,7 +28,7 @@ export class AdvancementClass<CriteriaNames extends string = string> extends Res
   public advancementJSON: NonNullable<AdvancementClassArguments['advancement']>
 
   constructor(sandstoneCore: SandstoneCore, name: string, args: AdvancementClassArguments<CriteriaNames>) {
-    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack, extension: 'json' }, AdvancementNode, sandstoneCore.pack.resourceToPath(name, ['advancements']), args)
+    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack(), extension: 'json' }, AdvancementNode, sandstoneCore.pack.resourceToPath(name, ['advancements']), args)
 
     this.advancementJSON = args.advancement as AdvancementJSON
 

src/core/resources/datapack/damageType.ts

@@ -41,7 +41,7 @@ export class DamageTypeClass extends ResourceClass<DamageTypeNode> implements Co
   public damageTypeJSON: NonNullable<DamageTypeClassArguments['damageType']>
 
   constructor(sandstoneCore: SandstoneCore, name: string, args: DamageTypeClassArguments) {
-    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack, extension: 'json' }, DamageTypeNode, sandstoneCore.pack.resourceToPath(name, ['trim_materials']), args)
+    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack(), extension: 'json' }, DamageTypeNode, sandstoneCore.pack.resourceToPath(name, ['trim_materials']), args)
 
     this.damageTypeJSON = args.damageType as DamageTypeJSON
 

src/core/resources/datapack/itemModifier.ts

@@ -33,7 +33,7 @@ export class ItemModifierClass extends ResourceClass<ItemModifierNode> implement
   public itemModifierJSON: NonNullable<ItemModifierClassArguments['itemModifier']>
 
   constructor(sandstoneCore: SandstoneCore, name: string, args: ItemModifierClassArguments) {
-    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack, extension: 'json' }, ItemModifierNode, sandstoneCore.pack.resourceToPath(name, ['item_modifiers']), args)
+    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack(), extension: 'json' }, ItemModifierNode, sandstoneCore.pack.resourceToPath(name, ['item_modifiers']), args)
 
     this.itemModifierJSON = args.itemModifier as ItemModifierJSON
 

src/core/resources/datapack/lootTable.ts

@@ -30,7 +30,7 @@ export class LootTableClass extends ResourceClass<LootTableNode> {
   public lootTableJSON: NonNullable<LootTableClassArguments['lootTable']>
 
   constructor(sandstoneCore: SandstoneCore, name: string, args: LootTableClassArguments) {
-    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack, extension: 'json' }, LootTableNode, sandstoneCore.pack.resourceToPath(name, ['loot_tables']), args)
+    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack(), extension: 'json' }, LootTableNode, sandstoneCore.pack.resourceToPath(name, ['loot_tables']), args)
 
     this.lootTableJSON = args.lootTable as LootTableJSON
 

src/core/resources/datapack/mcfunction.ts

@@ -156,12 +156,12 @@ export type MCFunctionClassArguments = ({
    *
    * @example
    *
-   * // Run every 5 ticks, including on data pack load.
+   * // Run every 5 ticks, including on datapack load.
    * {
    *   runEvery: 5,
    * }
    *
-   * // Run every 5 ticks, but wait 5 ticks before data pack loads for 1st execution.
+   * // Run every 5 ticks, but wait 5 ticks before datapack loads for 1st execution.
    * {
    *   runEvery: 5,
    *   runOnLoad: false,
@@ -199,7 +199,7 @@ export class _RawMCFunctionClass extends CallableResourceClass<MCFunctionNode> {
   protected lazy: boolean
 
   constructor(core: SandstoneCore, name: string, args: MCFunctionClassArguments) {
-    super(core, { packType: core.pack.dataPack, extension: 'mcfunction' }, MCFunctionNode, core.pack.resourceToPath(name, ['functions']), {
+    super(core, { packType: core.pack.dataPack(), extension: 'mcfunction' }, MCFunctionNode, core.pack.resourceToPath(name, ['functions']), {
       ...args,
       addToSandstoneCore: args.lazy ? false : args.addToSandstoneCore,
     })

src/core/resources/datapack/predicate.ts

@@ -30,7 +30,7 @@ export class PredicateClass extends ResourceClass<PredicateNode> implements List
   public predicateJSON: NonNullable<PredicateClassArguments['predicate']>
 
   constructor(sandstoneCore: SandstoneCore, name: string, args: PredicateClassArguments) {
-    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack, extension: 'json' }, PredicateNode, sandstoneCore.pack.resourceToPath(name, ['predicates']), args)
+    super(sandstoneCore, { packType: sandstoneCore.pack.dataPack(), extension: 'json' }, PredicateNode, sandstoneCore.pack.resourceToPath(name, ['predicates']), args)
 
     this.predicateJSON = args.predicate as PredicateJSON