Skip to content

My final year BIT WebAssembly special topic project. A visual programming editor and game engine on the web

License

Notifications You must be signed in to change notification settings

aardhyn/component

Repository files navigation

Component

Aardhyn Lavender 2022-2023

A visual programming editor and game engine on the web.

Installation

git clone https://github.com/AardhynLavender/Component
cd Component

Configuration

Create an .env file

cp template.env .env
vim .env

View the template.env for more information.

Execution

Requires GNU Make (agnostic build tool) and Docker (container management).

Build and run everything in a docker container

make

View http://localhost:<CLIENT_PORT> in a web browser.

View the Makefile for more build, execution, and cleaning rules.

non-containerized build

Requires GNU Make (agnostic build tool), Node (JavaScript Runtime), and Emscripten (C and C++ WebAssembly compiler toolchain based on LLVM/Clang)

make install-editor # installs editor dependencies
make build-core     # compiles core into wasm
make build-editor   # builds the editor ( depends on core )
make run-editor     # run on the configured port ( 4096 )

Native Core

Requires gcc (compiler collection), SDL2 (C based cross-platform software development library), and GNU Make (agnostic build tool)

It's possible to build the core as a headless CLI native executable.

As I've avoided using CMake so far, the Makefile rule for native builds is hardcoded with gcc — I've not tested Clang at this stage, so make a PR if your really want to use it.

You will need to download and extract the SDL2 library. SDL is not bundled with any compilers outside of emscripten that I know of.

Use the latest stable build of SDL2 for this project. My include headers are for this version, and I've not tested SDL3 yet.

Windows

Add SDL2.dll to core/lib. Then build the core with gcc

make build-core-native

Write a program in the web client, download it, and pass it to component.exe

./component.exe program.json

Other Systems

I've not tested compilation on MacOS or Linux distributions.

References

Tool Description
GitHub Copilot Aided in code generation
ChatGPT For boucinng ideas and issues off, never responsible for writing production code

License

This software uses the MIT License

About

My final year BIT WebAssembly special topic project. A visual programming editor and game engine on the web

Topics

Resources

License

Stars

Watchers

Forks

Languages