PalicoEngine

main

Star

Metal-Based Game Engine in Swift 🐑

game-engine game-dev swift metal hazel

Palico Engine: Metal-Based Game Engine in Swift 🐑

Implement a game engine on macOS using Metal API. Still in development. Currently I am working on a more capable entity-component-system MothECS :)

Palico - It is a cat-like combat companion in Monster Hunter!

Palico Engine's Sprint Board on Jira (need permission request). Currently there are 65 issues in total!

🔧 Install & Run

# Clone
git clone https://github.com/forkercat/PalicoEngine.git
cd PalicoEngine

# Compile
swift build

# Run
swift run Editor

📝 User Guide

Mouse Controls:

Command + Left: Rotate camera
Right: Look around
Middle: Pan
Scroll: Zoom in/out

Keyboard Controls:

Tab: Select next in-scene object
F: Focus on object
Q: No action
W: Translate
E: Rotate
R: Scale

Create GameObject:

🍻 Dependencies

dependencies: [
    .package(url: "https://github.com/forkercat/OhMyLog.git", .branch("main")),
    .package(url: "https://github.com/forkercat/MathLib.git", .branch("main")),
    .package(url: "https://github.com/forkercat/MothECS.git", .branch("main")),
    .package(url: "https://github.com/forkercat/SwiftImGui.git", .branch("update-1.86-docking")),  // forked from @ctreffs
    .package(url: "https://github.com/forkercat/SwiftImGuizmo.git", .branch("master")),            // forked from @ctreffs
],

Thanks to SwiftImGui by @ctreffs I am able to use ImGui in this application.

I forked the repository and wrapped ImGui v1.86 and added new OSX backend file. Related PRs:

Update to 1.86 and update OSX backend (fix keyboard issue) #7
Update ImGui 1.86-docking #8

🥺 Future Development

Rendering:

Add skybox
Add shadow
Support PBR
Support deferred rendering (render pass has already been setup)

Model:

Load 3D models
Load textures in models
Load animation

Other:

Improve MothECS
Integrate ImGuizmo
Property/Inspector panel
Game object selection
Scene loading (yaml)
Content browser (Asset Panel)

🙏 Reference

Started by following game engine turotial series by TheCherno and wrote implementation in C++. Also check out Hazel Engine repository. It is a great learning resource!

Metal by Tutorial by Caroline Begbie & Marius Horga
ImGui on GitHub: ocornut/imgui, cimgui/cimgui, ctreffs/SwiftImGui
More to be added!

Description

Swift Tools 5.3.0

Description

{
  "name": "PalicoEngine",
  "path": "/usr/src/package",
  "targets": [
    {
      "name": "Palico",
      "path": "Sources/Palico",
      "type": "library",
      "c99name": "Palico",
      "sources": [
        "Core/Application.swift",
        "Core/Console.swift",
        "Core/Layer.swift",
        "Core/Log.swift",
        "Core/PlatformContext.swift",
        "Core/Time.swift",
        "Core/Window.swift",
        "Event/AppEvent.swift",
        "Event/Event.swift",
        "Event/KeyEvent.swift",
        "Event/MouseEvent.swift",
        "ImGui/Backends/imgui_impl_metal.swift",
        "ImGui/Backends/imgui_impl_osx.swift",
        "ImGui/Backends/imgui_shaders.swift",
        "ImGui/ImGui+Extra.swift",
        "ImGui/ImGuiBackend+Cocoa.swift",
        "ImGui/ImGuiBackend+Metal.swift",
        "ImGui/ImGuiBackend.swift",
        "ImGui/ImGuiFontLibrary.swift",
        "ImGui/ImGuiLayer.swift",
        "ImGui/ImGuiTheme.swift",
        "ImGui/ImGuizmo+Enum.swift",
        "Input/Input.swift",
        "Input/KeyCode.swift",
        "Input/MouseCode.swift",
        "Platform/Cocoa/CocoaContext.swift",
        "Platform/Cocoa/CocoaInput.swift",
        "Platform/Cocoa/CocoaWindow+Callback.swift",
        "Platform/Cocoa/CocoaWindow+Event.swift",
        "Platform/Cocoa/CocoaWindow+View.swift",
        "Platform/Cocoa/CocoaWindow.swift",
        "Platform/Cocoa/ViewController.swift",
        "Platform/GLFW/GlfwContext.swift",
        "Platform/GLFW/GlfwInput.swift",
        "Platform/GLFW/GlfwWindow.swift",
        "Renderer/Camera.swift",
        "Renderer/Color.swift",
        "Renderer/EditorCamera.swift",
        "Renderer/Light.swift",
        "Renderer/Mesh.swift",
        "Renderer/MetalContext.swift",
        "Renderer/PipelineStatePool.swift",
        "Renderer/RenderPass+Action.swift",
        "Renderer/RenderPass.swift",
        "Renderer/RenderPassPool.swift",
        "Renderer/Renderer.swift",
        "Renderer/Shader.swift",
        "Renderer/ShaderDataBridge.swift",
        "Renderer/ShaderLibrary.swift",
        "Renderer/TextureUtils.swift",
        "Scene/Component+Camera.swift",
        "Scene/Component+Light.swift",
        "Scene/Component+MeshRenderer.swift",
        "Scene/Component+Script.swift",
        "Scene/Component+Tag.swift",
        "Scene/Component+Transform.swift",
        "Scene/Component.swift",
        "Scene/GameObject.swift",
        "Scene/Primitive.swift",
        "Scene/Scene+Object.swift",
        "Scene/Scene+View.swift",
        "Scene/Scene.swift",
        "Scene/SceneCamera.swift",
        "Scene/SceneLight.swift",
        "Script/NativeScript.swift",
        "Utils/FAIconEnum.swift",
        "Utils/FileUtils.swift"
      ],
      "resources": [
        {
          "path": "/usr/src/package/Sources/Palico/Assets",
          "rule": {
            "copy": {}
          }
        }
      ],
      "module_type": "SwiftTarget",
      "product_memberships": [
        "Palico",
        "Editor",
        "Example"
      ],
      "product_dependencies": [
        "OhMyLog",
        "MathLib",
        "MothECS",
        "ImGui",
        "ImGuizmo"
      ]
    },
    {
      "name": "Example",
      "path": "Sources/Example",
      "type": "executable",
      "c99name": "Example",
      "sources": [
        "main.swift"
      ],
      "module_type": "SwiftTarget",
      "product_memberships": [
        "Example"
      ],
      "target_dependencies": [
        "Palico"
      ],
      "product_dependencies": [
        "OhMyLog",
        "MathLib",
        "MothECS",
        "ImGui",
        "ImGuizmo"
      ]
    },
    {
      "name": "Editor",
      "path": "Sources/Editor",
      "type": "executable",
      "c99name": "Editor",
      "sources": [
        "Editor.swift",
        "EditorLayer.swift",
        "Log.swift",
        "Panels/AssetPanel.swift",
        "Panels/ConsolePanel.swift",
        "Panels/DrawControls.swift",
        "Panels/ImGuiDemoPanel.swift",
        "Panels/Panel.swift",
        "Panels/ScenePanel+Hierarchy.swift",
        "Panels/ScenePanel+Inspector.swift",
        "Panels/ScenePanel.swift",
        "Panels/ViewportPanel.swift",
        "Scripts/RotateScript.swift",
        "Utils/FileUtils.swift",
        "main.swift"
      ],
      "resources": [
        {
          "path": "/usr/src/package/Sources/Editor/Assets",
          "rule": {
            "copy": {}
          }
        }
      ],
      "module_type": "SwiftTarget",
      "product_memberships": [
        "Editor"
      ],
      "target_dependencies": [
        "Palico"
      ],
      "product_dependencies": [
        "OhMyLog",
        "MathLib",
        "MothECS",
        "ImGui",
        "ImGuizmo"
      ]
    }
  ],
  "products": [
    {
      "name": "Palico",
      "type": {
        "library": [
          "automatic"
        ]
      },
      "targets": [
        "Palico"
      ]
    },
    {
      "name": "Editor",
      "type": {
        "executable": null
      },
      "targets": [
        "Editor"
      ]
    },
    {
      "name": "Example",
      "type": {
        "executable": null
      },
      "targets": [
        "Example"
      ]
    }
  ],
  "platforms": [
    {
      "name": "macos",
      "version": "11.0"
    }
  ],
  "dependencies": [
    {
      "url": "https://github.com/forkercat/OhMyLog.git",
      "type": "sourceControl",
      "identity": "ohmylog",
      "requirement": {
        "branch": [
          "main"
        ]
      }
    },
    {
      "url": "https://github.com/forkercat/MathLib.git",
      "type": "sourceControl",
      "identity": "mathlib",
      "requirement": {
        "branch": [
          "main"
        ]
      }
    },
    {
      "url": "https://github.com/forkercat/MothECS.git",
      "type": "sourceControl",
      "identity": "mothecs",
      "requirement": {
        "branch": [
          "main"
        ]
      }
    },
    {
      "url": "https://github.com/forkercat/SwiftImGui.git",
      "type": "sourceControl",
      "identity": "swiftimgui",
      "requirement": {
        "branch": [
          "update-1.86-docking"
        ]
      }
    },
    {
      "url": "https://github.com/forkercat/SwiftImGuizmo.git",
      "type": "sourceControl",
      "identity": "swiftimguizmo",
      "requirement": {
        "branch": [
          "master"
        ]
      }
    }
  ],
  "tools_version": "5.3",
  "manifest_display_name": "PalicoEngine"
}

View More Packages from this Author

Package Dump

{
  "name": "PalicoEngine",
  "targets": [
    {
      "name": "Palico",
      "type": "regular",
      "exclude": [
        "Platform/GLFW/README.md"
      ],
      "settings": [],
      "resources": [
        {
          "path": "Assets",
          "rule": {
            "copy": {}
          }
        }
      ],
      "dependencies": [
        {
          "product": [
            "OhMyLog",
            "OhMyLog",
            null,
            null
          ]
        },
        {
          "product": [
            "MathLib",
            "MathLib",
            null,
            null
          ]
        },
        {
          "product": [
            "MothECS",
            "MothECS",
            null,
            null
          ]
        },
        {
          "product": [
            "ImGui",
            "SwiftImGui",
            null,
            null
          ]
        },
        {
          "product": [
            "ImGuizmo",
            "SwiftImGuizmo",
            null,
            null
          ]
        }
      ],
      "packageAccess": false
    },
    {
      "name": "Editor",
      "type": "regular",
      "exclude": [],
      "settings": [],
      "resources": [
        {
          "path": "Assets",
          "rule": {
            "copy": {}
          }
        }
      ],
      "dependencies": [
        {
          "product": [
            "OhMyLog",
            "OhMyLog",
            null,
            null
          ]
        },
        {
          "product": [
            "MathLib",
            "MathLib",
            null,
            null
          ]
        },
        {
          "product": [
            "MothECS",
            "MothECS",
            null,
            null
          ]
        },
        {
          "product": [
            "ImGui",
            "SwiftImGui",
            null,
            null
          ]
        },
        {
          "product": [
            "ImGuizmo",
            "SwiftImGuizmo",
            null,
            null
          ]
        },
        {
          "byName": [
            "Palico",
            null
          ]
        }
      ],
      "packageAccess": false
    },
    {
      "name": "Example",
      "type": "regular",
      "exclude": [],
      "settings": [],
      "resources": [],
      "dependencies": [
        {
          "product": [
            "OhMyLog",
            "OhMyLog",
            null,
            null
          ]
        },
        {
          "product": [
            "MathLib",
            "MathLib",
            null,
            null
          ]
        },
        {
          "product": [
            "MothECS",
            "MothECS",
            null,
            null
          ]
        },
        {
          "product": [
            "ImGui",
            "SwiftImGui",
            null,
            null
          ]
        },
        {
          "product": [
            "ImGuizmo",
            "SwiftImGuizmo",
            null,
            null
          ]
        },
        {
          "byName": [
            "Palico",
            null
          ]
        }
      ],
      "packageAccess": false
    }
  ],
  "products": [
    {
      "name": "Palico",
      "type": {
        "library": [
          "automatic"
        ]
      },
      "targets": [
        "Palico"
      ]
    },
    {
      "name": "Editor",
      "type": {
        "executable": null
      },
      "targets": [
        "Editor"
      ]
    },
    {
      "name": "Example",
      "type": {
        "executable": null
      },
      "targets": [
        "Example"
      ]
    }
  ],
  "pkgConfig": null,
  "platforms": [
    {
      "options": [],
      "version": "11.0",
      "platformName": "macos"
    }
  ],
  "providers": null,
  "packageKind": {
    "root": [
      "/usr/src/package"
    ]
  },
  "dependencies": [
    {
      "sourceControl": [
        {
          "identity": "ohmylog",
          "location": {
            "remote": [
              {
                "urlString": "https://github.com/forkercat/OhMyLog.git"
              }
            ]
          },
          "requirement": {
            "branch": [
              "main"
            ]
          },
          "productFilter": null
        }
      ]
    },
    {
      "sourceControl": [
        {
          "identity": "mathlib",
          "location": {
            "remote": [
              {
                "urlString": "https://github.com/forkercat/MathLib.git"
              }
            ]
          },
          "requirement": {
            "branch": [
              "main"
            ]
          },
          "productFilter": null
        }
      ]
    },
    {
      "sourceControl": [
        {
          "identity": "mothecs",
          "location": {
            "remote": [
              {
                "urlString": "https://github.com/forkercat/MothECS.git"
              }
            ]
          },
          "requirement": {
            "branch": [
              "main"
            ]
          },
          "productFilter": null
        }
      ]
    },
    {
      "sourceControl": [
        {
          "identity": "swiftimgui",
          "location": {
            "remote": [
              {
                "urlString": "https://github.com/forkercat/SwiftImGui.git"
              }
            ]
          },
          "requirement": {
            "branch": [
              "update-1.86-docking"
            ]
          },
          "productFilter": null
        }
      ]
    },
    {
      "sourceControl": [
        {
          "identity": "swiftimguizmo",
          "location": {
            "remote": [
              {
                "urlString": "https://github.com/forkercat/SwiftImGuizmo.git"
              }
            ]
          },
          "requirement": {
            "branch": [
              "master"
            ]
          },
          "productFilter": null
        }
      ]
    }
  ],
  "toolsVersion": {
    "_version": "5.3.0"
  },
  "cLanguageStandard": null,
  "cxxLanguageStandard": null,
  "swiftLanguageVersions": null
}

Dependencies

OhMyLogunspecified
MathLibunspecified
MothECSunspecified
ImGuiunspecified
ImGuizmounspecified

Dependencies

{
  "url": "/usr/src/package",
  "name": "PalicoEngine",
  "path": "/usr/src/package",
  "version": "unspecified",
  "identity": "package",
  "dependencies": [
    {
      "url": "https://github.com/forkercat/OhMyLog.git",
      "name": "OhMyLog",
      "path": "/usr/src/package/.build/checkouts/OhMyLog",
      "version": "unspecified",
      "identity": "ohmylog",
      "dependencies": []
    },
    {
      "url": "https://github.com/forkercat/MathLib.git",
      "name": "MathLib",
      "path": "/usr/src/package/.build/checkouts/MathLib",
      "version": "unspecified",
      "identity": "mathlib",
      "dependencies": []
    },
    {
      "url": "https://github.com/forkercat/MothECS.git",
      "name": "MothECS",
      "path": "/usr/src/package/.build/checkouts/MothECS",
      "version": "unspecified",
      "identity": "mothecs",
      "dependencies": []
    },
    {
      "url": "https://github.com/forkercat/SwiftImGui.git",
      "name": "ImGui",
      "path": "/usr/src/package/.build/checkouts/SwiftImGui",
      "version": "unspecified",
      "identity": "swiftimgui",
      "dependencies": []
    },
    {
      "url": "https://github.com/forkercat/SwiftImGuizmo.git",
      "name": "ImGuizmo",
      "path": "/usr/src/package/.build/checkouts/SwiftImGuizmo",
      "version": "unspecified",
      "identity": "swiftimguizmo",
      "dependencies": [
        {
          "url": "https://github.com/forkercat/SwiftImGui.git",
          "name": "ImGui",
          "path": "/usr/src/package/.build/checkouts/SwiftImGui",
          "version": "unspecified",
          "identity": "swiftimgui",
          "dependencies": []
        }
      ]
    }
  ]
}

Last updated: Fri Oct 18 2024 02:31:11 GMT-0900 (Hawaii-Aleutian Daylight Time)