haxball.js 1.0.3 → 2.0.0

package/README.md

@@ -10,14 +10,14 @@
 
 ### 🔖 Table Of Contents
 
--   🤔 [How To Use](#how-to-use)
--   🚀 [Technologies](#technologies)
--   🌱 [Minimal Requirements](#minimal-requirements)
--   🎊 [Features](#features)
--   💡 [How To Contribute](#how-to-contribute)
--   🤗 [Contributors](#contributors)
--   👤 [Author](#author)
--   🔏 [License](#license)
+- 🤔 [How To Use](#how-to-use)
+- 🚀 [Technologies](#technologies)
+- 🌱 [Minimal Requirements](#minimal-requirements)
+- 🎊 [Features](#features)
+- 💡 [How To Contribute](#how-to-contribute)
+- 🤗 [Contributors](#contributors)
+- 👤 [Author](#author)
+- 🔏 [License](#license)
 
 ---
 
@@ -34,32 +34,36 @@ npm install haxball.js
 ```js
 const HaxballJS = require("haxball.js");
 
-const room = new HaxballJS.Room({
-    roomName: "Room Name",
-    playerName: "Haxball.JS",
+HaxballJS.then((HBInit) => {
+  // All is same as Haxball Headless Host Documentation
+  const room = HBInit({
+    roomName: "Haxball.JS",
     maxPlayers: 16,
     public: true,
-    token: "token"
-});
+    noPlayer: true,
+    token: "TOKEN", // Required
+  });
 
-room.once("ready", (link) => {
-    console.log(`Room created ${link}`);
-});
+  room.setDefaultStadium("Big");
+  room.setScoreLimit(5);
+  room.setTimeLimit(0);
 
-room.on("onPlayerChat", (player, message) => {
-    if (message === "ping") {
-        room.send("pong");
-    }
+  room.onRoomLink = function (link) {
+    console.log(link);
+  };
 });
-
-room.create();
 ```
 
 ---
 
 <h2 id="technologies">🚀 Technologies</h2>
 
--   Puppeteer
+- wrtc - WebRTC implementation for NodeJS
+- ws - Websocket Connection
+- JSON5 - JSON Helper Module
+- @peculiar/webcrypto - Webcrypto implementation for NodeJS
+- pako - ZLIP Port for NodeJS
+- node-fetch - HTTP Requests
 
 [Back To The Top](#title)
 
@@ -67,8 +71,8 @@ room.create();
 
 <h2 id="minimal-requirements">🌱 Minimal Requirements</h2>
 
--   NPM
--   NodeJs
+- NPM
+- NodeJs
 
 [Back To The Top](#title)
 
@@ -76,9 +80,9 @@ room.create();
 
 <h2 id="features">🎊 Features</h2>
 
--   [x] Promise based
--   [x] Synchronous
--   [x] Performant
+- [x] Promise based
+- [x] Synchronous
+- [x] Performant
 
 [Back To The Top](#title)
 
@@ -86,13 +90,13 @@ room.create();
 
 <h2 id="how-to-contribute">💡 How To Contribute</h2>
 
--   Make a fork of this repository
--   Clone to you machine and entry on respective paste
--   Create a branch with your resource: `git checkout -b my-feature`
--   Commit your changes: `git commit -m 'feat: My new feature'`
--   Push your branch: `git push origin my-feature`
--   A green button will appear at the beginning of this repository
--   Click to open and fill in the pull request information
+- Make a fork of this repository
+- Clone to you machine and entry on respective paste
+- Create a branch with your resource: `git checkout -b my-feature`
+- Commit your changes: `git commit -m 'feat: My new feature'`
+- Push your branch: `git push origin my-feature`
+- A green button will appear at the beginning of this repository
+- Click to open and fill in the pull request information
 
 <p align="center">
 <i>Contributions, issues and features requests are welcome!</i><br />
@@ -117,17 +121,6 @@ room.create();
 
 ---
 
-<h2 id="author">👤 Author</h2>
-
-🤓 **Mertushka <mertushkaonline@gmail.com>**
-
--   Instagram: [@mertushka](https://instagram.com/mertushka)
--   Github: [@mertushka](https://github.com/mertushka)
-
-[Back To The Top](#title)
-
----
-
 <h2 id="license">🔏 License</h2>
 
 Copyright © 2021 [Mertushka <mertushkaonline@gmail.com>](https://github.com/mertushka)

package/package.json

@@ -1,39 +1,37 @@
 {
-    "name": "haxball.js",
-    "version": "1.0.3",
-    "description": "A powerful library for interacting with the Haxball Headless API",
-    "main": "src/index.js",
-    "scripts": {
-        "test": "echo 'who needs test when you can code' && exit 0",
-        "lint": "npx eslint src test",
-        "lint:fix": "npm run lint -- --fix",
-        "prettier": "npx prettier src test --check",
-        "prettier:fix": "npm run prettier -- --write",
-        "format": "npm run prettier:fix && npm run lint:fix"
-    },
-    "keywords": [
-        "haxball",
-        "bot",
-        "room"
-    ],
-    "author": "mertushka",
-    "license": "MIT",
-    "dependencies": {
-        "@discordjs/collection": "^0.2.0",
-        "puppeteer": "^10.1.0"
-    },
-    "devDependencies": {
-        "eslint": "^7.31.0",
-        "eslint-config-prettier": "^8.3.0",
-        "prettier": "2.3.2",
-        "prettier-eslint": "^12.0.0"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mertushka/haxball.js.git"
-    },
-    "bugs": {
-        "url": "https://github.com/mertushka/haxball.js/issues"
-    },
-    "homepage": "https://github.com/mertushka/haxball.js#readme"
+  "name": "haxball.js",
+  "version": "2.0.0",
+  "description": "A powerful library for interacting with the Haxball Headless API",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "mocha --recursive --exit"
+  },
+  "keywords": [
+    "haxball",
+    "headless",
+    "bot",
+    "room"
+  ],
+  "author": "mertushka",
+  "license": "MIT",
+  "dependencies": {
+    "@peculiar/webcrypto": "^1.3.3",
+    "json5": "^2.2.1",
+    "node-fetch": "^2.6.6",
+    "pako": "^2.0.4",
+    "wrtc": "^0.4.7",
+    "ws": "^8.5.0"
+  },
+  "devDependencies": {
+    "mocha": "^9.2.2",
+    "node-pre-gyp": "^0.17.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mertushka/haxball.js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mertushka/haxball.js/issues"
+  },
+  "homepage": "https://github.com/mertushka/haxball.js#readme"
 }