OpenKCC Netcode

This project is a sample of the Open Kinematic Character Controller. A Kinematic Character Controller (KCC) provides a way to control a character avatar as a kinematic object that will interact with the environment.

OpenKCC is an open source project hosted at https://github.com/nicholas-maltbie/OpenKCC

This is an open source project licensed under a MIT License. Feel free to use a build of the project for your own work. If you see an error in the project or have any suggestions, write an issue or make a pull request, I'll happy include any suggestions or ideas into the project.

You can see a demo of the project running here: https://nickmaltbie.com/OpenKCC/NetcodeExample.

The project hosted on the website is up to date with the most recent version on the main branch of this github repo and is automatically deployed with each update to the codebase.

Installation

If you wish to install the project via a Scoped Registry and npm, you can add a scoped registry to your project from all of the com.nickmaltbie packages like this:

"scopedRegistries": [
  {
    "name": "nickmaltbie",
    "url": "https://registry.npmjs.org",
    "scopes": [
      "com.nickmaltbie"
    ]
  }
]

Then, if you want to reference a version of the project, you simply need to include the dependency with a version string and the unity package manager will be able to download it from the registry at https://registry.npmjs.org

"dependencies": {
  "com.nickmaltbie.openkcc": "1.3.0",
  "com.nickmaltbie.openkcc.netcode": "1.0.1",
  "com.nickmaltbie.statemachineunity.netcode": "1.2.1",
    "com.unity.netcode.gameobjects": "1.1.0"
}

Tests

If you wish to include the testing code for this project, make sure to add the required projects to the testables of the project manifest.

"testables": [
  "com.nickmaltbie.openkcc",
  "com.nickmaltbie.openkcc.netcode",
  "com.nickmaltbie.testutilsunity",
  "com.unity.inputsystem",
  "com.unity.netcode.gameobjects"
]

Demo

You can see a demo of the project running here: https://nickmaltbie.com/OpenKCC/NetcodeExample. The project hosted on the website is up to date with the most recent version on the main branch of this github repo and is automatically deployed with each update to the codebase.

Samples

The samples in the project include:

• ExampleFirstPersonKCC - Example first person character controller with a basic test scene.
• Mole KCC Sample Character - Example mole character controller for moving around and climbing on objects.

Required packages for samples that are not already included in the project:

{
  "scopedRegistries": [
    {
      "name": "nickmaltbie",
      "url": "https://registry.npmjs.org",
      "scopes": [
        "com.nickmaltbie"
      ]
    }
  ],
  "dependencies": {
    "com.nickmaltbie.recolorshaderunity": "1.0.0",
    "com.unity.inputsystem": "1.4.4",
    "com.nickmaltbie.testutilsunity": "1.0.0",
    "com.unity.netcode.gameobjects": "1.1.0",
    "com.unity.probuilder": "5.0.6"
  }
}

Documentation

Documentation on the project and scripting API is found at https://nickmaltbie.com/OpenKCC/docs/ for the latest version of the codebase.