Tutorial

nicklockwood · Jul 27, 2019 · 885e594 · 885e594
1 parent 4340c50
commit 885e594
Show file tree

Hide file tree

Showing 77 changed files with 5,241 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,89 @@
 ## Retro Rampage
 
-This repository contains a code snapshot for the [Retro Rampage tutorial series](https://github.com/nicklockwood/RetroRampage) by Nick Lockwood.
+![Screenshot](Tutorial/Images/MonstersAttacking.png)
+
+### About
+
+Retro Rampage is a tutorial series in which you will learn how to build a Wolfenstein-like game from scratch, in Swift. Initially the game will be targeting iPhone and iPad, but the engine should work on any platform that can run Swift code.
+
+Modern shooters have moved on a bit from Wolfenstein's grid-based 2.5D world, but we're going to stick with that template for a few reasons:
+
+* It's feasible to build Wolfenstein's 3D engine from scratch, without a lot of complicated math and without needing to know anything about GPUs or shaders.
+
+* It's simple to create and visualize maps that are constructed on a 2D grid, avoiding the complexities of 3D modeling and animation tools.
+
+* Tile grids are an excellent way to prototype techniques such as procedural map generation, pathfinding and line-of-sight calculations, which can then be applied to more complex worlds.
+
+### Background
+
+Ever since I first played Wolfenstein 3D on a friend's battered old 386 back in 1993 (the Mac version wasn't released until several years later) I was hooked on the *First-Person Shooter*.
+
+As an aspiring programmer, I wanted to recreate what I had seen. But armed only with 7th grade math and a rudimentary knowledge of BASIC, recreating the state-of-the-art in modern PC 3D graphics was hopelessly beyond my reach.
+
+More than two decades later, a few things have changed:
+
+* Apple has given us (well, sold us) the iPhone - a mobile computer many hundreds of times more powerful than a DOS-era desktop PC.
+
+* Chris Lattner has given us Swift - a simple, powerful programming language with which to write apps and games.
+
+* John Carmack has given us the Wolfenstein source code, and the wizardry behind it has been thoroughly demystified.
+
+I guess now is as good a time as any to scratch that quarter-century itch and build an FPS!
+
+### Tutorials
+
+The tutorials below are designed to be completed in order, and each step builds on the code from the previous one. If you decide to skip ahead, project snapshots for each step are available [here](https://github.com/nicklockwood/RetroRampage/releases).
+
+The tutorials are written with the assumption that you are already familiar with Xcode and are comfortable setting up an iOS project and adding new files to it. No prior knowledge of the Swift language is assumed, so it's fine if you've only used Objective-C or other C-like languages.
+
+[Part 1 - Separation of Concerns](Tutorial/Part1.md)
+
+Unlike most apps, games are (or should be) highly independent of any given platform. Swift has already been ported to many platforms outside of the Apple ecosystem, including Android, Ubuntu, Windows and even Raspberry Pi. In part one we'll see how to set up our project to minimize dependencies with iOS and provide a solid foundation for writing a fully portable game engine.
+
+[Part 2 - Mazes and Motion](Tutorial/Part2.md)
+
+Wolfenstein 3D - despite the name - is really a 2D game projected into the third dimension. The game mechanics work exactly the same as for a top-down 2D shooter, and to prove that we'll start by building the game from a top-down 2D perspective before we make the shift to first-person 3D.
+
+[Part 3 - Ray Casting](Tutorial/Part3.md)
+
+Long before hardware accelerated 3D graphics, some of the greatest game programmers of our generation were creating incredible 3D worlds armed only with a 16-bit processor. We'll follow in their footsteps and bring our game into the third dimension with an old-school graphics hack called *ray casting*.
+
+[Part 4 - Texture Mapping](Tutorial/Part4.md)
+
+In this chapter we'll spruce up the bare walls and floor with *texture mapping*. Texture mapping is the process of painting or *wall-papering* a 3D object with a 2D image, helping to provide the appearance of intricate detail in an otherwise featureless surface.
+
+[Part 5 - Sprites](Tutorial/Part5.md)
+
+It's time to introduce some other characters to keep our player company, and display them using *sprites* - a popular technique used to add engaging content to 3D games in the days before it was possible to render textured polygonal models in real-time with sufficient detail.
+
+[Part 6 - Enemy Action](Tutorial/Part6.md)
+
+Right now the monsters standing in the maze are little more than gruesome scenery. In this part we'll bring those passive monsters to life with collision detection, animations, and artificial intelligence so they can hunt and attack the player.
+
+[Part 7 - Death and Pixels](Tutorial/Part7.md)
+
+In this part we'll implement player damage, giving the monsters the ability to hurt and eventually kill the game's protagonist. We'll explore a variety of damage effects and techniques, including a cool Wolfenstein 3D death animation called *fizzlefade*.
+
+More to follow!
+
+### Acknowledgments
+
+I'd like to thank [Nat Brown](https://github.com/natbro) and [PJ Cook](https://github.com/pjcook) for their invaluable feedback on the first draft of these tutorials.
+
+Thanks also to [Lode Vandevenne](https://github.com/lvandeve) and [Fabien Sanglard](https://github.com/fabiensanglard/), whom I've never actually spoken to, but whose brilliant explanations of ray casting and the Wolfenstein engine formed both the basis and inspiration for this tutorial series.
+
+### Further Reading
+
+If you've completed the tutorials and are eager to learn more, here are some resources you might find useful:
+
+* [Lode's Raycasting Tutorial](https://lodev.org/cgtutor/raycasting.html#Introduction) - A great tutorial on ray casting, implemented in C++.
+* [Game Engine Black Book: Wolfenstein 3D](https://www.amazon.co.uk/gp/product/1727646703/ref=as_li_tl?ie=UTF8&camp=1634&creative=6738&creativeASIN=1727646703&linkCode=as2&tag=charcoaldesig-21&linkId=aab5d43499c96f7417b7aa0a7b3e587d) - Fabien Sanglard's excellent book about the Wolfenstein 3D game engine.
+* [Swiftenstein](https://github.com/nicklockwood/Swiftenstein) - A more complete but less polished implementation of the ideas covered in this tutorial.
+* [Handmade Hero](https://handmadehero.org) - A video series in which games industry veteran [Casey Muratori](https://github.com/cmuratori) builds a game from scratch in C.
+
+### Tip Jar
+
+I started this tutorial series thinking it would take just a few days. Nearly two months later, with no end in sight, I realize I may have been a bit naive. If you've found it interesting, please consider donating to my caffeine fund.
+
+[![Donate via PayPal](https://www.paypalobjects.com/en_GB/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CR6YX6DLRNJTY&source=url)
+
diff --git a/Tutorial/Images/Architecture.png b/Tutorial/Images/Architecture.png
diff --git a/Tutorial/Images/AttackAnimation.png b/Tutorial/Images/AttackAnimation.png
diff --git a/Tutorial/Images/BigPixelFizzle.png b/Tutorial/Images/BigPixelFizzle.png
diff --git a/Tutorial/Images/BlackSpriteBackground.png b/Tutorial/Images/BlackSpriteBackground.png
diff --git a/Tutorial/Images/BlendColorCrash.png b/Tutorial/Images/BlendColorCrash.png
diff --git a/Tutorial/Images/BlurryBluePixel.png b/Tutorial/Images/BlurryBluePixel.png
diff --git a/Tutorial/Images/ClearSpriteBackground.png b/Tutorial/Images/ClearSpriteBackground.png
diff --git a/Tutorial/Images/CollisionLoop.png b/Tutorial/Images/CollisionLoop.png
diff --git a/Tutorial/Images/CollisionResponse.png b/Tutorial/Images/CollisionResponse.png
diff --git a/Tutorial/Images/CurvedWalls.png b/Tutorial/Images/CurvedWalls.png
diff --git a/Tutorial/Images/DeathEffectTimeline.png b/Tutorial/Images/DeathEffectTimeline.png
diff --git a/Tutorial/Images/DraggableJoystick.png b/Tutorial/Images/DraggableJoystick.png
diff --git a/Tutorial/Images/EasingCurves.png b/Tutorial/Images/EasingCurves.png
diff --git a/Tutorial/Images/FieldOfView.png b/Tutorial/Images/FieldOfView.png
diff --git a/Tutorial/Images/FizzleFade.png b/Tutorial/Images/FizzleFade.png
diff --git a/Tutorial/Images/FloatingJoystick.png b/Tutorial/Images/FloatingJoystick.png
diff --git a/Tutorial/Images/ImprovedTextureTrace.png b/Tutorial/Images/ImprovedTextureTrace.png
diff --git a/Tutorial/Images/Lighting.png b/Tutorial/Images/Lighting.png
diff --git a/Tutorial/Images/LineDrawing.png b/Tutorial/Images/LineDrawing.png
diff --git a/Tutorial/Images/LineOfSight.png b/Tutorial/Images/LineOfSight.png
diff --git a/Tutorial/Images/MonsterInWall.png b/Tutorial/Images/MonsterInWall.png
diff --git a/Tutorial/Images/MonsterInWall2.png b/Tutorial/Images/MonsterInWall2.png
diff --git a/Tutorial/Images/MonsterMob.png b/Tutorial/Images/MonsterMob.png
diff --git a/Tutorial/Images/MonsterSprite.png b/Tutorial/Images/MonsterSprite.png
diff --git a/Tutorial/Images/MonstersAttacking.png b/Tutorial/Images/MonstersAttacking.png
diff --git a/Tutorial/Images/PerspectiveView.png b/Tutorial/Images/PerspectiveView.png
diff --git a/Tutorial/Images/ProjectStructure.png b/Tutorial/Images/ProjectStructure.png
diff --git a/Tutorial/Images/Pythagoras.png b/Tutorial/Images/Pythagoras.png
diff --git a/Tutorial/Images/RayFan.png b/Tutorial/Images/RayFan.png
diff --git a/Tutorial/Images/RayLengths.png b/Tutorial/Images/RayLengths.png
diff --git a/Tutorial/Images/RayTileIntersection.png b/Tutorial/Images/RayTileIntersection.png
diff --git a/Tutorial/Images/RedFlashEffect.png b/Tutorial/Images/RedFlashEffect.png
diff --git a/Tutorial/Images/RedSpriteBackground.png b/Tutorial/Images/RedSpriteBackground.png
diff --git a/Tutorial/Images/ReleaseMode.png b/Tutorial/Images/ReleaseMode.png
diff --git a/Tutorial/Images/RoundingErrors.png b/Tutorial/Images/RoundingErrors.png
diff --git a/Tutorial/Images/SharpBluePixel.png b/Tutorial/Images/SharpBluePixel.png
diff --git a/Tutorial/Images/SlopeIntercept.png b/Tutorial/Images/SlopeIntercept.png
diff --git a/Tutorial/Images/SmoothedDeathEffect.png b/Tutorial/Images/SmoothedDeathEffect.png
diff --git a/Tutorial/Images/SolidFloorColor.png b/Tutorial/Images/SolidFloorColor.png
diff --git a/Tutorial/Images/SortedSprites.png b/Tutorial/Images/SortedSprites.png
diff --git a/Tutorial/Images/SpriteBehindPlayer.png b/Tutorial/Images/SpriteBehindPlayer.png
diff --git a/Tutorial/Images/SpriteLines.png b/Tutorial/Images/SpriteLines.png
diff --git a/Tutorial/Images/SpriteOrderBug.png b/Tutorial/Images/SpriteOrderBug.png
diff --git a/Tutorial/Images/SpriteRadius.png b/Tutorial/Images/SpriteRadius.png
diff --git a/Tutorial/Images/SpriteRayBug.png b/Tutorial/Images/SpriteRayBug.png
diff --git a/Tutorial/Images/SpriteRayIntersection.png b/Tutorial/Images/SpriteRayIntersection.png
diff --git a/Tutorial/Images/StagedResponse.png b/Tutorial/Images/StagedResponse.png
diff --git a/Tutorial/Images/StateMachine.png b/Tutorial/Images/StateMachine.png
diff --git a/Tutorial/Images/StraightWalls.png b/Tutorial/Images/StraightWalls.png
diff --git a/Tutorial/Images/StretchedWalls.png b/Tutorial/Images/StretchedWalls.png
diff --git a/Tutorial/Images/TextureLookupTrace.png b/Tutorial/Images/TextureLookupTrace.png
diff --git a/Tutorial/Images/TextureMapping.png b/Tutorial/Images/TextureMapping.png
diff --git a/Tutorial/Images/TextureSmearing.png b/Tutorial/Images/TextureSmearing.png
diff --git a/Tutorial/Images/TextureVariants.png b/Tutorial/Images/TextureVariants.png
diff --git a/Tutorial/Images/TexturedCeiling.png b/Tutorial/Images/TexturedCeiling.png
diff --git a/Tutorial/Images/TexturedFloor.png b/Tutorial/Images/TexturedFloor.png
diff --git a/Tutorial/Images/TexturesAndLighting.png b/Tutorial/Images/TexturesAndLighting.png
diff --git a/Tutorial/Images/TileEdgeHit.png b/Tutorial/Images/TileEdgeHit.png
diff --git a/Tutorial/Images/TileSteps.png b/Tutorial/Images/TileSteps.png
diff --git a/Tutorial/Images/Tilemap.png b/Tutorial/Images/Tilemap.png
diff --git a/Tutorial/Images/VariedTextures.png b/Tutorial/Images/VariedTextures.png
diff --git a/Tutorial/Images/ViewFrustum.png b/Tutorial/Images/ViewFrustum.png
diff --git a/Tutorial/Images/ViewPlane.png b/Tutorial/Images/ViewPlane.png
diff --git a/Tutorial/Images/WalkingFrames.png b/Tutorial/Images/WalkingFrames.png
diff --git a/Tutorial/Images/WallCollisions.png b/Tutorial/Images/WallCollisions.png
diff --git a/Tutorial/Images/WallDistance.png b/Tutorial/Images/WallDistance.png
diff --git a/Tutorial/Images/WallHit.png b/Tutorial/Images/WallHit.png
diff --git a/Tutorial/Images/WallTexture.png b/Tutorial/Images/WallTexture.png
diff --git a/Tutorial/Images/WolfensteinSprites.png b/Tutorial/Images/WolfensteinSprites.png