custom extracts fully implemented 😎 #54

GrooveypenguinX · 2024-08-23T22:04:17Z

Server:

added InstanceManager.ts : an easy way to get an instance of any sort of SPT import needed (OPTIONAL: if you choose not to implement this, just change the new files I added to dependency injection in the constructor and move the router-hooks to register in the mod.ts)
added router-hooks.ts : sets custom routes for the client and server to communicate back and forth. Included is the new route for custom extracts, PathToTarkov/CustomExtracts
added custom-extracts.ts : runs all the server logic to get the custom extract .jsons, process their data, and send it to the server/client where it can be used
changed path-to-tarkov-controller.ts : simply merged the customextracts with the location.exits at the end of the updateLocationBaseExits method
changed mod.ts : registered the instanceManager in preSptLoad and postDbLoad

Client:

cleaned up the entire project, organized into Core, Patches, and Utils
added WebRequestUtils.cs : sets up communication between server and client via routes
added CustomExtractHandler.cs : handles all logic of getting the customextracts from the server and adding them to the available extracts for the client
changed InitAllExfiltrations patch : merges the pmcExfilList with our customextracts

guillaumearm

Here is a first static review of the code, I don't have tested yet.

Tomorrow I'll test it on my current fika modpack.

guillaumearm · 2024-08-24T00:00:38Z

src/all-exfils.ts

  const exfils = ALL_EXFILS[mapName] ?? [];
+  const customExfils = NEW_CUSTOM_EXFILS[mapName] ?? [];
+  exfils.push(...customExfils);


Suggested change

const exfils = ALL_EXFILS[mapName] ?? [];

const customExfils = NEW_CUSTOM_EXFILS[mapName] ?? [];

exfils.push(...customExfils);

const vanillaExfils = ALL_EXFILS[mapName] ?? [];

const customExfils = NEW_CUSTOM_EXFILS[mapName] ?? [];

const exfils = {

...vanillaExfils,

...customExfils,

};

everytime isValidExfilForMap is called, this will mutate ALL_EXFILS and add several time the same custom exfils.

mutations is the devil.

guillaumearm · 2024-08-24T00:02:35Z

src/custom-extracts.ts

+    public getJsonFiles(directory: string): string[] {
+        try {
+            return fs.readdirSync(path.resolve(__dirname, directory))
+                .filter(file => file.endsWith(".json"));
+        } catch (err) {
+            console.error(`Error reading directory ${directory}:`, err);
+            return [];
+        }
+    }
+
+    public loadConfigs(files: string[], directory: string): CustomExitConfig[] {
+        const configs: CustomExitConfig[] = [];
+
+        for (const file of files) {
+            try {
+                const filePath = path.resolve(__dirname, directory, file);
+                const rawData = fs.readFileSync(filePath, "utf8");
+                configs.push(...JSON.parse(rawData));
+            } catch (err) {
+                console.error(`Error reading file ${file}:`, err);
+            }
+        }
+
+        return configs;
+    }


I think reading json files should be done only once outside of this class. (the readed custom extracts can be just passed into the CustomExtracts constructor)

guillaumearm · 2024-08-24T00:05:09Z

src/mod.ts

+    if (!this.config.enabled) {
+      return;
+    }
+


This would break the current uninstall procedure.

This check is already done few lines later.

guillaumearm · 2024-08-24T00:08:07Z

src/mod.ts

@@ -139,6 +143,12 @@ class PathToTarkov implements IPreSptLoadMod, IPostSptLoadMod {

  public postSptLoad(container: DependencyContainer): void {
    this.container = container;
+    this.instanceManager.postDBLoad(container);


Is this line should be moved into a real postDBLoad ? because we are in the postSptLoad here.

guillaumearm · 2024-08-24T00:12:18Z

configs/Default/Tooltips.json

TODO: add a new configs/ExampleCustomExtracts/Tooltips.json

guillaumearm · 2024-08-24T00:12:25Z

configs/Default/config.json

TODO: add a new configs/ExampleCustomExtracts/config.json

guillaumearm · 2024-08-24T00:12:51Z

configs/Default/customExtracts/exfilConfig.json

TODO: add a new configs/ExampleCustomExtracts/customExtracts/exfilConfig.json

guillaumearm · 2024-08-24T00:13:12Z

configs/Default/player_spawnpoints.json

TODO: add a new configs/ExampleCustomExtracts/player_spawnpoints.json

guillaumearm · 2024-08-24T00:16:53Z

src/all-exfils.ts

@@ -137,7 +137,28 @@ const ALL_DUMPED_EXFILS_FROM_SCRIPT = {
    'Nakatani_stairs_free_exit',
  ],
 };
-
+const ALL_NEW_CUSTOM_EXFILS = {


Maybe we can introduce a new config field enable_custom_exfils that will bypass the validation of the exfils name.

For a first iteration it seems enough.

custom extracts fully implemented 😎

bcc61cf

guillaumearm assigned guillaumearm and GrooveypenguinX Aug 23, 2024

guillaumearm added feature New feature config When related to the PTT config labels Aug 23, 2024

guillaumearm requested changes Aug 24, 2024

View reviewed changes

guillaumearm changed the base branch from master to next August 24, 2024 08:41

Trap added 7 commits August 24, 2024 10:43

Merge remote-tracking branch 'origin/next' into custom-extracts

c88cb1a

style: apply prettier

2df6a10

style: fix lint errors

eff189f

fix: remove old ptt patch

bbda45a

fix: router-service was broken when built into js

72f765d

Merge remote-tracking branch 'origin/next' into custom-extracts

3e68c55

Merge branch 'next' into custom-extracts

8f22bab

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

custom extracts fully implemented 😎 #54

custom extracts fully implemented 😎 #54

GrooveypenguinX commented Aug 23, 2024

guillaumearm left a comment

guillaumearm Aug 24, 2024

guillaumearm Aug 24, 2024

guillaumearm Aug 24, 2024

guillaumearm Aug 24, 2024

guillaumearm Aug 24, 2024

guillaumearm Aug 24, 2024

guillaumearm Aug 24, 2024

guillaumearm Aug 24, 2024

guillaumearm Aug 24, 2024

custom extracts fully implemented 😎 #54

Are you sure you want to change the base?

custom extracts fully implemented 😎 #54

Conversation

GrooveypenguinX commented Aug 23, 2024

guillaumearm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment