volt

A multithreaded, high performance, fully functional game engine written in C++. ⚡️

https://github.com/sparky-game/volt

Keywords

Repository

A multithreaded, high performance, fully functional game engine written in C++. ⚡️

README.org

#+AUTHOR: Wasym A. Alonso

# Logo & Title
#+begin_html




Volt

#+end_html

# Subtitle
#+begin_html

Write games, don't play them

#+end_html

# Repository marketing badges
#+begin_html










#+end_html

# Repository info badges
#+begin_html












#+end_html

# Repository CI badges
#+begin_html




#+end_html

(...)

* Table of Contents :toc:
- [[#project-management][Project management]]
- [[#documentation][Documentation]]
- [[#usage][Usage]]
- [[#build-from-source][Build from source]]
  - [[#get-the-code][Get the code]]
  - [[#configuration][Configuration]]
  - [[#compilation-and-linkage][Compilation and linkage]]
- [[#licensing][Licensing]]

* Project management

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:

- [[https://github.com/orgs/sparky-game/projects/2][Roadmap]]
- User feedback /(Coming soon!)/

* Documentation

The documentation of /Volt/ includes:

- [[https://github.com/sparky-game/volt/wiki][Main documentation]]
- Reference manual /(Coming soon!)/
- API documentation /(Coming soon!)/

* Usage

/Volt/ is first and foremost a *statically linked library* that acts as the engine itself.

(...)

It also provides a builtin application that acts as the official *editor*, where you can customize every aspect of your project, debug it, build it and ship it to the end user.

It's a *WYSIWYG*-style editor (i.e. *What You See Is What You Get*), meaning that everything done in it will be exactly reflected on the final product.

(...)

* Build from source

In order to build /Volt/ from source, preparation is needed so as to the environment is properly setup and ready.

** Get the code

First, download the codebase of the project. It's important to do so via the *OFFICIAL* Git repository hosted on [[https://github.com/sparky-game/volt][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:

#+begin_src sh
git clone --recurse-submodules https://github.com/sparky-game/volt
#+end_src

Alternatively, to update an existing clone you can issue the following commands:

#+begin_src sh
git pull
git submodule update --init --recursive
#+end_src

** Configuration

This project uses *CMake* as its build system, so make sure to have it installed and available to use before proceeding.

#+begin_src sh
cmake -B build [-D...]
#+end_src

If wanted to *debug* /Volt/ as part of the development process, we can use the ~CMAKE_BUILD_TYPE~ variable to target the /Debug/ build type (its set to /Release/ by default). Note that this procedure only applies to *single-configuration generators*; if that isn't your case (i.e. /Ninja Multi-Config/, /Visual Studio/, /Xcode/, etc.), you can already change between build types without worrying about it.

Both *C and C++ compilers* can be manually specified by using the ~CMAKE_C_COMPILER~ and ~CMAKE_CXX_COMPILER~ variables. By default, the project gives priority to /Clang/ ahead of other compilers.

If *cross-compiling* is our thing, we can use the ~CMAKE_TOOLCHAIN_FILE~ variable to specify the target we want to build /Volt/ for (e.g. ~cmake/cross/mingw-x86_64.cmake~ to cross-compile to /MinGW x86_64/ target, i.e. /Win64/).

** Compilation and linkage

This step is orchestrated by the native build tool. After the project has been configured and build files have been generated, the only thing left is to compile and link all defined targets of /Volt/.

#+begin_src sh
cmake --build build
#+end_src

(...)

* Licensing

Copyright (C) 2024 Wasym A. Alonso. All rights reserved.

#+begin_quote
/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. @@html:
@@
/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. @@html:
@@
For more information, see .
#+end_quote

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 [[https://iwas-coder.itch.io/volt][its product page in itch.io]].

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: "Please cite this software using these metadata."
type: software
title: Volt
authors:
  - given-names: Wasym
    family-names: Atieh Alonso
contact:
  - given-names: Wasym
    family-names: Atieh Alonso
    email: wasymatieh01@gmail.com
abstract: "A multithreaded, high performance, fully functional game engine written in C++."
license:
  - AGPL-3.0-only
  - Commercial
repository-code: "https://github.com/sparky-game/volt"

GitHub Events