.jpeg){kind=icon}
Spark Engine Web is a lightweight browser-based web game engine we build for fun.
We are building the engine to be simple and fairly performant, and we want to provide the best possible experience to our engine's users and contributors.
That being said, it will be an iterative journey and we won't bump the major version until we feel confident we have reached our goal.
- Node ^20
- NPM ^10
Run npm i to install packages. After that, you are good to go
Here you can find the list of commands. Commands with the :ci flag are reserved for the CI setup of the project and not recommended for normal use
npm testto run the unit test suitenpm run test:perfto run the performance test suitenpm run buildto build the enginenpm run build:devto build the engine in development modenpm run build:docsto build the documentation directorynpm run cleanto clean the dist foldernpm run serve:examplesto serve examples in a local webserver, getting rid of annoying CORS issues and similar. Requiresnpm run build:*
Download the latest release here: https://github.com/RuggeroVisintin/SparkEngineWeb/releases/latest.
Then npm i and npm build to install dependencies and build the .js distribution file.
You can now include it in your html page like so
<html>
<body>
<canvas id="canvas" style="width: 100%; height: 100%"></canvas>
<script type="text/javascript" src="./dist/spark-engine-web.js"></script>
<script>
const context = document.getElementById('canvas').getContext('2d');
const engine = new SparkEngine.GameEngine({
context,
framerate: 30,
resolution: { width: 1920, height: 1080 }
});
const scene = engine.createScene();
</script>
</body>
</html>See the available examples to find out more
You can add more examples in the examples folder. To correctly serve them, especially if you experience problems with CORS, see the npm run serve:examples command.
or just visit https://ruggerovisintin.github.io/SparkEngineWeb/examples for a ready-to-use version, updated to the latest release
To contribute to the project just open a pull request. If you are working on an existing issue remember to link the pull request to it.
Once opened a core maintainer will review the PR and eventually approve it
See LICENSE file
See the maintainers section in package.json