samengine Config

Index

• Paragraphs
  • How to add them

Basic Config for samengine.

import type { buildconfig } from "samengine-build";
import { new_buildconfig } from "samengine-build";

export default function defineConfig(): buildconfig {
    let config: buildconfig = new_buildconfig();
    config.title = "New Game";
    config.description: "Your Game Description",
    return config;
}

other Values for the Build Config are:

export default function defineConfig(): buildconfig {
    let config: buildconfig = new_buildconfig();

    // Change the Ouput Directory
    config.outdir = "dist";

    // a Button which enabled to play your Game in Fullscreen
    config.show_fullscreen_button = true;

    // Version of your Game
    config.version = "0.0.0";

    // Insert Stuff to the HEAD Element of the HTML Export
    // for example an Browser Page Icon
    config.htmlhead = "";

    // The Game Author (will be mentioned on the Game startpage)
    config.author = "you";

    // The Webserver Port for the Develepment Server
    config.dev_server_port = 3001;

    // Enable or disable Audio for the Game. Is turned off normally
    // because it would make the Code size bigger
    config.enable_audio = false;

    // CSS Style for Mobile Devices
    config.enable_mobile_css = false;

    // Samegui Config
    config.samegui = newSameGUI();

    // Show the Settings Button for samegui
    config.samegui.show_button = false;

    return config;
}

Paragraphs

You can add Paragraphs which will then be displayed on the Game Startpage, for exapmle for Credits, Infos about the Game ... Just be creative, write there what ever you want

How to add them

export default function defineConfig(): buildconfig {
    let config: buildconfig = new_buildconfig();

    config.markdown_notes = [
        {
            title: "New Note",
            content: `# Here can you write markdown`
        },

        // You can althogh add optinal Styles here
        {
            title: "Note 2",
            content: "Content 2",
            style: {
                color: "",
                bg_color: ""
            }
        }
    ];

    return config;
}