Skybox rendering

Readme.md

@@ -96,6 +96,7 @@ Not every version will be perfectly supported but I will try and have the most p
     - [x] Fluids (lava and water)
     - [x] Chunk frustum culling
     - [x] Biome blending (mostly)
+    - [x] [Sky box](https://github.com/stackotter/delta-client/pull/188)
   - [ ] Entities
     - [x] Basic entity rendering (just coloured cubes)
     - [ ] Render entity models

Sources/Client/Config/Config.swift

@@ -4,10 +4,13 @@ import OrderedCollections
 
 /// The client's configuration. Usually stored in a JSON file.
 struct Config: Codable, ClientConfiguration {
+  /// The current config version used by the client.
+  static let currentVersion: Float = 0
+
   /// The config format version. Used to detect outdated config files (and maybe
   /// in future to migrate them). Completely independent from the actual Delta
   /// Client version.
-  var version: Float = 1
+  var version: Float = currentVersion
 
   /// The random token used to identify ourselves to Mojang's API
   var clientToken = UUID().uuidString
@@ -18,7 +21,7 @@ struct Config: Codable, ClientConfiguration {
   /// The user's server list.
   var servers: [ServerDescriptor] = []
   /// Rendering related configuration.
-  var render = RenderConfiguration()
+  var render = RenderConfiguration(enableOrderIndependentTransparency: true)
   /// Plugins that the user has explicitly unloaded.
   var unloadedPlugins: [String] = []
   /// The user's keymap.
@@ -50,6 +53,16 @@ struct Config: Codable, ClientConfiguration {
   /// Loads a configuration from a JSON configuration file.
   static func load(from file: URL) throws -> Config {
     let data = try Data(contentsOf: file)
+    let json = try JSONSerialization.jsonObject(with: data) as? [String: Any]
+
+    guard let version = json?["version"] as? Float else {
+      throw ConfigError.missingVersion
+    }
+
+    guard version == currentVersion else {
+      throw ConfigError.unsupportedVersion(version)
+    }
+
     return try JSONDecoder().decode(Self.self, from: data)
   }
 

Sources/Client/Config/ConfigError.swift

@@ -1,6 +1,10 @@
 import Foundation
 
 public enum ConfigError: LocalizedError {
+  /// The config file is missing a version.
+  case missingVersion
+  /// The config file is using an unsupported version.
+  case unsupportedVersion(Float)
   /// The account in question is of an invalid type.
   case invalidAccountType
   /// No account exists with the given id.
@@ -14,6 +18,11 @@ public enum ConfigError: LocalizedError {
 
   public var errorDescription: String? {
     switch self {
+      case .missingVersion:
+        return "Your config file is missing a 'version' field."
+      case let .unsupportedVersion(version):
+        return "Your config file version (\(version)) is unsupported. " +
+          "\(Config.currentVersion) is the current supported version."
       case .invalidAccountType:
         return "The account in question is of an invalid type."
       case .invalidAccountId:

Sources/Client/Views/Play/MetalView.swift

@@ -27,7 +27,7 @@ struct MetalView {
     mtkView.delegate = renderCoordinator
     mtkView.preferredFramesPerSecond = 10000
     mtkView.framebufferOnly = true
-    mtkView.clearColor = MTLClearColorMake(0, 0, 0, 1) // Clear with black colour
+    mtkView.clearColor = MTLClearColorMake(0, 0, 0, 1)
     mtkView.drawableSize = mtkView.frame.size
     mtkView.depthStencilPixelFormat = .depth32Float
 
@@ -60,7 +60,7 @@ final class MetalViewClass {
     mtkView.delegate = renderCoordinator
     mtkView.preferredFramesPerSecond = 10000
     mtkView.framebufferOnly = true
-    mtkView.clearColor = MTLClearColorMake(0.65, 0.8, 1, 1) // Sky colour
+    mtkView.clearColor = MTLClearColorMake(0, 0, 0, 1)
     mtkView.drawableSize = mtkView.frame.size
     mtkView.depthStencilPixelFormat = .depth32Float
     mtkView.clearDepth = 1.0

Sources/Client/Views/Settings/ControlsSettingsView.swift

@@ -22,8 +22,6 @@ struct ControlsSettingsView: View {
       }
       .frame(width: 450)
 
-      KeymapEditorView()
-
       HStack {
         Text("Toggle sprint").frame(width: 150)
         Spacer()
@@ -53,6 +51,12 @@ struct ControlsSettingsView: View {
         Spacer()
       }
       .frame(width: 400)
+
+      Text("Bindings")
+        .font(.title)
+        .padding(.top, 16)
+
+      KeymapEditorView()
     }
     .onAppear {
       sensitivity = managedConfig.mouseSensitivity

Sources/Client/Views/Settings/KeymapEditorView.swift

@@ -68,6 +68,13 @@ struct KeymapEditorView: View {
     .onKeyRelease { key in
       inputCaptured = false
     }
+
+    Button("Reset bindings to defaults") {
+      managedConfig.keymap.bindings = Keymap.default.bindings
+    }
+    .buttonStyle(SecondaryButtonStyle())
+    .frame(width: 250)
+    .padding(.top, 10)
   }
 
   static func labelColor(isUnique: Bool, isBound: Bool, isSelected: Bool) -> Color {

Sources/Client/Views/Startup/LoadAndThen.swift

@@ -56,13 +56,11 @@ struct LoadAndThen<Content: View>: View {
     do {
       config = try Config.load(from: storage.configFile)
     } catch {
-      modal.error(RichError("Failed to load config; resetting to defaults").becauseOf(error))
+      modal.error(RichError("Failed to load config, using defaults").becauseOf(error))
       config = Config()
-      do {
-        try config.save(to: storage.configFile)
-      } catch {
-        throw RichError("Failed to save new config").becauseOf(error)
-      }
+      // Don't save the new config (wait until the user makes changes). This means that
+      // the user can quit the client and attempt to fix their config without having to
+      // start their config all over again.
     }
 
     let managedConfig = ManagedConfig(config, backedBy: storage.configFile) { error in

Sources/Core/Renderer/Camera/Camera.swift

@@ -5,8 +5,6 @@ import DeltaCore
 
 /// Holds information about a camera to render from.
 public struct Camera {
-  // MARK: Public properties
-
   /// The vertical FOV in radians.
   public private(set) var fovY: Float = 0.5 * .pi // 90deg
   /// The near clipping plane.
@@ -19,12 +17,41 @@ public struct Camera {
   /// The camera's position.
   public private(set) var position: Vec3f = [0, 0, 0]
 
-  /// The camera's rotation around the x axis (pitch). -pi/2 radians is straight up, 0 is straight ahead, and pi/2 radians is straight up.
+  // TODO: Rename xRot and yRot to pitch and yaw when refactoring Camera
+  /// The camera's rotation around the x axis (pitch). -pi/2 radians is straight up,
+  /// 0 is straight ahead, and pi/2 radians is straight down.
   public private(set) var xRot: Float = 0
-  /// The camera's rotation around the y axis measured counter-clockwise from the positive z axis when looking down from above (yaw).
+  /// The camera's rotation around the y axis measured counter-clockwise from the
+  /// positive z axis when looking down from above (yaw).
   public private(set) var yRot: Float = 0
 
-  // MARK: Public computed properties
+  /// The ray defining the camera's position and the direction it faces.
+  public var ray: Ray {
+    Ray(from: position, pitch: xRot, yaw: yRot)
+  }
+
+  // TODO: Rename these matrices to translation, rotation, and projection. Could
+  //   even replace translation and rotation with a single combined `framing`
+  //   matrix if no code ever uses them separately.
+  /// A translation matrix from world-space to player-centered coordinates.
+  public var worldToPlayer: Mat4x4f {
+    MatrixUtil.translationMatrix(-position)
+  }
+
+  /// A rotation matrix from player-centered coordinates to camera-space.
+  public var playerToCamera: Mat4x4f {
+    MatrixUtil.rotationMatrix(y: -(Float.pi + yRot)) * MatrixUtil.rotationMatrix(x: -xRot)
+  }
+
+  /// The projection matrix from camera-space to clip-space.
+  public var cameraToClip: Mat4x4f {
+    MatrixUtil.projectionMatrix(
+      near: nearDistance,
+      far: farDistance,
+      aspect: aspect,
+      fieldOfViewY: fovY
+    )
+  }
 
   /// The camera's position as an entity position.
   public var entityPosition: EntityPosition {
@@ -38,41 +65,45 @@ public struct Camera {
     return (unitVector * rotationMatrix).xyz
   }
 
-  // MARK: Private properties
-
   private var frustum: Frustum?
 
   private var uniformsBuffers: [MTLBuffer] = []
   private var uniformsIndex = 0
   private var uniformsCount = 6
 
-  // MARK: Init
-
   public init(_ device: MTLDevice) throws {
+    // TODO: Multiple-buffering should be implemented separately from the camera. I reckon the
+    //   camera shouldn't have to know about Metal at all, or throw any errors.
     for i in 0..<uniformsCount {
-      guard let buffer = device.makeBuffer(length: MemoryLayout<Uniforms>.stride, options: .storageModeShared) else {
+      guard let buffer = device.makeBuffer(
+        length: MemoryLayout<CameraUniforms>.stride,
+        options: .storageModeShared
+      ) else {
         throw RenderError.failedtoCreateWorldUniformBuffers
       }
-      buffer.label = "dev.stackotter.Camera.uniforms-\(i)"
+      buffer.label = "Camera.uniforms-\(i)"
       uniformsBuffers.append(buffer)
     }
   }
 
-  // MARK: Public methods
-
   /// Update a buffer to contain the current world to clip uniforms.
   public mutating func getUniformsBuffer() -> MTLBuffer {
     let buffer = uniformsBuffers[uniformsIndex]
     uniformsIndex = (uniformsIndex + 1) % uniformsCount
     var uniforms = getUniforms()
-    buffer.contents().copyMemory(from: &uniforms, byteCount: MemoryLayout<Uniforms>.stride)
+    buffer.contents().copyMemory(
+      from: &uniforms,
+      byteCount: MemoryLayout<CameraUniforms>.stride
+    )
     return buffer
   }
 
   /// Get the world to clip uniforms.
-  public mutating func getUniforms() -> Uniforms {
-    let transformation = getFrustum().worldToClip
-    return Uniforms(transformation: transformation)
+  public mutating func getUniforms() -> CameraUniforms {
+    return CameraUniforms(
+      framing: worldToPlayer * playerToCamera,
+      projection: cameraToClip
+    )
   }
 
   /// Sets this camera's vertical FOV. Horizontal FOV is calculated from vertical FOV and aspect ratio.
@@ -119,23 +150,14 @@ public struct Camera {
     yRot = playerLook.yaw
   }
 
-  /// Returns this camera's world space to clip space transformation matrix.
+  // TODO: Make this a computed property
+  /// Returns this camera's world-space to clip-space transformation matrix.
   public func getWorldToClipMatrix() -> Mat4x4f {
-    var worldToCamera = MatrixUtil.translationMatrix(-position) // translation
-    worldToCamera *= MatrixUtil.rotationMatrix(y: -(Float.pi + yRot)) // y rotation
-    worldToCamera *= MatrixUtil.rotationMatrix(x: -xRot) // x rotation
-
-    // perspective projection
-    let cameraToClip = MatrixUtil.projectionMatrix(
-      near: nearDistance,
-      far: farDistance,
-      aspect: aspect,
-      fieldOfViewY: fovY
-    )
-
-    return worldToCamera * cameraToClip
+    return worldToPlayer * playerToCamera * cameraToClip
   }
 
+  // TODO: This whole frustum caching thing seems weird. It can probably just be moved to the usage
+  //   site. i.e. just call computeFrustum once to get the frustum.
   /// Calculates the camera's frustum and saves it. Cached frustum can be fetched via ``getFrustum()``.
   public mutating func cacheFrustum() {
     self.frustum = calculateFrustum()

Sources/Core/Renderer/CameraUniforms.swift

@@ -0,0 +1,13 @@
+import FirebladeMath
+
+public struct CameraUniforms {
+  /// Translation and rotation (sets up the camera's framing).
+  public var framing: Mat4x4f
+  /// The projection converting camera-space coordinates to clip-space coordinates.
+  public var projection: Mat4x4f
+
+  public init(framing: Mat4x4f, projection: Mat4x4f) {
+    self.framing = framing
+    self.projection = projection
+  }
+}

Sources/Core/Renderer/CelestialBodyUniforms.swift

@@ -0,0 +1,14 @@
+import FirebladeMath
+
+public struct CelestialBodyUniforms {
+  public var transformation: Mat4x4f
+  public var textureIndex: UInt16
+  public var uvPosition: Vec2f
+  public var uvSize: Vec2f
+  public var type: CelestialBodyType
+
+  public enum CelestialBodyType: UInt8 {
+    case sun = 0
+    case moon = 1
+  }
+}

Sources/Core/Renderer/Uniforms.swift → Sources/Core/Renderer/ChunkUniforms.swift

@@ -1,7 +1,8 @@
-import Foundation
 import FirebladeMath
 
-public struct Uniforms {
+public struct ChunkUniforms {
+  /// The translation to convert chunk-space coordinates (with origin at the
+  /// lowest, Northmost, Eastmost block of the chunk) to world-space coordinates.
   public var transformation: Mat4x4f
 
   public init(transformation: Mat4x4f) {

Sources/Core/Renderer/EndSkyUniforms.swift

@@ -0,0 +1,6 @@
+import FirebladeMath
+
+struct EndSkyUniforms {
+  var transformation: Mat4x4f
+  var textureIndex: UInt16
+}

Sources/Core/Renderer/EndSkyVertex.swift

@@ -0,0 +1,6 @@
+import FirebladeMath
+
+struct EndSkyVertex {
+  var position: Vec3f
+  var uv: Vec2f
+}

Sources/Core/Renderer/Entity/EntityRenderer.swift

@@ -90,7 +90,7 @@ public struct EntityRenderer: Renderer {
     }
 
     // Get all renderable entities
-    var entityUniforms: [Uniforms] = []
+    var entityUniforms: [EntityUniforms] = []
     client.game.accessNexus { nexus in
       // If the player is in first person view we don't render them
       profiler.push(.getEntities)
@@ -124,7 +124,7 @@ public struct EntityRenderer: Renderer {
 
         let scale: Mat4x4f = MatrixUtil.scalingMatrix(Vec3f(size))
         let translation: Mat4x4f = MatrixUtil.translationMatrix(Vec3f(position))
-        let uniforms = Uniforms(transformation: scale * translation)
+        let uniforms = EntityUniforms(transformation: scale * translation)
         entityUniforms.append(uniforms)
       }
       profiler.pop()
@@ -138,8 +138,8 @@ public struct EntityRenderer: Renderer {
     // more than 64 entities too big. The maximum size limit is imposed so that the buffer isn't too
     // much bigger than necessary. New buffers are always created with room for 32 more entities so
     // that a new buffer isn't created each time an entity is added.
-    let minimumBufferSize = entityUniforms.count * MemoryLayout<Uniforms>.stride
-    let maximumBufferSize = minimumBufferSize + 64 * MemoryLayout<Uniforms>.stride
+    let minimumBufferSize = entityUniforms.count * MemoryLayout<EntityUniforms>.stride
+    let maximumBufferSize = minimumBufferSize + 64 * MemoryLayout<EntityUniforms>.stride
     var instanceUniformsBuffer: MTLBuffer
 
     profiler.push(.getBuffer)
@@ -150,7 +150,7 @@ public struct EntityRenderer: Renderer {
       log.trace("Creating new instance uniforms buffer")
       instanceUniformsBuffer = try MetalUtil.makeBuffer(
         device,
-        length: minimumBufferSize + MemoryLayout<Uniforms>.stride * 32,
+        length: minimumBufferSize + MemoryLayout<EntityUniforms>.stride * 32,
         options: .storageModeShared,
         label: "entityInstanceUniforms"
       )

Sources/Core/Renderer/EntityUniforms.swift

@@ -0,0 +1,11 @@
+import FirebladeMath
+
+public struct EntityUniforms {
+  /// The transformation for an instance of the generic entity hitbox. Scales and
+  /// translates the hitbox to the correct size and world-space position.
+  public var transformation: Mat4x4f
+
+  public init(transformation: Mat4x4f) {
+    self.transformation = transformation
+  }
+}

Sources/Core/Renderer/FogUniforms.swift

@@ -0,0 +1,10 @@
+import FirebladeMath
+
+/// Uniforms used to render distance fog.
+struct FogUniforms {
+  var fogColor: Vec3f
+  var fogStart: Float
+  var fogEnd: Float
+  var fogDensity: Float
+  var isLinear: Bool
+}