Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bruno-sartori/handmade-hero

Study repository for Casey Muratori's Handmade Hero series which is a game from scratch using only C++ and no libraries
https://github.com/bruno-sartori/handmade-hero

Last synced: 17 days ago
JSON representation

Study repository for Casey Muratori's Handmade Hero series which is a game from scratch using only C++ and no libraries

Awesome Lists containing this project

README 

        


  


    Handmade Hero

  






## Intro



This is my personal study notes of the awesome project [Handmade Hero](https://handmadehero.org).



If you think __writing a professional-quality game from scratch on your own (no engine no library)__ is interesting and challenging, I highly recommend this project.



In my opinion, it's **the best** I can find.



## Showcase



### Day 85



![](https://raw.githubusercontent.com/bruno-sartori/handmade-hero/refs/heads/main/day85.gif)



- We can jump 😉

- We can shoot 🔫

- We can go upstair and downstair 🏃‍♀️

- We have a big world and many rooms 🗺

- We have a basic procedure generated ground 🌿



## Env



Windows 10 with Visual Studio 2019 community version and Sublime Text 3.



Build system for Sublime Text 3:



```json

{

  "build_systems":

  [

    {

      "name": "HandmadeHero",

      "shell_cmd": "build",

      "file_regex":"^(.+?)\\((\\d+\\))(): (error)(.+)$"

    }

  ]

}

```



## Setup



NOTE: **This repo does not contain copyrighted HandmadeHero assets, to build this repo, please consider preorder HandmadeHero**.



- Create a `w` drive using subst: `subst w: /c/whatever_directory_you_choose`

- Clone this repo into the root of `w`

- Install Visual Studio 2019 community version

- cd into `w` and init cl: `.\handmade-hero\misc\shell.bat`

- Build and enjoy! `build`



## Code Style



My preferred code style for C is different from Casey's.



- snake_case for types, e.g. `game_world`

- camelCase for variables, e.g. `globalRunning`

- PascalCase for functions and macro functions, e.g. `GameUpdateVideo`

- UPPER_SNAKE_CASE for macro constants, e.g. `TILES_PER_CHUNK`

- Prefix an underscore to indicate that this function should only be called with a corresponding macro, e.g. `_PushSize`



## Marks



- `NOTE`: Something we need to pay attention to

- `PLAN`: Something we plan to do it later

- `RESOURCE`: External valuable resource

- `DIFF`: Something I have done it differently from Casey

- `FUN`: Something interesting to know, like Windows can't correctly handle file formats they invented

- `CASEY`: Casey's opinion about programming



## Game Programming



- Every memory allocation should go through a macro, it will make the debugging much easier.

- `Premultiplied Alpha`: check day 83 for more details.

- `Gamma Correction`: check day 94 for more details.

- `Transform Normal`: check day 102 for more details.



## Windows Programming



### Command Prompt



- `dir /s [keyword]`: search files

- `findstr -s -n -i -l [keyword]`: find strings



### Win32 API



- `WS_EX_TOPMOST`: make window in front of others

- `WS_EX_LAYERED` and `SetLayeredWindowAttributes `: change window alpha



### Visual Studio



- `Spy++`: inspect windows and messages



## Resources



* https://hero.handmade.network/episode/code/day001/

* https://learn.microsoft.com/en-us/windows/win32/learnwin32/winmain--the-application-entry-point



## Build and Debug



* To build the application:



```

    cd handmade\code

    build.bat

```



* To debug the application:



```

    devenv ..\..\build\win32_handmade.exe

```



This will open visual studio, once there remember to change "Executable" and "Working Directory" on exe properties. Example:



![alt text](./docs/exe_properties.jpg)



Then just hit f11 and start debugging!



## Debugging Tools

* Press P Key to Pause

* Press L Key to start input loop and L key again to lock the loop

* Press Alt + Enter Keys to go full screen



## Troubleshoot



If when trying to build the application, you receive the error "The input line is too long. The syntax of the command is incorrect." make sure to put the project folder as close as possible to C: and if the error persists just restart your cmd.



## Doubts / Learn



* What is Device Independent Bitmap?

* What is raster function?

* Restudy memory in OS and memory allocation in C++

* understand arrow vs point https://www.geeksforgeeks.org/arrow-operator-in-c-c-with-examples/

* Understand pitch and stride https://learn.microsoft.com/pt-br/windows/win32/medfound/image-stride (tutorial 04)

* Chandler Carruth - C++ Compiler Optimization

* Search for XInput (controller api)

* DirectSound is deprecated and replaced by XAudio2

* Search C Runtime Library

* Estudar trigonometria

* the internal declaration on functions is made so that the compiler knows that there is no linkage, everything is compiled in one file

* What is CLANG?

* MMX, SSE and SSE2 Instrinsics

* Intel Intrinsics Guide https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html

* Galois Dream: Gropup theory and differential equations:  https://archive.org/details/galoisdreamgroup0000kuga

* C++ Bit Operations

* Linear Blend https://youtu.be/S2fz4BS2J3Y?si=6gvYyRmn9Sakj2pw

* Raymond Chen - Expert on Windows Platform

* Agner Fog -> www.agner.org has an list of instruction latencies, throughputs and micro-operation breakdowns for Intel, AMD and VIA CPUs

* WolframAlpha

* Templates are bad for debugging so dont use them

* AABB - Axis Aligned Bounding Box

##Vectors

* Chris Hecker -> Indie Game famous developer, has articles etc

* Hadamard Product -> only for colors (we are also using it for chunk dim in meters)

* For moiton, we use Dot Product, Perp Dot Product and Cross Product

* Produto Interno

* For interpolation and Barycentric coordinates: https://caseymuratori.com/blog_0014

* Tip for debugging heap corruption bugs (engine way to allocate memory via arena): Tutorial 76 Q&A

* Collision Mesh

* Constructive Solid Geometry (deprecated) (Brushes) (Quake vs Unreal) -> Better than Polygon Soup (today) because is clearer

what is solid and what is not (Tutorial 79)

* John Carmack -> famous video game programmer

* rigid body dynamics

* Sparse Virtual Textures - Sean Barret https://www.youtube.com/watch?v=MejJL87yNgI&pp=ygUjc3BhcnNlIHZpcnR1YWwgdGV4dHVyZXMgc2VhbiBiYXJyZXQ%3D

* Sean Barret - Premultiplied Alpha

* LRU - Least Recently Used

* SSE vs AVX (For software renderer)

* Rasterization

* Shaders

* Very good blog, and must see the graphics pipeline -> https://fgiesen.wordpress.com/category/graphics-pipeline/

* Performance-Aware Programming Series https://www.computerenhance.com/i/99218768/performance-aware-programming-series

* Texture map and texels

* Subpixel precision

* texture filtering (or linear texture filtering) (we are using simple bilinear filter on texture (on tutorial 93))

* Naughty Dogs 2010 Gamma Correct Rendering -> https://www.slideshare.net/naughty_dog/lighting-shading-by-john-hable - https://www.gdcvault.com/play/1012351/Uncharted-2-HDR

* Livro Physically Based Rendering: From Theory to Implementation - Matt Pharr

* Normal Maps (Lighting)

* Fudge Factor