Initial commit

Author: GreepTheSheep

.editorconfig

@@ -0,0 +1,21 @@
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+insert_final_newline = false
+
+[*.md]
+indent_size = 2
+
+[*.js]
+indent_size = 4
+
+[*.yml]
+indent_size = 2
+
+[*.yaml]
+indent_size = 2
+
+[*.json]
+indent_size = 4

.eslintrc.json

@@ -0,0 +1,21 @@
+{
+    "env": {
+        "commonjs": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": "eslint:recommended",
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "rules": {
+        "indent": [
+            "warn",
+            4
+        ],
+        "semi": [
+            "error",
+            "always"
+        ]
+    }
+}

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: GreepTheSheep

.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish on Release created
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    name: Publish on NPM
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish on NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+
+  publish-gpr:
+    name: Publish on Github Packages
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: https://npm.pkg.github.com/
+          scope: '@greepthesheep'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish on Github Packages
+        run: npm publish --registry=https://npm.pkg.github.com/@greepthesheep
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.gh_token}}

.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Unit Tests
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'src/**.js'
+      - 'test/**.test.js'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'src/**.js'
+      - 'test/**.test.js'
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Install Node v16
+      uses: actions/setup-node@v2
+      with:
+        node-version: 16
+        cache: npm
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Run tests
+      run: npm test

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${file}"
+        }
+    ]
+}

README.md

@@ -1,2 +1,67 @@
-# node-tm-essentials
-A lightweight library in Node.js that provides formatting features and little additions for any development related to Trackmania.
+# Trackmania Essentials (for Node.js)
+
+[![npm](https://img.shields.io/npm/v/tm-essentials?logo=npm&style=for-the-badge)](https://npmjs.com/tm-essentials)
+[![GitHub release](https://img.shields.io/github/v/release/GreepTheSheep/node-tm-essentials?logo=github&style=for-the-badge)](https://github.com/GreepTheSheep/node-tm-essentials/releases/latest)
+
+A light-weight library that provides formatting features for Trackmania games.
+
+## Text formatting
+
+`TextFormatter.deformat()`
+
+```js
+let formatted = "$F00T$D01M$C13U$A14.$815K$727r$528a$329z$23By$03CC$03Co$04Bl$059o$068r$077s$085 $094v$0A30$0B1.$0C01";
+let deformatted = TextFormatter.deformat(formatted);
+console.log(deformatted);
+
+// Output: TMU.KrazyColors v0.1
+```
+
+`TextFormatter.formatAnsi()`
+
+Will parse the color formatting and convert it to ANSI escape codes. Works best on console output.
+
+```js
+let formatted = "$F00T$D01M$C13U$A14.$815K$727r$528a$329z$23By$03CC$03Co$04Bl$059o$068r$077s$085 $094v$0A30$0B1.$0C01";
+let ansiFormat = TextFormatter.formatAnsi(formatted);
+console.log(deformatted);
+```
+
+This will not deformat basic formatting codes, but you can combine them with `TextFormatter.deformat()` to get the original text.
+
+```js
+let formatted = "$F00T$D01M$C13U$A14.$815K$727r$528a$329z$23By$03CC$03Co$04Bl$059o$068r$077s$085 $094v$0A30$0B1.$0C01";
+let ansiFormat = TextFormatter.deformat(TextFormatter.formatAnsi(formatted));
+console.log(deformatted);
+```
+
+## Time formatting
+
+`Time.time` - Total milliseconds as integer value.
+
+`Time.toTmString()`
+
+```js
+Time.fromMilliseconds(1337).toTmString(); // "0:01.337"
+Time.fromMilliseconds(1337).toTmString(true); // Will use hundredths as output: "0:01.33"
+
+Time.fromSeconds(13.37).toTmString(); // "0:13.370"
+Time.fromMinutes(13.37).toTmString(); // "13:37.000"
+Time.fromHours(13.37).toTmString(); // "13:37:00.000"
+
+Time.noTime.toTmString(); // "-:--.---"
+```
+
+## Accounts formatting
+
+`Accounts.toAccountId()`
+
+```js
+Accounts.toAccountId("Jtmn3kBnSSadky_mLNhp_A") // "26d9a7de-4067-4926-9d93-2fe62cd869fc"
+```
+
+`Accounts.toLogin()`
+
+```js
+Accounts.toLogin("26d9a7de-4067-4926-9d93-2fe62cd869fc") // "Jtmn3kBnSSadky_mLNhp_A"
+```