(…)
GitHub is the system we use to track feature requests, bug reports and other requested work. Different projects are created to separate concerns and responsabilities:
The documentation of Volt includes:
- Main documentation
- Reference manual (Coming soon!)
- API documentation (Coming soon!)
(…)
In order to build Volt from source, preparation is needed so as to the environment is properly setup and ready.
First, download the codebase of the project. It’s important to do so via the OFFICIAL Git repository hosted on GitHub, and not through any tarball or compressed archive to ensure no tampering is done with the code. Appart from that, any ref can be checked out, being master (the trunk of all dev progress), a tagged commit (e.g. v1.0), an actively maintained version branch (e.g. v1.0.y/stable) or a LTS version branch (e.g. v1.0.y/lts) the preferred ones.
To clone the official repo as well as all its submodules, issue the following command:
git clone --recurse-submodules https://github.com/sparky-game/voltAlternatively, to update an existing clone you can issue the following commands:
git pull
git submodule update --init --recursive(…)
cmake -B build [-DCMAKE_BUILD_TYPE=Debug](…)
cmake --build build(…)
Copyright (C) 2024 Wasym A. Alonso. All rights reserved.
Volt is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License Version 3 (GNU AGPL-3.0) as published by the Free Software Foundation (FSF) on November 19th 2007.
Volt is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License Version 3 for more details.
For more information, see https://www.gnu.org/licenses/agpl-3.0.
As mentioned above, Volt is licensed under the GNU AGPL-3.0, which means that any games or software created using Volt are also subject to the same license. This implies that if you develop a game or application using Volt, it must also be released as free software under the GNU AGPL-3.0. This ensures that the freedoms to use, study, modify and share the software are preserved for everyone.
If you prefer to release your game or application under a different, more commercially friendly license, there is an option available. You can obtain a commercial license for Volt that does not require you to release your games under the GNU AGPL-3.0. This license is available for purchase, allowing you more flexibility in how you distribute and monetize your work.
For more details and to acquire the commercial license, please visit its product page in itch.io.