• Most of the content will be tailored for game development so there will be examples of sound, physics, etc.
• The code should run on Windows, Mac, and Linux
• Anyone is welcome to contribute, but it's best to join the Discord server first to chat about what changes you are looking to make. Feel free to join if you're having trouble with anything.

NOTE: Before you do anything else, read this article to understand why the structure is the way that it is.

• game_mode_architecture
• mouse_subtick_updates
• networking_animations_and_projectiles
• why_you_need_a_playback_system_to_create_quality_client_server_systems

• frag-z (in active development)
• cjmines (in active development)

• observatory (model viewer)
• editor

fundamentals

• mwe_glfw
• mwe_shader_cache
• mwe_vertex_geometry
• mwe_model_loading

lighting

• mwe_lighting
• mwe_light_culling
• mwe_model_loading_lighting
• mwe_deferred_lighting

font and text rendering

• mwe_font_rendering
• mwe_font_atlas

performant rendering infrastructure

• mwe_ubo_transforms
• mwe_texture_packer
• mwe_batcher

effects

• mwe_bullet_trace
• mwe_animated_texture_atlas

ui

• mwe_ui
• mwe_grid_font

sound

• mwe_sound
• mwe_sound_world_with_character

physics

• jolt_physics_sandbox
• mwe_physics_world_with_character

networking

• mwe_networking
• mwe_packet_type_handling
• mwe_networked_mouse
• mwe_networked_physics_world_with_character

subsystem synchronization

• mwe_scripted_scene_manager

Anything denoted by SUBPROJECT is a repository of files which probably will not work on its own, but is to be used in a larger application. We rely on these subprojects to isolate the functionality of a specific thing that can be re-used elsewhere.

Pretty much all of the code is written in c++ so in order to get setup you need to have a working c++ compilers, additionally we use conan for managing packages, so you'll need that as well. If that's something you're not already comfortable with then consult these documents

• linux
• mac
• windows

The projects in this repo should do one thing well, and only do that. Try not to have multiple goals when creating new projects in this organization.

All projects use submodules to facilitate the integration of subprojects. Subprojects need to be set up to link to each other using sbpt. For managing external libraries, we use conan, so install it on your system and follow their docs for preliminary setup on how to generate a profile before you run any conan commands.

First, cd into the root of the project, then:

        # clone the project with all the submodules 
        git clone --recurse-submodules -j8 GITHUB_SSH_LINK_HERE  
        cd JUST_CLONED_DIR

        # generate dynamic includes to linked subprojects
        python scripts/sbpt/main.py src

        # if using graphical systems
        python scripts/setup/graphics_systems.py

        # install required packages
        conan install . --build=missing

        # generate build system and then build, if you are on windows in the first command change release to default
        cmake --preset conan-release 
        cmake --build --preset conan-release
        
        # now run the executable
        ./build/Release/EXECUTABLE_NAME
    

From there, run the executable. Note that if you try running the executable from anywhere else, it will probably fail because it depends on paths of resources being relative to this folder, which may be fixed in the future.

If you are looking to develop existing code, note that we use a consistent style guide to keep things organized. We use clang-format for this. To populate the project with the correct settings, go to the root of the project and do:

        cd clang_formatting
        ./create_symlinks.sh
    

We've built up many small scripts which make working within this ecosystem a lot nicer, most of these scripts are written in python

ongoing development

• a system which will cull objects (such as lights) so they don't get added to the draw call
• scripted event system
• animation management system

upcoming development

• a networked mouth smoothing system client server different frequencies
• a model loading application with a file browser
• a networked mouse smoothing system
• text editor (with multi-user support)
• multi-user (online networked) modelling software