brick-engine-js 1.0.1

package/public/style/sessionModal.css

@@ -0,0 +1,155 @@
+#modal-background {
+    position: absolute;
+    inset: 0;
+    background-color: rgba(0, 0, 0, 0.5);
+    z-index: 999;
+    display: flex;
+    justify-content: center;
+    align-items: center;
+}
+
+#modal-background.hidden {
+    display: none;
+}
+
+#session-modal {
+    width: 80%;
+    max-width: 500px;
+    height: 44%;
+    max-height: 360px;
+    min-width: 320px;
+    min-height: 280px;
+    position: relative;
+    overflow: hidden;
+
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    box-sizing: border-box;
+    padding: 1rem 0;
+
+    background-color: var(--main-color);
+
+    border-radius: var(--border-radius);
+    border: var(--border);
+
+    box-shadow:
+        calc(var(--width) * -0.03) calc(var(--width) * 0.03) var(--dispersion) black,
+        calc(var(--width) * -0.02) calc(var(--width) * 0.02) var(--dispersion) var(--color-shadow-reflexion) inset,
+        calc(var(--width) * 0.01) calc(var(--width) * -0.01) var(--dispersion) var(--color-shadow) inset;
+}
+
+#session-modal-frame {
+    border: var(--border);
+    border-radius: var(--border-radius);
+
+    position: relative;
+
+    width: 90%;
+    flex: 1;
+    margin: 1rem 0;
+    min-height: 0;
+
+    display: flex;
+    justify-content: center;
+    align-items: center;
+}
+
+#session-modal-frame > p {
+    position: absolute;
+    top: 0;
+    transform: translateY(-50%);
+
+    text-align: center;
+
+    font-family: 'retro-gamming';
+    font-weight: bold;
+    font-size: clamp(1rem, calc(var(--height) * 0.03), 1.4rem);
+
+    background-color: var(--main-color);
+    padding: 0 calc(var(--width) * 0.02);
+
+    text-shadow:
+        calc(var(--width) * -0.003) calc(var(--width) * 0.003) 0 var(--color-shadow),
+        calc(var(--width) * 0.002) calc(var(--width) * -0.002) 0 var(--color-shadow-reflexion);
+}
+
+#session-modal-screen {
+    width: 90%;
+    height: 80%;
+
+    border: var(--border);
+    box-shadow:
+        calc(var(--width) * -0.01) calc(var(--width) * 0.01) var(--dispersion) var(--color-shadow),
+        calc(var(--width) * 0.01) calc(var(--width) * -0.01) var(--dispersion) var(--color-shadow-reflexion);
+
+    background-image: url('../images/cell.svg');
+    background-size: 3.7%;
+    background-repeat: repeat;
+
+    display: flex;
+    justify-content: center;
+    align-items: center;
+}
+
+#session-modal-screen > p {
+    text-align: center;
+
+    font-family: 'retro-gamming';
+    font-size: 1.5rem;
+
+    padding: 0 calc(var(--width) * 0.02);
+}
+
+#session-modal-screen > p > span {
+    font-size: 1.8rem;
+    padding: 0 calc(var(--width) * 0.02);
+}
+
+#session-modal-buttons {
+    width: 100%;
+    padding-bottom: 0.5rem;
+
+    display: flex;
+    justify-content: center;
+    align-items: center;
+
+    gap: clamp(1rem, 5vw, 2.5rem);
+}
+
+.session-modal-button:active {
+    box-shadow:
+        calc(var(--width) * -0.005) calc(var(--width) * 0.005) var(--dispersion) var(--color-shadow),
+        calc(var(--width) * -0.004) calc(var(--width) * 0.004) var(--dispersion) var(--button-color-reflexion) inset;
+    transform: translate(calc(var(--width) * -0.005), calc(var(--width) * 0.005));
+}
+
+.session-modal-button {
+    width: 35%;
+    max-width: 150px;
+    padding: 0.8rem 0;
+
+    border: var(--border);
+    border-radius: var(--border-radius);
+
+    background-color: var(--button-color);
+    box-shadow:
+        calc(var(--width) * -0.015) calc(var(--width) * 0.015) var(--dispersion) var(--color-shadow),
+        calc(var(--width) * -0.0175) calc(var(--width) * 0.0175) var(--dispersion) var(--button-color-reflexion) inset;
+
+    font-family: 'retro-gamming';
+    color: white;
+    text-align: center;
+
+    user-select: none;
+
+    font-size: 1rem;
+
+    text-shadow:
+        calc(var(--width) * -0.003) calc(var(--width) * 0.003) 0 var(--button-color-shadow),
+        calc(var(--width) * 0.002) calc(var(--width) * -0.002) 0 var(--button-color-reflexion);
+
+    transition:
+        transform var(--button-animation-duration),
+        box-shadow var(--button-animation-duration);
+}

package/public/style/sourceCodeAndCommands.css

@@ -0,0 +1,74 @@
+#source-code {
+    position: absolute;
+    top: 2%;
+    right: 2%;
+}
+
+#controls {
+    position: absolute;
+    top: 2%;
+    left: 2%;
+}
+
+#source-code,
+#controls {
+    background-color: var(--main-color);
+    padding: 0.75rem;
+    border-radius: 1.5rem;
+    cursor: pointer;
+    box-sizing: content-box;
+}
+
+#source-code > #source-code-button,
+#controls > #controls-button {
+    display: flex;
+    justify-content: center;
+    align-items: center;
+}
+
+#source-code > #source-code-button > img,
+#controls > #controls-button > img {
+    width: 2.5rem;
+    filter: invert();
+}
+#source-code:hover,
+#controls:hover {
+    background-color: var(--color-shadow-reflexion);
+}
+#source-code:active,
+#controls:active {
+    filter: brightness(1.15);
+}
+
+#source-code::after,
+#controls::after {
+    font-family: 'retro-gamming';
+    padding: 0.5rem;
+    width: 6rem;
+    background-color: white;
+    text-align: center;
+    border-radius: 0.25rem;
+    border: 1px black solid;
+    box-shadow: 0.25rem 0.25rem black;
+    opacity: 0;
+    transition: 0.25s opacity;
+}
+
+#source-code:hover::after,
+#controls:hover::after {
+    opacity: 1;
+}
+
+#source-code::after {
+    content: 'source code';
+    position: absolute;
+    top: 75px;
+    left: -65px;
+}
+
+#controls::after {
+    content: 'Controls';
+    position: absolute;
+    top: 75px;
+    left: 15px;
+}

package/public/style/splash.css

@@ -0,0 +1,13 @@
+#splash {
+    position: absolute;
+    top: 0;
+    left: 0;
+    right: 0;
+    bottom: 0;
+    background-color: black;
+    opacity: 0.85;
+    z-index: 1000;
+    display: flex;
+    justify-content: center;
+    align-items: center;
+}

package/public/style/theme.css

@@ -0,0 +1,137 @@
+@font-face {
+    font-family: retro-gamming;
+    src: url(./../fonts/digital-7.monoitalic.ttf);
+}
+
+* {
+    margin: 0;
+    padding: 0;
+    box-sizing: content-box;
+    user-select: none;
+}
+
+body {
+    width: 100vw;
+    height: 100vh;
+
+    display: flex;
+    justify-content: center;
+    align-items: center;
+
+    background: rgb(0, 158, 247);
+    background: linear-gradient(300deg, rgb(48, 179, 255) 0%, rgba(0, 158, 247, 1) 100%);
+}
+
+#version {
+    font-family: 'retro-gamming';
+    font-size: 1rem;
+    color: white;
+    position: absolute;
+    bottom: 1rem;
+    right: 1rem;
+}
+
+@media only screen and (max-width: 600px) {
+    #source-code,
+    #controls {
+        display: none;
+    }
+
+    body,
+    #container {
+        width: 100% !important;
+        height: 100vh !important;
+        /* height: 100dvh !important; */
+        border-radius: 0px !important;
+    }
+
+    #frame > canvas {
+        width: 85% !important;
+        height: auto !important;
+        aspect-ratio: 9/10 !important;
+    }
+
+    #frame {
+        width: 85% !important;
+        padding: 7.5%¨ !important;
+    }
+
+    #small-button-container {
+        margin-top: 3.5%;
+    }
+    #direction-vertical-container,
+    #direction-horizontal-container {
+        gap: calc(var(--width) * 0.13);
+    }
+
+    #large-button-container {
+        flex-shrink: 1.75;
+    }
+
+    .sm-btn {
+        width: var(--sm-button-size-mobile) !important;
+        height: var(--sm-button-size-mobile) !important;
+    }
+
+    .btn {
+        width: var(--button-size-mobile) !important;
+        height: var(--button-size-mobile) !important;
+        margin: var(--button-size-mobile-spacing) !important;
+        font-size: var(--button-size-mobile-font-size) !important;
+    }
+
+    .lg-btn {
+        width: var(--lg-button-size-mobile) !important;
+        height: var(--lg-button-size-mobile) !important;
+        font-size: var(--lg-button-size-mobile-font-size) !important;
+    }
+
+    .sm-btn-p {
+        font-size: var(--sm-button-size-mobile-font-size) !important;
+        line-height: var(--sm-button-size-mobile-line-height) !important;
+    }
+}
+
+@media only screen and (max-width: 990px) {
+    #wasd {
+        width: 10.5rem !important;
+    }
+
+    .key {
+        width: 3rem !important;
+    }
+
+    .key-description {
+        font-size: 1.5rem !important;
+    }
+
+    .command {
+        gap: 0.5rem !important;
+    }
+}
+
+@media only screen and (max-width: 815px) {
+    #controls-tutorial {
+        gap: 0rem;
+        flex-direction: column !important;
+    }
+}
+
+@media only screen and (max-width: 750px) {
+    .key-description {
+        font-size: 1.2rem !important;
+    }
+}
+
+@media only screen and (max-width: 650px) {
+    #wasd {
+        width: 9rem !important;
+    }
+
+    .key {
+        width: 2.5rem !important;
+    }
+    .key-description {
+        font-size: 1rem !important;
+    }
+}

package/scripts/generate-diagrams.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Create output directory if it doesn't exist
+mkdir -p docs/images
+
+# Loop through all .mmd files in docs/diagrams
+for file in docs/diagrams/*.mmd; do
+    # Check if file exists (in case of no matches)
+    [ -e "$file" ] || continue
+
+    # Extract filename without extension
+    filename=$(basename "$file" .mmd)
+
+    echo "Generating ${filename}.svg..."
+    
+    # Run mermaid-cli to generate SVG
+    npx -y @mermaid-js/mermaid-cli -i "$file" -o "docs/images/${filename}.svg"
+done
+
+echo "All diagrams generated successfully."

package/scripts/generate-docs.js

@@ -0,0 +1,111 @@
+const asciidoctor = require('asciidoctor')();
+const fs = require('fs');
+const path = require('path');
+
+const DOCS_DIR = path.join(__dirname, '../docs');
+const PUBLIC_DOCS_DIR = path.join(__dirname, '../public/docs');
+const README_FILE = path.join(__dirname, '../README.adoc');
+
+function getAllFiles(dirPath, arrayOfFiles) {
+    if (!fs.existsSync(dirPath)) return [];
+
+    const files = fs.readdirSync(dirPath);
+    arrayOfFiles = arrayOfFiles || [];
+
+    files.forEach(function (file) {
+        const fullPath = path.join(dirPath, file);
+        if (fs.statSync(fullPath).isDirectory()) {
+            arrayOfFiles = getAllFiles(fullPath, arrayOfFiles);
+        } else {
+            if (file.endsWith('.adoc')) {
+                arrayOfFiles.push(fullPath);
+            }
+        }
+    });
+
+    return arrayOfFiles;
+}
+
+/**
+ * Copies a directory recursively.
+ */
+function copyDir(src, dest) {
+    if (!fs.existsSync(src)) return;
+    fs.mkdirSync(dest, { recursive: true });
+    const entries = fs.readdirSync(src, { withFileTypes: true });
+
+    for (let entry of entries) {
+        const srcPath = path.join(src, entry.name);
+        const destPath = path.join(dest, entry.name);
+
+        if (entry.isDirectory()) {
+            copyDir(srcPath, destPath);
+        } else {
+            fs.copyFileSync(srcPath, destPath);
+        }
+    }
+}
+
+// Ensure public/docs exists and is clean
+if (fs.existsSync(PUBLIC_DOCS_DIR)) {
+    fs.rmSync(PUBLIC_DOCS_DIR, { recursive: true, force: true });
+}
+fs.mkdirSync(PUBLIC_DOCS_DIR, { recursive: true });
+
+// 1. Convert README.adoc to index.html
+if (fs.existsSync(README_FILE)) {
+    console.log(`Converting README.adoc -> index.html`);
+    const indexPath = path.join(PUBLIC_DOCS_DIR, 'index.html');
+    asciidoctor.convertFile(README_FILE, {
+        to_file: indexPath,
+        safe: 'safe',
+        makedirs: true,
+    });
+
+    // Fix links in index.html:
+    // - Replace 'href="docs/' with 'href="' (since index.html is in /public/docs)
+    // - Ensure .adoc links are changed to .html
+    let content = fs.readFileSync(indexPath, 'utf8');
+    content = content.replace(/href="docs\//g, 'href="');
+    content = content.replace(/\.adoc/g, '.html');
+
+    fs.writeFileSync(indexPath, content);
+    console.log('Fixed links in index.html');
+} else {
+    console.warn('README.adoc not found at root.');
+}
+
+// 2. Convert files in docs/
+if (fs.existsSync(DOCS_DIR)) {
+    const files = getAllFiles(DOCS_DIR).filter(f => !f.startsWith(path.join(DOCS_DIR, 'images')) && !f.startsWith(path.join(DOCS_DIR, 'diagrams')));
+    console.log(`Found ${files.length} .adoc files in docs/ to process.`);
+
+    files.forEach(file => {
+        const relativePath = path.relative(DOCS_DIR, file);
+        const destPath = path.join(PUBLIC_DOCS_DIR, relativePath.replace(/\.adoc$/, '.html'));
+
+        const destDir = path.dirname(destPath);
+        if (!fs.existsSync(destDir)) {
+            fs.mkdirSync(destDir, { recursive: true });
+        }
+
+        console.log(`Converting: ${relativePath} -> ${path.relative(process.cwd(), destPath)}`);
+        asciidoctor.convertFile(file, { to_file: destPath, safe: 'safe', makedirs: true });
+
+        // Fix internal links in reference files that might use docs/ prefix
+        let content = fs.readFileSync(destPath, 'utf8');
+        // If a file in reference/modules/ links to docs/reference/enums/
+        // Asciidoctor might have kept 'docs/reference/' if it wasn't a proper xref.
+        content = content.replace(/href="docs\//g, 'href="../../'); // Roughly 2 levels up
+        // Note: This is a bit naive but should solve the reported issue if it occurs in modules.
+
+        fs.writeFileSync(destPath, content);
+    });
+}
+
+// 3. Copy images and diagrams for full documentation support
+console.log('Copying images and diagrams...');
+copyDir(path.join(DOCS_DIR, 'images'), path.join(PUBLIC_DOCS_DIR, 'images'));
+copyDir(path.join(DOCS_DIR, 'diagrams'), path.join(PUBLIC_DOCS_DIR, 'diagrams'));
+
+console.log('Documentation generation complete.');

package/src/client-game.d.ts

@@ -0,0 +1 @@
+declare module '@client-game';

package/src/config/configs.test.ts

@@ -0,0 +1,20 @@
+import { describe, it, expect } from 'vitest';
+import configs from './configs';
+
+describe('configs', () => {
+    it('should export an object containing configuration values', () => {
+        // [ARRANGE & ACT]
+        const configSnapshot = configs;
+
+        // [ASSERT]
+        expect(configSnapshot).toBeDefined();
+        expect(configSnapshot.game).toBeDefined();
+        expect(configSnapshot.screenLayout).toBeDefined();
+        expect(configSnapshot.colors).toBeDefined();
+    });
+
+    it('should have read-only immutable structure based on as const declaration', () => {
+        // [ASSERT]
+        expect(configs.colors.background).toBe('rgb(172, 189, 173)');
+    });
+});