Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/developer-mike/sprout

The low-code platform for learning game development.
https://github.com/developer-mike/sprout

Last synced: 10 months ago
JSON representation

The low-code platform for learning game development.

Awesome Lists containing this project

README 

          


    Logo

    


    Sprout






    The low-code platform for learning game development.

    



    Time Spent

    MPL-2.0 license




> [!important] 

> For Sprout to work properly, you must use **Chrome**.



## 🌱 SproutScript

Sprout uses the custom SproutScript language.



- Variable Definition: `var x = 0`

- Function Declaration: `fun foo = () { }`

- While-Loop: `while (condition) { }`

- For-Loop: `for (i in range(10)) { }`

- On-Statement (Gets executed every frame if condition is met): `on (condition) { }`



Check out the ["Pong" project](https://sprout.by-mika.dev/builder?template=pong) for a sample project.



## 🚀 Running the project

1. Clone the repository

```bash

git clone https://github.com/Developer-Mike/sprout.git

```

2. Install the dependencies

```bash

npm i

```

3. Run the application

```bash

npm run dev

```



## ✨ Roadmap

- [x] Create the project

- [x] Decide the style and design of the project

- [x] Implement the basic UI using Next.js and SCSS

- [x] Design the basic structure of the project data

- [x] Make it work with fixed data and JavaScript

- [x] Add support for sprites

- [x] Implement game objects pane

  - [x] Add game object settings

  - [x] Don't allow adding objects with the same id

  - [x] Allow reordering of the objects

  - [x] Confirm deletion of objects

- [x] Add keyboard shortcuts

- [x] Make the code editor work with JavaScript

- [x] Load and save the project data

  - [x] Detect unsaved project and prevent closing the tab if the data is not saved

  - [x] Automatically save the project data

    - [x] Add save history

    - [x] Make the history less detailed

  - [x] Add loading progress bar

- [x] Add projects overview (list of projects)

- [x] Sprites Tab

  - [x] Add the ability to reorder sprites

  - [x] Add the ability to change the active sprite

  - [x] Add the ability to delete sprites

- [x] Add sprites library dialog

  - [x] Add the ability to upload sprites

  - [x] Add the ability to delete sprites

  - [x] Add the ability to rename sprites

  - [x] Add the ability to assign sprites to game objects

  - [x] Add sprite information

- [x] Only add LabeledNumberInput change to history after the user stops dragging

- [x] Add undo/redo to the navbar

- [x] Always save project before rerouting

- [x] Create the programming language for Sprout

  - [x] Remove the usage of large strings and eval in the SproutEngine

  - [x] Create programming language concepts

    - [x] Variables

    - [x] Functions

    - [x] Loops (for, while)

    - [x] Conditions (if, else)

    - [x] Comments

  - [x] Create Lexer (Code -> Tokens)

  - [x] Create Parser (Tokens -> AST)

    - [x] Add support for mutable variables

    - [x] Add support for if, while, for and on statements

    - [x] Add support for await expressions

    - [x] Add support for lists

    - [x] Add support for index access (and square brackets access in general)

    - [x] Fix return statements inside for loops not working

    - [x] Fix return statements nested inside if statements not working

      - [x] Change if expressions to statements? -> Added both types!

    - [!] Fix return statements inside e.g. if expressions checking next line for return value

    - [x] Add support for && and || operators

    - [!] (If time allows) Add support for lambdas

    - [!] (If time allows) Add support for objects

    - [x] (If time allows) Add support for +=, -=, *=, /= operators

    - [x] (If time allows) Add support for unary operators (!bool, -var, +var, ++, --)

  - [x] Create AST compiler function (AST -> JavaScript)

  - [x] Create error handling (Compilation & Runtime)

  - [x] Show errors in the code editor

  - [x] Fix the syntax highlighting and linting (Only basic syntax highlighting)

  - [x] (If time allows) Add autocomplete for some objects (e.g. game_objects, sprites)

  - [x] Fix execution of the code

  - [x] Add implemented functions to the language

    - [x] range

    - [x] Expose math functions

- [x] Add implemented functions to the engine

  - [x] move, rotate (Handle delta_time)

  - [x] rotate_to

  - [x] collides_with, collides_with_box, collides_with_mouse

  - [x] sleep

  - [!] (If time allows) Add physics engine

  - [!] (If time allows) Add support for camera

    - [!] stage.camera

      - [!] x, y (properties)

      - [!] move (handle delta_time)

  - [!] (If time allows) Add support for drawing (new entry in the runtime data)

    - [!] draw_text

    - [!] draw_line

    - [!] draw_rectangle

    - [!] draw_circle

  - [x] (If time allows) Add support cloning and destroying game objects while the game is running

    - [x] clone

    - [x] destroy

    - [x] is_clone (property)

- [x] Add console view

  - [x] Throw error if the user wants to start the game with syntax errors

  - [x] Catch runtime errors and show them in the console

  - [!] (If time allows) Add advanced explanations to error messages

- [x] Miscellaneous

  - [x] Add a clean way to handle debug information

  - [x] Rework game object scaling (width and factor for height) -> Fix different scaling for different sprites

    - [x] Add width and height info to the sprites in the sprites library

  - [x] Solve all TODOs

  - [x] Remove all DEBUGs

  - [x] Fix canvas can be right-clicked

  - [x] Disable the ability to select game objects through the canvas if th game is running

  - [x] When editing a float and deleting the last digit before the decimal point, the dot gets deleted unintentionally

  - [x] When editing e.g. 800 and deleting the 8, the 0 gets deleted unintentionally

  - [x] Limit max height of game object preview in code editor

  - [x] Reset linked scaling when changing the sprite

  - [!] (Out of scope) Allow simple calculations in the LabeledNumberInput

- [x] Create some example games

  - [!] Add the ability to add information text to the documentation sidebar

- [x] Add warning if not using Chrome

- [x] Bugfixes

  - [x] Add absolute identifiers to project paths -> Fix project with same filename not visible in the projects overview

  - [x] Fix rotation of game objects causing other game objects to move

  - [x] Fix deletion of all game objects causing null value of selected object key

- [x] (If time allows) Add the ability to duplicate game objects

- [!] (If time allows) Add the ability to add plugins (keep in mind: security risk)

- [!] (Out of scope) Add the ability to export and import game objects individually

- [!] (Out of scope) Add export of the games to standalone websites

- [!] (Out of scope) Add the ability to add sounds and music

- [!] (Out of scope) Create tool for simple image editing of sprites

- [!] (Out of scope) Add tooltips

  - [!] Unsaved changes

  - [!] Game object properties

  - [!] Add game object button

  - [!] Vertical tab buttons