diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1571dbba..13124f66 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -297,5 +297,5 @@ jobs: - name: Upload Final Dist uses: actions/upload-artifact@v4 with: - name: prosperon-dist + name: prosperon path: dist diff --git a/README.md b/README.md index a88a88b9..21036b7b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,7 @@ -git![alt text](doc/prosperon_orb_horizontal.gif) +Thank you for using Prosperon! -The easily moddable, programming minded, 2D-first game engine. The aim is to make the fastest way to make games. +Provided are prosperon builds for all available platforms, including SDL3 for each respective one. SDL3 must be present in the same folder as prosperon to run! -It implements a good amount of ES6, but is NOT terribly compatible with the larger javascript ecosystem. Instead, the goal is to make it trivial to use C libraries in your programs, and to even write C code directly in your javascript. +To get started, take a dive into the provided example games in the examples folder. Just copy the prosperon executable for your platform, along with its SDL3 library, into any provided example folder, then run it! -Everything is text based, which makes integrating with AI trivial. - -## What's different from ES6? - -Prosperon does not use the module system. Instead, there is a 'use' statement. Modules return a single javascript object. It can be a number, a function, or an object with a list of them. Modules are ran once, cached, and frozen before returned. It is wise to keep scripts short and generously import modules. - -Programs are separated into modules and scripts. Modules end in a return statement; scripts do not. - -Javascript promises do not work. await does not work. async does not work. It's all handled via callbacks, and parseq wrapper functions. This is a lot more intuitive for computer game AI. \ No newline at end of file +You can take a look through the docs folder for the prosperon manual to learn all about it. The manual is available on the web at [docs.prosperon.dev](https://docs.prosperon.dev). diff --git a/mkdocs.yml b/mkdocs.yml index 6f8869df..4143c1fa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -12,7 +12,7 @@ theme: name: material navigation_depth: 3 logo: prosperon.gif - favicon: orb.gif + favicon: favicon.gif features: - content.action.view - navigation.prune