PacDessert1436.MGDesktopGL.ScriptingPack 1.0.0

MonoGame DesktopGL Scripting Pack

A feature-rich set of MonoGame DesktopGL 2D game templates, featuring JScript scripting support with C# game host and VBScript scripting support with VB.NET game host via Microsoft ClearScript, with a complete Snake game implementation as a getting-started demo.

All assets included in this package come with clear licensing terms and attribution requirements. See Asset Credits for complete details on usage rights and restrictions.

VBScript Support: Preserving a Legacy

As the creator of vbs-revive (https://github.com/Pac-Dessert1436/vbs-revive/) - a modern VBScript game engine built with VB.NET WinForms - I'm deeply committed to preserving the ecosystem of both VBScript and VB.NET. While Microsoft has announced plans to deprecate VBScript by 2027, this scripting pack tailored for MonoGame maintains full VBScript support as a tribute to the language's legacy and its dedicated community.

For developers seeking to continue using VBScript for game development, vbs-revive offers a forward-looking solution that preserves the familiar VBScript syntax while leveraging contemporary .NET capabilities. For those preferring a future-proof alternative, the JScript template provides a robust, supported scripting environment with similar flexibility and ease of use.

Features

• JScript Template: Full MonoGame DesktopGL project (C# host) with JScript scripting support
• VBScript Template: Full MonoGame DesktopGL project (VB.NET host) with VBScript scripting support
• ClearScript Integration: Seamless .NET and JScript/VBScript interoperability
• Ready to Use: Pre-configured with content pipeline and basic game structure

Requirements

• .NET SDK 10.0 or later
• MonoGame 3.8 or later
• ClearScript (automatically included via NuGet)

Installation

Install from NuGet

dotnet new install PacDessert1436.MGDesktopGL.ScriptingPack

Manual Installation

1. Clone or download this repository:

git clone https://github.com/Pac-Dessert1436/MonoGameDesktopGLScriptingPack.git

2. Create the NuGet package:

nuget pack PacDessert1436.MGDesktopGL.ScriptingPack.nuspec

3. Install the template:

dotnet new install .

Usage

Create a JScript Game

dotnet new mg2djscript -n MyJScriptGame
cd MyJScriptGame
dotnet run

Create a VBScript Game

dotnet new mg2dvbscript -n MyVBScriptGame
cd MyVBScriptGame
dotnet run

Project Structure

C# Host (GameHost.cs)

The C# host initializes MonoGame and sets up the JScript scripting environment:

• Loads and executes the script file
• Exposes MonoGame API to the scripting environment
• Handles game loop and input processing
• Core script file: GameCore.js

VB.NET Host (GameHost.vb)

The VB.NET host initializes MonoGame and sets up the VBScript scripting environment:

• Loads and executes the script file
• Exposes MonoGame API to the scripting environment
• Handles game loop and input processing
• Core script file: GameCore.vbs

Both JScript and VBScript script files contain the game logic:

• Initialize() - Called once at startup
• Update(gameTime) - Called every frame for game logic
• Draw(gameTime) - Called every frame for rendering

Comprehensive Scripting API

Both templates provide access to a rich set of MonoGame types and framework-specific helpers:

API Documentation

Each template includes a detailed API cheat sheet (API_CHEATSHEET.md) with:

• Comprehensive type references
• Language-specific syntax examples
• Step-by-step usage guides
• Content customization instructions
• Best practices for game development

The cheat sheets are tailored to each language's unique features (e.g., new keyword support in JScript vs. factory methods in VBScript).

Language-Specific Features

JScript Template

• Modern Syntax: Uses standard JavaScript-style syntax with function declarations and new keyword for object creation
• Case Sensitivity: Follows JavaScript conventions with case-sensitive identifiers
• Direct Object Creation: No factory methods required - create objects directly using new Vector2(), new Point(), etc.
• Random Numbers: Uses Random.Shared.Next() for robust random number generation

VBScript Template

• Legacy Compatibility: Maintains familiar VBScript syntax with Sub/Function declarations and Set keyword
• Case Insensitivity: Follows VBScript conventions with case-insensitive identifiers
• Factory Methods: Uses Helpers.CreateVector2(), Helpers.CreatePoint(), etc., since VBScript doesn't support new for .NET objects
• Random Numbers: Uses VBMath.Rnd() and VBMath.Randomize() for traditional VBScript randomization

Example Workflow

Both templates follow the same game loop pattern with language-specific syntax:

JScript

function Initialize() {
    game.SetWindowSize(800, 600);
    // Initialize game state
}

function Update(dt) {
    var keyState = Keyboard.GetState();
    // Handle input and update game logic
}

function Draw(dt) {
    game.GraphicsDevice.Clear(Color.Black);
    var batch = game.SpriteBatch;
    batch.Begin();
    // Render game graphics
    batch.End();
}

VBScript

Sub Initialize
    game.SetWindowSize 800, 600
    ' Initialize game state
End Sub

Sub Update(dt)
    Dim keyState
    Set keyState = Keyboard.GetState()
    ' Handle input and update game logic
End Sub

Sub Draw(dt)
    game.GraphicsDevice.Clear Color.Black
    Dim batch
    Set batch = game.SpriteBatch
    batch.Begin
    ' Render game graphics
    batch.End
End Sub

Full Demo Implementation

Both templates include a complete Snake game demo with:

• Responsive keyboard controls (WASD/arrow keys)
• Collision detection and game over state
• Score tracking and progressive difficulty
• Sound effects and background music
• Texture rendering and UI text

Asset Credits

• Graphics: Original artwork created using Aseprite exclusively for this project. NON-COMMERCIAL USE ONLY - These image assets may not be used, modified, or distributed for any commercial purpose. Non-commercial personal and educational use is permitted.
• Music: Pixelated Hearts Parade, from 10-track Modern Chiptune Demo by IndieDevs, licensed under the CC0 License.
• Sound Effects: 512 Sound Effects 8-bit Style by SubspaceAudio, licensed under the CC0 License.
• Font: Fusion Pixel Font by TakWolf, used with permission under SIL Open Font License.

License

MIT License. See the LICENSE file for details.