Spruce Basin (Temporary Title)
==============================

    Media source repository.

Dependencies
------------

    The following dependencies will need to be installed as per the instructions
for your system; heavily shared library-oriented systems may need all of these
installed to run the compiled binary.

    - Godot 4.4
    - Vulkan Developement Libraries (version compatible with Godot 4.4)
    - Godot Jolt
    - Boost C++ Libraries: https://www.boost.org/
    - cwebsocket: https://github.com/jeremyhahn/cwebsocket
    - TinyCThread: https://github.com/tinycthread/tinycthread

    Some platforms may require that shared libraries be placed alongside the
source files, such as MSYS-2.0.dll.

    C Reference:
        https://en.cppreference.com/w/c

    C++ Reference:
        https://en.cppreference.com/w/

Build
-----

    The recommended build procedure requires the following installations:
        - Git
        - GNU Autotools
        - UNIX Shell
        - GCC (with G++)

    1.) Install the dependencies listed above.

    2.) Clone this repository with all submodules.
        a.) Run the following command:
            git clone --recurse-submodules -j8 -b {branch} {URL to this
            repository}
                No submodules have been added yet.

    3.) Run "build.sh" within a UNIX shell.

    Using this configuration, the project will be compatible with all major
operating systems and WebAssembly, which can be useful for transpiling and
new platform testing.

Quick Setup
-----------

    In a terminal run Godot with the "--dump-extension-api" flag; this will
generate the "extension_api.json" required by your installation.

    Refer to documentation for more information.

    Project organized in conformance to the Straightforward C Project Standard 5
(SCPS5).

--- end of README ---