docs: update the outdate doc

Author: ci010

CONTRIBUTE.md

@@ -13,12 +13,18 @@ After you cloned the project, you can just install it like normal node project b
 
 The code are splited into seperated projects, which layed in under `packages` folder. Most of them are really simple (only one `index.ts` file or few files).
 
-If you want to write some code for specific module, the command `npm run dev` might help you.
+The simplest way to run the code is write a test and then run it.
 
-For example, you want to add a functions to parse minecraft chunk data, you can add some code in `packages/world/index.ts`. You might also want to add some test related to your new features, just add sth. in `packages/world/test.ts`. 
+And, the simplest way to run a test is `npx jest packages/<the-package>/<the-test-file.test.ts>`.
+
+Also you can use the command `npm run dev`.
+
+For example, you want to add a functions to parse minecraft chunk data, you can add some code in `packages/world/index.ts`. You might also want to add some test related to your new features, just add somthing in `packages/world/test.ts`. 
 
 During this process, you can first run `npm run dev world`, and it will start to auto compile & test the code for world module. You can see the result immediately.
 
+**Please make sure you clean all built js files before you run your test! The test will fail if there are built js file! You can run `npm run build:clean` to clean all js!** 
+
 **Highly recommended to add test for the features,** ~~which I always lazy to add.~~
 
 ### Before Submit PR
@@ -49,15 +55,15 @@ The features like login, fetch user info/textures goes here:
 
 - @xmcl/user
 
-In node, it will use `got` as requester.
+In node, it will use nodejs http/https module as requester.
 In browser, it will use `fetch` as requester.
 
 ### General Gaming Features (Node/Electron/Browser)
 
 The features like parsing game setting, parsing forge mod metadata, NBT parsing, game saves parsing, they don't really have any strong connection.
 
 - @xmcl/nbt
-- @xmcl/forge
+- @xmcl/mod-parser
 - @xmcl/gamesetting
 - @xmcl/text-component
 - @xmcl/system

packages/gamesetting/README.md

@@ -8,7 +8,7 @@
 
 Provide function to parse Minecraft game settings
 
-### Usage 
+## Usage 
 
 ### Parse GameSetting (options.txt)
 

packages/installer/diagnose.ts

@@ -27,18 +27,21 @@ export interface Issue {
      */
     hint: string;
     /**
-     * The expected checksum of the file
+     * The expected checksum of the file. Can be an empty string if this file is missing or not check checksum at all!
      */
     expectedChecksum: string;
     /**
-     * The actual checksum of the file
+     * The actual checksum of the file. Can be an empty string if this file is missing or not check checksum at all!
      */
     receivedChecksum: string;
 }
 
 export type MinecraftIssues = LibraryIssue | MinecraftJarIssue | VersionJsonIssue | AssetIssue | AssetIndexIssue;
 export type InstallIssues = ProcessorIssue | LibraryIssue;
 
+/**
+ * The processor issue
+ */
 export interface ProcessorIssue extends Issue {
     role: "processor";
 
@@ -48,6 +51,10 @@ export interface ProcessorIssue extends Issue {
     processor: Processor;
 }
 
+/**
+ * The library issue represents a corrupted or missing lib.
+ * You can use `Installer.installResolvedLibraries` to fix this.
+ */
 export interface LibraryIssue extends Issue {
     role: "library";
 
@@ -56,6 +63,10 @@ export interface LibraryIssue extends Issue {
      */
     library: ResolvedLibrary;
 }
+/**
+ * The minecraft jar issue represents a corrupted or missing minecraft jar.
+ * You can use `Installer.installVersion` to fix this.
+ */
 export interface MinecraftJarIssue extends Issue {
     role: "minecraftJar";
 
@@ -64,6 +75,15 @@ export interface MinecraftJarIssue extends Issue {
      */
     version: string;
 }
+/**
+ * The minecraft jar issue represents a corrupted or missing version jar.
+ *
+ * This means your version is totally broken, and you should reinstall this version.
+ *
+ * - If this is just a Minecraft version, you will need to use `Installer.install` to re-install Minecraft.
+ * - If this is a Forge version, you will need to use `ForgeInstaller.install` to re-install.
+ * - Others are the same, just re-install
+ */
 export interface VersionJsonIssue extends Issue {
     role: "versionJson";
 
@@ -72,6 +92,10 @@ export interface VersionJsonIssue extends Issue {
      */
     version: string;
 }
+/**
+ * The asset issue represents a corrupted or missing minecraft asset file.
+ * You can use `Installer.installResolvedAssets` to fix this.
+ */
 export interface AssetIssue extends Issue {
     role: "asset";
 
@@ -80,6 +104,10 @@ export interface AssetIssue extends Issue {
      */
     asset: { name: string; hash: string; size: number; };
 }
+/**
+ * The asset index issue represents a corrupted or missing minecraft asset index file.
+ * You can use `Installer.installAssets` to fix this.
+ */
 export interface AssetIndexIssue extends Issue {
     role: "assetIndex";
 

packages/resource-manager/README.md

@@ -10,46 +10,27 @@
 
 ### Load Minecraft Resource
 
+*Notice that these API are not stable. May changed in future*
+
 You can use this module in nodejs/electron:
 
 ```ts
+import { ResourcePack, Resource } from "@xmcl/resourcepack"; 
 import { ResourceManager, ResourceLocation } from "@xmcl/resource-manager"
-const manager: ResourceManager<Buffer> = new ResourceManager();
+const manager: ResourceManager = new ResourceManager();
 
 // add a resource source which load resource from file
-await manager.addResourceSource(new MyFileSystemResourceSource('/base/path'));
+await manager.addResourcePack(new ResourcePack(await System.openFileSystem('/base/path')));
 
 // load grass block model resource; it will load file at `assets/${location.domain}/${location.path}`
 // which is '/base/path/assets/minecraft/models/block/grass.json'
 // same logic with minecraft
 const resource = await manager.load(ResourceLocation.ofModelPath('block/grass'));
 
-const url: string = resource.url; // your resource url which is file:///base/path/assets/minecraft/models/block/grass.json
 const content: Buffer = resource.content; // your resource content
 const modelJSON = JSON.parse(content.toString());
 ```
 
-You can also use this module in browser:
-
-```ts
-import { ResourceManager, ResourceLocation } from "@xmcl/resource-manager"
-const manager: ResourceManager<string> = new ResourceManager();
-
-// add a resource source which load resource from an remote url
-await manager.addResourceSource(new MyRemoteWhateverResourceSource('https://my-domain/xxx'));
-
-// load grass block model resource; it will load file at `assets/${location.domain}/${location.path}`
-// which is 'https://my-domain/xxx/assets/minecraft/models/block/grass.json'
-// same logic with minecraft
-const resource = await manager.load(ResourceLocation.ofModelPath('block/grass'));
-
-const url: string = resource.url; // your resource url which is https://my-domain/xxx/assets/minecraft/models/block/grass.json
-const content: string = resource.content; // your resource content string
-const modelJSON = JSON.parse(content);
-```
-
-Please notice that in the sample above, all the `ResourceSource` should be implemented by yourself.
-
 The resource manager will do the simplest cache for same resource location.
 
 You can clear the cache by:
@@ -60,24 +41,26 @@ manager.clearCache();
 
 ### Load Minecraft Block Model
 
-You can use this to load Minecraft block model and texture.
+You can use this to load Minecraft block model and texture just like Minecraft.
 
 ```ts
-    import { ResourceManager, ModelLoader, TextureRegistry, ModelRegistry } from "@xmcl/resource-manager";
-    import { BlockModel } from "@xmcl/system";
+    import { ResourcePack, Resource, BlockModel } from "@xmcl/resourcepack"; 
+    import { ResourceManager, ModelLoader } from "@xmcl/resource-manager";
+    import { System } from "@xmcl/system";
 
     const man = new ResourceManager();
-    // setup resource manager
-    man.addResourceSource(new YourCustomizedResourceSource());
+    const resourcePack = new ResourcePack(await System.openFileSystem("/path/to/resource-pack.zip"));
+    // setup resource pack
+    man.addResourcePack(resourcePack);
 
     const loader = new ModelLoader(man);
 
     await loader.loadModel("block/grass"); // load grass model
     await loader.loadModel("block/stone"); // load stone model
     // ... load whatever you want model
 
-    const textures: TextureRegistry = loader.textures;
-    const models: ModelRegistry = loader.models;
+    const textures: Record<string, Resource> = loader.textures;
+    const models: Record<string, BlockModel.Resolved> = loader.models;
 
     const resolvedModel: BlockModel.Resolved = models["block/grass"];
 ```

packages/resource-manager/index.ts

@@ -7,8 +7,7 @@ interface ResourceSourceWrapper {
 }
 
 /**
- * The resource manager. Design to be able to use in both nodejs and browser environment.
- * @template T The type of the resource content. If you use this in node, it's probably `Buffer`. If you are in browser, it might be `string`. Just align this with your `ResourceSource`
+ * The resource manager just like Minecraft. Design to be able to use in both nodejs and browser environment.
  */
 export class ResourceManager {
     get allResourcePacks() { return this.list.map((l) => l.info); }