QSP

This repository contains source code of the QSP game engine.

Useful links

Documentation

• Docs: https://github.com/QSPFoundation/qspfoundation.github.io

Players

• Classic QSP player: https://github.com/QSPFoundation/qspgui
• QSpider: https://github.com/QSPFoundation/qspider

Dev tools

• QGen: https://github.com/QSPFoundation/qgen
• TXT2GAM: https://github.com/QSPFoundation/txt2gam
• Sublime Text package: https://github.com/QSPFoundation/sublime_text_qsp_package
• VSCode extension: https://github.com/QSPFoundation/Qsp.FSharp.VsCode
• CLI tools: https://github.com/QSPFoundation/qsp-cli
• Test engine: https://github.com/QSPFoundation/qsp-test-engine
• Code analyzer: https://github.com/QSPFoundation/Qsp.FSharp

Linux & MacOS build

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build

Windows build

cmake -S . -B build -G "Visual Studio 17 2022" -A Win32 -DCMAKE_INSTALL_PREFIX=out
cmake --build build --target install --config Release

WebAssembly build

Requires the Emscripten SDK:

emcmake cmake -S . -B build -DBUILD_STATIC=ON -DBUILD_WASM=ON -DCMAKE_BUILD_TYPE=Release
cmake --build build
cmake --install build --component wasm --prefix <output directory>

The wasm component contains the modules (qsp-engine*.js, qsp-engine*.wasm), their typings and the TypeScript part of the binding.

Support us

Please consider supporting our development on:

• Buy me a coffee: https://buymeacoffee.com/varg
• Ethereum/EVM: 0x4537B99e27deD6C8459C1eFCdE0E7fa48357e44D
• 

TODO

Take a look at the Project Board.

Other important tasks we're planning to tackle:

• A tool to automatically migrate older games (e.g. QSP 5.7) to the latest version of the engine
• Extra tests (see qsp-wasm-engine)
• Update the website
• New documentation & quick-start guide
• Multi-user games (MUD-style games)
• ???

Chat group

https://discord.gg/6gWVYUtUGZ