Restructure

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintrc.js

@@ -3,133 +3,135 @@
 // Compatible with ESLint plugin
 
 module.exports = {
-	"root": true,
-	"extends": "eslint:recommended",
-	"parserOptions": {
-		"ecmaFeatures": {
-			"impliedStrict": true,
-		}
-	},
-	"env": {
-		"es6": true,
-	},
-	"globals": {
-		// The following globals are defined within D2BS, or are actually defined in the source code
-		"include": true,
-		"print": true,
-		"me": true,
-		"td": true,
-		"getTickCount": true,
-		"delay": true,
-		"getParty": true,
-		"takeScreenshot": true,
-		"getUnit": true,
-		"quit": true,
-		"clickMap": true,
-		"getBaseStat": true,
-		"clickItem": true,
-		"getCursorType": true,
-		"getPresetUnits": true,
-		"getDistance": true,
-		"copyUnit": true,
-		"getRoom": true,
-		"getLocaleString": true,
-		"scriptBroadcast": true,
-		"isIncluded": true,
-		"showConsole": true,
-		"getInteractedNPC": true,
-		"getDialogLines": true,
-		"getUIFlag": true,
-		"sendPacket": true,
-		"getPacket": true,
-		"getPath": true,
-		"rand": true,
-		"PresetUnit": true,
-		"getPresetUnit": true,
-		"getArea": true,
-		"getWaypoint": true,
-		"getScript": true,
-		"Room": true,
-		"say": true,
-		"load": true,
-		"addEventListener": true,
-		"getMercHP": true,
-		"checkCollision": true,
-		"gold": true,
-		"getLocation": true,
-		"login": true,
-		"sendCopyData": true,
-		"getControl": true,
-		"debugLog": true,
-		"getCollision": true,
-		"transmute": true,
-		"submitItem": true,
-		"createGame": true,
-		"joinGame": true,
-		"Line": true,
-		"removeEventListener": true,
-		"Unit": true,
-		"Party": true,
-		"UtilitySystem": true,
-		"moveNPC": true,
-		"getPlayerFlag": true,
-		"clickParty": true,
-		"dopen": true,
-		"NTIPAliasClassID": true,
-		"Items": true,
-		"Text": true,
-		"File": true,
-		"js_strict": true,
-		"handler": true,
-		"sendKey": true,
-		"md5": true,
-		"module": true,
-		"require": true,
-		"Box": true,
-		"Frame": true,
-		"revealLevel": true,
-		"hideConsole": true,
-	},
-	"rules": {
-		// enable additional rules
-		"indent": ["warn", "tab"],
-		"linebreak-style": ["off", "windows"],
-		"semi": ["error", "always"],
-		"comma-spacing": ["error", {"before": false, "after": true}],
-		"keyword-spacing": ["error", {"before": true, "after": true}],
-		"brace-style": ["error", "1tbs", {"allowSingleLine": true}],
-		"space-infix-ops": "error",
-		"space-unary-ops": ["error", {"words": true, "nonwords": false}],
-		"arrow-spacing": "error",
-		"arrow-body-style": ["error", "as-needed"],
-		"space-before-blocks": "error",
-		"key-spacing": ["error", {"beforeColon": false, "afterColon": true}],
-		"no-mixed-spaces-and-tabs": "error",
-		"no-trailing-spaces": ["warn", {"ignoreComments": true, "skipBlankLines": true}],
-		"no-whitespace-before-property": "error",
-		"comma-style": ["error", "last"],
-		"eol-last": ["error", "always"],
-		"block-scoped-var": "error",
-		"no-var": "warn",
-		"curly": ["error", "multi-line"],
-		"dot-notation": "warn",
-		"eqeqeq": ["error", "smart"],
-		"no-caller": "error",
-		"no-floating-decimal": "error",
-		"no-multi-spaces": ["error", {"ignoreEOLComments": true }],
-		"no-self-compare": "error",
-		"no-case-declarations": "off",
-		"no-with": "error",
-		"no-shadow": "off",
-		"no-use-before-define": "off",
-		"no-prototype-builtins": "off",
-		"quotes": ["warn", "double", { "avoidEscape": true }],
-		"no-constant-condition": ["error", {"checkLoops": false}],
-		"no-extra-label": "error",
-		//"no-labels": ["error", {"allowLoop": true}], // in the future no loops ;)
-		"no-unused-vars": ["warn", {"vars": "local"}],
-		"no-fallthrough": ["error", {"commentPattern": "break[\\s\\w]*omitted"}],
-		"no-undef": ["off", "always"],
-		"no-extra-boolean-cast": ["off", "always"],
-	}
+  "root": true,
+  "extends": "eslint:recommended",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "impliedStrict": true,
+    }
+  },
+  "env": {
+    "es6": true,
+  },
+  "globals": {
+    // The following globals are defined within D2BS, or are actually defined in the source code
+    "include": true,
+    "print": true,
+    "me": true,
+    "td": true,
+    "getTickCount": true,
+    "delay": true,
+    "getParty": true,
+    "takeScreenshot": true,
+    "getUnit": true,
+    "quit": true,
+    "clickMap": true,
+    "getBaseStat": true,
+    "clickItem": true,
+    "getCursorType": true,
+    "getPresetUnits": true,
+    "getDistance": true,
+    "copyUnit": true,
+    "getRoom": true,
+    "getLocaleString": true,
+    "scriptBroadcast": true,
+    "isIncluded": true,
+    "showConsole": true,
+    "getInteractedNPC": true,
+    "getDialogLines": true,
+    "getUIFlag": true,
+    "sendPacket": true,
+    "getPacket": true,
+    "getPath": true,
+    "rand": true,
+    "PresetUnit": true,
+    "getPresetUnit": true,
+    "getArea": true,
+    "getWaypoint": true,
+    "getScript": true,
+    "Room": true,
+    "say": true,
+    "load": true,
+    "addEventListener": true,
+    "getMercHP": true,
+    "checkCollision": true,
+    "gold": true,
+    "getLocation": true,
+    "login": true,
+    "sendCopyData": true,
+    "getControl": true,
+    "debugLog": true,
+    "getCollision": true,
+    "transmute": true,
+    "submitItem": true,
+    "createGame": true,
+    "joinGame": true,
+    "Line": true,
+    "removeEventListener": true,
+    "Unit": true,
+    "Party": true,
+    "UtilitySystem": true,
+    "moveNPC": true,
+    "getPlayerFlag": true,
+    "clickParty": true,
+    "dopen": true,
+    "Items": true,
+    "Text": true,
+    "File": true,
+    "js_strict": true,
+    "handler": true,
+    "sendKey": true,
+    "md5": true,
+    "module": true,
+    "require": true,
+    "Box": true,
+    "Frame": true,
+    "revealLevel": true,
+    "hideConsole": true,
+  },
+  "rules": {
+    // enable additional rules
+    "indent": ["warn", 2],
+    "linebreak-style": ["off", "windows"],
+    "semi": ["error", "always"],
+    "comma-spacing": ["error", { "before": false, "after": true }],
+    "keyword-spacing": ["error", { "before": true, "after": true }],
+    "object-curly-spacing": ["error", "always"],
+    "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+    "space-infix-ops": "error",
+    "space-unary-ops": ["error", { "words": true, "nonwords": false }],
+    "arrow-spacing": "error",
+    "arrow-body-style": ["error", "as-needed"],
+    "space-before-blocks": "error",
+    "key-spacing": ["error", { "mode": "strict", "beforeColon": false, "afterColon": true }],
+    "no-mixed-spaces-and-tabs": "error",
+    "no-trailing-spaces": ["warn", { "ignoreComments": true, "skipBlankLines": true }],
+    "no-whitespace-before-property": "error",
+    "comma-style": ["error", "last"],
+    "eol-last": ["error", "always"],
+    "block-scoped-var": "error",
+    "no-var": "warn",
+    "curly": ["error", "multi-line"],
+    "dot-notation": "warn",
+    "eqeqeq": ["error", "smart"],
+    "no-caller": "error",
+    "no-floating-decimal": "error",
+    "no-multi-spaces": ["error", { "ignoreEOLComments": true }],
+    "no-self-compare": "error",
+    "no-case-declarations": "off",
+    "no-with": "error",
+    "no-shadow": "off",
+    "no-use-before-define": "off",
+    "no-prototype-builtins": "off",
+    "quotes": ["warn", "double", { "avoidEscape": true }],
+    "no-constant-condition": ["error", { "checkLoops": false }],
+    "no-extra-label": "error",
+    //"no-labels": ["error", {"allowLoop": true}], // in the future no loops ;)
+    "no-unused-vars": ["warn", { "vars": "local", "varsIgnorePattern": "^_" }],
+    "no-fallthrough": ["error", { "commentPattern": "break[\\s\\w]*omitted" }],
+    "no-undef": ["off", "always"],
+    "no-extra-boolean-cast": ["off", "always"],
+    "no-useless-escape": ["off", "always"],
+    "max-len": ["warn", { "code": 120, "ignoreComments": true, "ignoreUrls": true, "ignoreStrings": true }],
+  }
 };

.github/workflows/eslint.yml

@@ -0,0 +1,23 @@
+name: ESLint Check
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '18.20.4'
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Run ESLint
+      run: npm run lint

.gitignore

@@ -1,4 +1,20 @@
+# Do not track hidden files and directories by default
+.*
 
+# Track these hidden files
+!.eslintrc.js
+!.gitignore
+!.gitmodules
+!.editorconfig
+
+# Track these hidden directories
+!.github/
+
+# Track these files from vscodes
+!.vscode/settings.json
+!.vscode/extensions.json
+
+# Do not track user generated data
 d2bs/kolbot/data/secure/*.txt
 d2bs/kolbot/data/*.json
 d2bs/kolbot/logs/*.json
@@ -7,3 +23,12 @@ d2bs/kolbot/logs/**/**
 d2bs/kolbot/mules/**/*.txt
 d2bs/logs/*.log
 d2bs/kolbot/libs/manualplay/config/*.*.js
+d2bs/kolbot/libs/soloplay/**
+d2bs/kolbot/libs/config/*.*.js
+d2bs/kolbot/D2BotSoloPlay.dbj
+data/
+images/
+logs/
+
+# Do not track install packages
+node_modules/

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "thebguy.vsnip-check"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "editor.rulers": [
+    120
+  ],
+  "editor.tabSize": 2,
+  "editor.detectIndentation": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+}

README.md

@@ -19,29 +19,30 @@
 	* D2Bot# - manager (C#)
 	* kolbot - script library (JS)
 
-* use the mainline (trunk) branch
+If you want to contribute to kolbot code, make sure you run `npm run lint` for final polish.
 
-If you want to contribute to kolbot code, make sure you use [ESLint options for kolbot code](https://gist.githubusercontent.com/Nishimura-Katsuo/2d6866666c7acf10047c486a15a7fe60/raw/99ef9c2995929c492ef856772ff346e0f19709cd/.eslintrc.js) or [JSLint options for kolbot code](https://gist.githubusercontent.com/noah-/d917342e52281d54c404e0b2c18b0c6e/raw/fbade95e38b103d2654b90d85ef62a51c4295153/jslint.config) for final polish.
 If you want to contribute to d2bs/d2bot#, come to irc.synirc.net/d2bs and ask around.
 
+[**Live Docs**](https://bhdocs.github.io/)
+
 [**Documentation Repo**](https://github.com/blizzhackers/documentation#diablo-2-botting-system-d2bs)
 
 ## Install dependencies - do this first!
 - [Microsoft Visual C++ 2010 Redistributable Package (x86)](https://www.microsoft.com/en-us/download/details.aspx?id=26999)
 - [Microsoft .NET Framework 4.0 (or higher)](https://dotnet.microsoft.com/download/dotnet-framework)
 
 ## Getting Started
-- [download kolbot](https://github.com/blizzhackers/documentation/blob/master/d2bot/Download.md#download)
-- [d2bot manager setup](https://github.com/blizzhackers/documentation/blob/master/d2bot/ManagerSetup.md/#manager-setup)
-- [IDE-Setup](IDES.md/#code-editors-ides): How to set up your IDE for syntax highlighting
-- [FAQ](https://github.com/blizzhackers/documentation/blob/master/kolbot/FAQ.md/#faq)
+- [download kolbot](https://github.com/blizzhackers/documentation/blob/restructure/d2bot/Download.md#download)
+- [d2bot manager setup](https://github.com/blizzhackers/documentation/blob/restructure/d2bot/ManagerSetup.md/#manager-setup)
+- [IDE-Setup](https://github.com/blizzhackers/documentation/blob/restructure/kolbot/IDES.md/#code-editors-ides):
+- [FAQ](https://github.com/blizzhackers/documentation/blob/restructure/kolbot/FAQ.md/#faq)
 
 ## Guides
-- [manual playing](https://github.com/blizzhackers/documentation/blob/master/kolbot/ManualPlay.md/#manual-playing)
-- [multi botting](https://github.com/blizzhackers/documentation/blob/master/kolbot/MultiBotting.md/#multi-botting)
+- [manual playing](https://github.com/blizzhackers/documentation/blob/restructure/kolbot/ManualPlay.md/#manual-playing)
+- [multi botting](https://github.com/blizzhackers/documentation/blob/restructure/kolbot/MultiBotting.md/#multi-botting)
 - [kolbot-SoloPlay](https://github.com/blizzhackers/kolbot-SoloPlay)
-- [character config](https://github.com/blizzhackers/documentation/blob/master/kolbot/CharacterConfig.md/#character-configuration)
-- [TCP/IP Games](https://github.com/blizzhackers/documentation/blob/master/kolbot/TCP-IP%20games.md#tcpip-games)
+- [character config](https://github.com/blizzhackers/documentation/blob/restructure/kolbot/CharacterConfig.md/#character-configuration)
+- [TCP/IP Games](https://github.com/blizzhackers/documentation/blob/restructure/kolbot/TCP-IP%20games.md#tcpip-games)
 
 ## LimeDrop web based item manager and dropper