MinitScript Documentation

This is the home of MinitScript - The mini C++ transpileable scripting language.

This document and repository is WIP. Expect a BETA release around 2024-04-01.\ See section 1.3. for 1.0 BETA release TODO list.

1. Introduction

MinitScript is developed as part of our TDME2 3D Engine to match the requirements for high performance script execution, as well as straight forward game logic scripting.

MinitScript might borrow some ideas from JavaScript, Kotlin, PHP and even C# and C++, which you might like and find familier. Also note the focus on easy integration into other products and easy customizability and extendability.

1.1. Open source

• MinitScript is open source
  • please check the license
  • you find the source code at https://github.com/Mindty-Kollektiv/minitscript
  • here you find developer documentation including collaboration graphs and API

1.2. Language features

• Introduction to MinitScript language features:
  • very small implementation of a scripting language
  • runs on every CPU, OS, ... due to its simplicity, so its highly portable
  • can be easily extended by writing state machine machine states and script methods in C++ as well as custom data types
  • built-in data types: null, boolean, integer, float, string, byte array, array, map and set, ...
  • when calling script C++ methods or script functions with arguments it does optionally use references or value by copy
  • supports functions/stacklets and recursion
  • supports lamda functions and inline stacklets
  • supports operators by operator to method mapping by a preprocessor run
  • supports loops, conditions and switch/case/default blocks
  • supports programming with classes style programming
    • for built-in datatypes: string, byte array, array, map and set, ...
    • for script classes/objects
    • for custom data types
  • supports event like programming
  • unicode support via UTF8
  • can be transpiled to C++

1.3. 1.0 BETA release TODO list

• Whats left to do for 1.0 BETA release
  • some adjustments
    • optional: make event system optional??? what about error emits/errors in functions/stacklets???
    • build system: check executable output directories
  • parser
    • improve error messages even more
  • documentation
    • detailed documentation for specific sections and maybe methods
    • README.md: resolve TODOs
    • README-BuildingHowTo.md: resolve TODOs
    • README-Syntax.md: TODO
    • README-Extension.md: TODO
    • README-Integration.md: TODO
    • ...
  • installer for Windows
  • installer for MacOSX

2. Language Documentation

• Syntax
• Data types and variables
• Flow control - if, elseif, else
• Flow Control - switch, case, default
• Flow Control - loops
• Classes
• Classes API
• Functions
• BuildIn functions
• Functions
• Operators
• Syntax
• Events

3. Links

• MinitScript, see README.md
• MinitScript - How to build, see README-BuildingHowTo.md
• MinitScript - How to use, see README-Tools.md
• MinitScript - ToDo list, see README-ToDo.md
• The Mindty Kollektiv Discord Server

11. Donation

• I have to pay my bills, beer and stuff, so if you have any use for this open source project, like educational, productive or fun, ..., consider a donation here PayPal, here GitHub Sponsors or via Amazon Wishlist

12. Bounties

• We will most likely accept MinitScript (related) tasks as kind of bounties for a customized MinitScript or default MinitScript