Files
cell/docs/engine_tour/index.md
2025-02-05 17:16:05 -06:00

1.2 KiB
Raw Blame History

Getting Started

This guide explains how to set up a minimal Prosperon project and run it.

Installation

  1. Download/Install Prosperon: (Describe your installation steps or where to get Prosperon.)

  2. Folder Structure: A typical project might have:

    my-game/
      game.js            <-- main entry script
      config.js          <-- runs at engine startup, sets up environment
      scripts/           <-- .js, .jso, or actor-based script files
      assets/            <-- images, sounds, etc.
    
  3. Run the Engine: From your project folder, run:

    prosperon
    

By default, it will look for config.js (if present), then main.js (or editor scripts) to start.

Hello World Example

  1. Create a file named config.js in your project folder:

    console.log("Hello from Prosperon!")
    this.kill()  // quits immediately after printing
    
  2. Run prosperon in that folder:

    prosperon
    

    Youll see "Hello from Prosperon!" in the console, and then the engine exits.

Thats it! Next, well explore writing more complex logic with actors, spawning objects, and drawing a game screen.