Merge pull request #173 from KotRikD/linux-support

feat: add linux support

.github/workflows/deploy.yml

@@ -27,7 +27,7 @@ jobs:
   build:
     strategy:
       matrix:
-        os: [ windows-latest ]
+        os: [ windows-latest, ubuntu-latest ]
 
     runs-on: ${{ matrix.os }}
 
@@ -56,29 +56,34 @@ jobs:
       - name: 🛠️ - Install Deps
         run: npm install -g pnpm@^8 && pnpm install --frozen-lockfile
 
-      - name: 📦 - Build
-        run: pnpm build
+      - name: 📦 - Build (windows)
+        if: ${{ matrix.os == 'windows-latest' }}
+        run: pnpm build:win
+
+      - name: 📦 - Build (linux)
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: pnpm build:linux
 
       - name: 🚀 - Upload artifacts for windows
-        if: matrix.os == 'windows-latest'
+        if: ${{ matrix.os == 'windows-latest' }}
         uses: actions/upload-artifact@v4
         with: {
-          name: "tosu-${{ matrix.os }}-${{ steps.set-pr-sha.outputs.SHORT_PR_SHA || github.ref_name }}",
+          name: "tosu-windows-${{ steps.set-pr-sha.outputs.SHORT_PR_SHA || github.ref_name }}",
           path: packages/tosu/dist/tosu.exe
         }
 
-      # - name: 🚀 - Upload artifacts for linux
-      #   if: matrix.os == 'ubuntu-latest'
-      #   uses: actions/upload-artifact@v3
-      #   with: {
-      #     name: "${{ steps.set-artifact-name.outputs.ARTIFACT_NAME }}",
-      #     path: packages/tosu/dist/tosu.exe
-      #  }
+      - name: 🚀 - Upload artifacts for linux
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        uses: actions/upload-artifact@v4
+        with: {
+          name: "tosu-linux-${{ steps.set-pr-sha.outputs.SHORT_PR_SHA || github.ref_name }}",
+          path: packages/tosu/dist/tosu
+        }
 
       # - name: 🚀 - Upload artifacts for mac
       #   if: matrix.os == 'macos-latest'
       #   uses: actions/upload-artifact@v3
       #   with: {
       #     name: "${{ steps.set-artifact-name.outputs.ARTIFACT_NAME }}",
       #     path: packages/tosu/dist/tosu.exe
-      #   }
+      #   }

development.md

@@ -37,8 +37,15 @@ pnpm run start
 
 
 6. Compile tosu
+
+For Windows:
+```
+pnpm install && pnpm build:win
+```
+
+For Linux
 ```
-pnpm install && pnpm build
+pnpm install && pnpm build:linux
 ```
 
 7. Go to `/tosu/packages/tosu/dist`, and there is your's tosu build

package.json

@@ -6,7 +6,8 @@
   "scripts": {
     "prepare": "husky install",
     "start": "pnpm run -C packages/tosu run:dev",
-    "build": "pnpm run -C packages/tosu compile",
+    "build:win": "pnpm run -C packages/tosu compile:win",
+    "build:linux": "pnpm run -C packages/tosu compile:linux",
     "release": "standard-version",
     "prettier:fix": "prettier --write \"**/*.{js,jsx,ts,tsx,css}\"",
     "prettier:ci": "prettier --check \"**/*.{js,jsx,ts,tsx,css}\"",

packages/tosu/package.json

@@ -9,7 +9,8 @@
         "ts:compile": "ncc build src/index.ts -o dist -m -d",
         "run:dev": "pnpm run genver && pnpm run ts:run src/index.ts",
         "compile:prepare-htmls": "cp -rf node_modules/@tosu/server/assets ./dist",
-        "compile": "pnpm run genver && pnpm run ts:compile && pnpm run compile:prepare-htmls && pkg --output dist/tosu.exe --debug --config pkg.json --compress brotli dist/index.js && pnpm run ts:run src/postBuild.ts"
+        "compile:win": "pnpm run genver && pnpm run ts:compile && pnpm run compile:prepare-htmls && pkg --output dist/tosu.exe --debug --config pkg.win.json --compress brotli dist/index.js && pnpm run ts:run src/postBuild.ts",
+	"compile:linux": "pnpm run genver && pnpm run ts:compile && pnpm run compile:prepare-htmls && pkg --output dist/tosu --debug --config pkg.linux.json --compress brotli dist/index.js"
     },
     "dependencies": {
         "@tosu/common": "workspace:*",

packages/tosu/pkg.json → packages/tosu/pkg.linux.json

@@ -8,7 +8,7 @@
       "dist/assets/**/*"
     ],
     "targets": [
-      "node20-win-x64"
+	"node20-linux-x64"
     ],
     "outputPath": "dist"
-}   
+}

packages/tosu/pkg.win.json

@@ -0,0 +1,14 @@
+{
+    "scripts": "dist/**/*.js",
+    "assets": [
+      "dist/**/*.node",
+      "dist/**/*.wasm",
+      "dist/target/**/*",
+      "dist/_version.js",
+      "dist/assets/**/*"
+    ],
+    "targets": [
+	"node20-win-x64"
+    ],
+    "outputPath": "dist"
+}   

packages/tosu/src/entities/AllTimesData/index.ts

@@ -2,15 +2,7 @@ import { wLogger } from '@tosu/common';
 
 import { AbstractEntity } from '@/entities/AbstractEntity';
 
-// NOTE: NOT AVAILABLE IN TOURNAMENT MODE!!!!
-const GAME_TIME_PTR = {
-    pattern: '8B 35 ?? ?? ?? ?? 8B C6 B9',
-    offset: 0x2
-};
-
 export class AllTimesData extends AbstractEntity {
-    gameTimePtr: number = 0;
-
     IsWatchingReplay: number = 0;
     isReplayUiHidden: boolean = false;
     ShowInterface: boolean = false;
@@ -49,30 +41,33 @@ export class AllTimesData extends AbstractEntity {
             const {
                 statusPtr,
                 menuModsPtr,
-                chatCheckerAddr,
+                chatCheckerPtr,
                 skinDataAddr,
                 settingsClassAddr,
                 canRunSlowlyAddr,
-                rulesetsAddr
+                rulesetsAddr,
+                gameTimePtr
             } = patterns.getPatterns([
                 'statusPtr',
                 'menuModsPtr',
-                'chatCheckerAddr',
+                'chatCheckerPtr',
                 'skinDataAddr',
                 'settingsClassAddr',
                 'canRunSlowlyAddr',
-                'rulesetsAddr'
+                'rulesetsAddr',
+                'gameTimePtr'
             ]);
 
             // [Status - 0x4]
             this.Status = process.readPointer(statusPtr);
             // [MenuMods + 0x9]
             this.MenuMods = process.readPointer(menuModsPtr);
             // ChatChecker - 0x20
-            this.ChatStatus = process.readByte(chatCheckerAddr - 0x20);
+            this.ChatStatus = process.readByte(process.readInt(chatCheckerPtr));
             this.IsWatchingReplay = process.readByte(
                 process.readInt(canRunSlowlyAddr + 0x46)
             );
+            this.GameTime = process.readPointer(gameTimePtr);
             this.MemorySongsFolder = process.readSharpString(
                 process.readInt(
                     process.readInt(
@@ -117,24 +112,6 @@ export class AllTimesData extends AbstractEntity {
                 return;
             }
 
-            if (
-                !this.osuInstance.isTourneyManager &&
-                !this.osuInstance.isTourneySpectator
-            ) {
-                if (this.gameTimePtr === 0) {
-                    this.gameTimePtr = await process.scanAsync(
-                        GAME_TIME_PTR.pattern,
-                        true
-                    );
-                    wLogger.debug('ATD(updateState) gameTimePtr area found');
-                    return;
-                } else {
-                    this.GameTime = process.readPointer(
-                        this.gameTimePtr + GAME_TIME_PTR.offset
-                    );
-                }
-            }
-
             this.resetReportCount('ATD(updateState)');
         } catch (exc) {
             this.reportError(

packages/tosu/src/entities/TourneyManagerData/index.ts

@@ -44,10 +44,7 @@ export class TourneyManagerData extends AbstractEntity {
 
             if (this.ChatAreaAddr === 0) {
                 await sleep(1000);
-                this.ChatAreaAddr = process.scanSync(
-                    TOURNAMENT_CHAT_ENGINE,
-                    true
-                );
+                this.ChatAreaAddr = process.scanSync(TOURNAMENT_CHAT_ENGINE);
                 wLogger.debug('TMD(updateState) Chat area found');
                 return;
             }

packages/tosu/src/objects/instanceManager/osuInstance.ts

@@ -1,4 +1,4 @@
-import { config, sleep, updateProgressBar, wLogger } from '@tosu/common';
+import { config, sleep, wLogger } from '@tosu/common';
 import { injectGameOverlay } from '@tosu/game-overlay';
 import EventEmitter from 'events';
 import fs from 'fs';
@@ -36,8 +36,9 @@ const SCAN_PATTERNS: {
     playTimeAddr: {
         pattern: '5E 5F 5D C3 A1 ?? ?? ?? ?? 89 ?? 04'
     },
-    chatCheckerAddr: {
-        pattern: '0A D7 23 3C 00 00 ?? 01'
+    chatCheckerPtr: {
+        pattern: '83 3D ?? ?? ?? ?? 00 75 ?? 80 3D',
+        offset: 0x2
     },
     skinDataAddr: {
         pattern: '74 2C 85 FF 75 28 A1 ?? ?? ?? ?? 8D 15'
@@ -64,7 +65,7 @@ const SCAN_PATTERNS: {
         offset: -0x4
     },
     menuModsPtr: {
-        pattern: 'C8 FF 00 00 00 00 00 81 0D 00 00 00 00 00 08 00 00',
+        pattern: 'C8 FF ?? ?? ?? ?? ?? 81 0D ?? ?? ?? ?? ?? 08 00 00',
         offset: 0x9
     },
     getAudioLengthPtr: {
@@ -82,6 +83,10 @@ const SCAN_PATTERNS: {
     spectatingUserPtr: {
         pattern: '8B 0D ?? ?? ?? ?? 85 C0 74 05 8B 50 30',
         offset: -0x4
+    },
+    gameTimePtr: {
+        pattern: 'A1 ?? ?? ?? ?? 89 46 04 8B D6 E8',
+        offset: 0x1
     }
 };
 
@@ -143,7 +148,7 @@ export class OsuInstance {
     }
 
     async start() {
-        wLogger.info(`[${this.pid}] Running memory chimera..`);
+        wLogger.info(`[${this.pid}] Running memory chimera...`);
         while (!this.isReady) {
             const patternsRepo = this.entities.get('patterns');
             if (!patternsRepo) {
@@ -153,38 +158,30 @@ export class OsuInstance {
             }
 
             try {
-                const total = Object.keys(SCAN_PATTERNS).length;
-                let completed = 0;
-                for (const baseKey in SCAN_PATTERNS) {
-                    const s1 = performance.now();
-                    const patternValue = this.process.scanSync(
-                        SCAN_PATTERNS[baseKey].pattern,
-                        true
-                    );
-                    completed += 1;
-                    if (patternValue === 0) {
-                        updateProgressBar(
-                            `[${this.pid}] Scanning`,
-                            completed / total,
-                            `${(performance.now() - s1).toFixed(
-                                2
-                            )}ms ${baseKey}`
-                        );
-                        continue;
-                    }
+                const s1 = performance.now();
 
-                    patternsRepo.setPattern(
-                        baseKey as never,
-                        patternValue + (SCAN_PATTERNS[baseKey].offset || 0)
-                    );
+                const results = this.process.scanBatch(
+                    Object.values(SCAN_PATTERNS).map((x) => x.pattern)
+                );
+
+                const indexToKey = Object.keys(SCAN_PATTERNS);
+
+                for (let i = 0; i < results.length; i++) {
+                    const baseKey = indexToKey[
+                        results[i].index
+                    ] as keyof PatternData;
 
-                    updateProgressBar(
-                        `[${this.pid}] Scanning`,
-                        completed / total,
-                        `${(performance.now() - s1).toFixed(2)}ms ${baseKey}`
+                    patternsRepo.setPattern(
+                        baseKey,
+                        results[i].address +
+                            (SCAN_PATTERNS[baseKey].offset || 0)
                     );
                 }
 
+                wLogger.debug(
+                    `[${this.pid}] Took ${(performance.now() - s1).toFixed(2)} ms to scan patterns`
+                );
+
                 if (!patternsRepo.checkIsBasesValid()) {
                     throw new Error('Memory resolve failed');
                 }
@@ -261,7 +258,7 @@ export class OsuInstance {
                 }
 
                 if (!allTimesData.GameFolder) {
-                    allTimesData.setGameFolder(path.join(this.path, '..'));
+                    allTimesData.setGameFolder(this.path);
 
                     // condition when user have different BeatmapDirectory in osu! config
                     if (fs.existsSync(allTimesData.MemorySongsFolder)) {
@@ -270,11 +267,7 @@ export class OsuInstance {
                         );
                     } else {
                         allTimesData.setSongsFolder(
-                            path.join(
-                                this.path,
-                                '../',
-                                allTimesData.MemorySongsFolder
-                            )
+                            path.join(this.path, allTimesData.MemorySongsFolder)
                         );
                     }
                 }

packages/tosu/src/objects/memoryBase.ts

@@ -7,7 +7,7 @@ export interface BaseData {
     baseAddr: number;
     menuModsAddr: number;
     playTimeAddr: number;
-    chatCheckerAddr: number;
+    chatCheckerPtr: number;
     skinDataAddr: number;
     configurationAddr: number;
     bindingsAddr: number;
@@ -31,7 +31,7 @@ export class MemoryBase {
             baseAddr: 0,
             menuModsAddr: 0,
             playTimeAddr: 0,
-            chatCheckerAddr: 0,
+            chatCheckerPtr: 0,
             skinDataAddr: 0,
             configurationAddr: 0,
             bindingsAddr: 0,

packages/tosu/src/objects/memoryPatterns.ts

@@ -3,7 +3,7 @@ import { wLogger } from '@tosu/common';
 export interface PatternData {
     baseAddr: number;
     playTimeAddr: number;
-    chatCheckerAddr: number;
+    chatCheckerPtr: number;
     skinDataAddr: number;
     settingsClassAddr: number;
     configurationAddr: number;
@@ -16,6 +16,7 @@ export interface PatternData {
     userProfilePtr: number;
     rawLoginStatusPtr: number;
     spectatingUserPtr: number;
+    gameTimePtr: number;
 }
 
 export class MemoryPatterns {
@@ -28,7 +29,7 @@ export class MemoryPatterns {
         this.patterns = {
             baseAddr: 0,
             playTimeAddr: 0,
-            chatCheckerAddr: 0,
+            chatCheckerPtr: 0,
             skinDataAddr: 0,
             settingsClassAddr: 0,
             configurationAddr: 0,
@@ -40,7 +41,8 @@ export class MemoryPatterns {
             getAudioLengthPtr: 0,
             userProfilePtr: 0,
             rawLoginStatusPtr: 0,
-            spectatingUserPtr: 0
+            spectatingUserPtr: 0,
+            gameTimePtr: 0
         };
 
         if (process.platform !== 'win32') {

packages/tsprocess/.gitignore

@@ -1,2 +1,2 @@
 build/
-disat/
+dist/