refactor: explain bricklib modules

src/bricklib/command.ts

@@ -1,3 +1,7 @@
+/**
+ * A custom command registry manager.
+ */
+
 import { Player, world } from '@minecraft/server';
 
 

src/bricklib/config.ts

@@ -1,3 +1,7 @@
+/**
+ * Bricklib configuration.
+ */
+
 export default {
 
   /**
@@ -14,4 +18,5 @@ export default {
    * Number of Minecraft commands to execute from the command queue, each tick.
    */
   commandBuffer:             128,
-};
+
+} as const;

src/bricklib/database.ts

@@ -1,3 +1,7 @@
+/**
+ * Persistent storage for Minecraft.
+ */
+
 import { Entity, ItemStack, Player, world } from '@minecraft/server';
 import * as utils from './utils.js';
 
@@ -15,7 +19,7 @@ export const DEFAULT_ID = 'default';
 /**
  * The max size of a database.
  */
-export const MAX_SIZE = 32768;
+export const MAX_SIZE = 32767;
 
 /**
  * Defines a dynamic property source.

src/bricklib/events.ts

@@ -1,3 +1,6 @@
+/**
+ * An event manager.
+ */
 
 /**
  * An event listener callback function.

src/bricklib/forms.ts

@@ -1,5 +1,5 @@
 /**
- * server forms
+ * Server forms UI wrapper.
  */
 
 import { Player } from '@minecraft/server';

src/bricklib/index.ts

@@ -1,3 +1,8 @@
+/**
+ * Bricklib -- A wrapper library built on top of Minecraft:
+ * Bedrock Edition's scripting API.
+ */
+
 import { system } from '@minecraft/server';
 
 /**

src/bricklib/locale.ts

@@ -1,3 +1,7 @@
+/**
+ * Localisation helpers.
+ */
+
 import * as utils from './utils.js';
 
 

src/bricklib/rawtext.ts

@@ -1,3 +1,7 @@
+/**
+ * A RawText builder for Minecraft Bedrock.
+ */
+
 /**
  * @class
  * A Minecraft rawtext builder.

src/bricklib/server.ts

@@ -1,3 +1,7 @@
+/**
+ * Server utilities.
+ */
+
 import {
   world,
   system,

src/bricklib/thread.ts

@@ -1,3 +1,7 @@
+/**
+ * Manage concurrent tasks.
+ */
+
 import { system } from '@minecraft/server';
 import config from './config.js';
 import * as utils from './utils.js';

src/bricklib/ticks.ts

@@ -1,3 +1,7 @@
+/**
+ * Tick timing utilities.
+ */
+
 import { system } from '@minecraft/server';
 import * as utils from './utils.js';
 

src/bricklib/utils.ts

@@ -1,5 +1,5 @@
 /**
- * Utility functions
+ * General utility functions.
  */
 
 /**