├── .gitignore
├── .npmignore
├── README.md
├── example
├── .gitignore
├── README.md
├── package-lock.json
├── package.json
├── public
│ ├── favicon.ico
│ ├── index.html
│ ├── logo192.png
│ ├── logo512.png
│ ├── manifest.json
│ └── robots.txt
└── src
│ ├── App.css
│ ├── App.js
│ ├── index.css
│ └── index.js
├── lib
└── index.js
├── package-lock.json
├── package.json
├── rollup.config.js
├── src
├── hooks
│ ├── index.js
│ ├── useCapsuleCollider.js
│ ├── useCharacterState.js
│ ├── useInputEventManager.js
│ ├── useInputMovementRotation.js
│ ├── useKeyboardMouseMovement.js
│ ├── useRay.js
│ ├── useThirdPersonAnimations.js
│ └── useThirdPersonCameraControls.js
└── index.js
└── yarn.lock
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | example/
2 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # react-three-third-person
2 |
3 | Third person controls for driving a character model inside a `@react-three/fiber` app driven by `@react-three/cannon` physics.
4 |
5 | ## Dependencies
6 |
7 | - `react` v16.14.0 or higher
8 | - `@react-three/fiber` v7.0.26 or higher
9 | - `@react-three/drei` v8.7.3 or higher
10 | - `@react-three/cannon` v6.3.0 or higher
11 |
12 | ## Installation
13 |
14 | ```bash
15 | npm install react-three-third-person
16 | ```
17 |
18 | ## Usage
19 |
20 | ```js
21 | import ThirdPersonCharacterControls from "react-three-third-person";
22 | import { useGLTF } from "@react-three/drei";
23 |
24 | const PATH = "https://yourhost.com/animations";
25 |
26 | const animationPaths = {
27 | idle: `${PATH}/idle.glb`,
28 | walk: `${PATH}/walk.glb`,
29 | run: `${PATH}/run.glb`,
30 | jump: `${PATH}/jump.glb`,
31 | landing: `${PATH}/landing.glb`,
32 | inAir: `${PATH}/falling_idle.glb`,
33 | backpedal: `${PATH}/backpedal.glb`,
34 | turnLeft: `${PATH}/turn_left.glb`,
35 | turnRight: `${PATH}/turn_right.glb`,
36 | strafeLeft: `${PATH}/strafe_left.glb`,
37 | strafeRight: `${PATH}/strafe_right.glb`,
38 | };
39 |
40 | function ThirdPersonCharacter() {
41 | const characterObj = useGLTF(`${PATH}/your_model.glb`);
42 | const characterProps = {
43 | scale: 1.75,
44 | velocity: 8,
45 | radius: 0.5,
46 | };
47 |
48 | return (
49 |
60 | );
61 | }
62 | ```
63 |
64 | ## Configuration
65 |
66 | | Prop | Type | Default | Description |
67 | | -------------- | -------------- | --------- | ------------------------------------------------- |
68 | | cameraOptions | object | {} | configuration object for control's camera options |
69 | | characterProps | object | {} | configuration object for character |
70 | | characterObj | THREE.Object3D | undefined | three.js object for character model |
71 | | animationPaths | object | {} | object for animation clip configuration |
72 | | onLoad | function | () => {} | called when animation clips are done loading |
73 |
74 | #### cameraOptions
75 |
76 | | Prop | Type | Default | Description |
77 | | ------------------- | ------- | ------- | -------------------------------------------------------------------- |
78 | | yOffset | float | 1.6 | amount of y added to the camera following the character model |
79 | | minDistance | float | 0.6 | maximum zoom in capability of camera |
80 | | maxDistance | float | 7 | maximum zoom out capability of camera |
81 | | collisionFilterMask | integer | 2 | the cannon.js group given to "world" objects for collision detection |
82 | | cameraCollisionOn | boolean | off | if turned on, will use colllisionFilterMask to add collision to the camera (experimental and unoptimized) |
83 |
84 | #### characterProps
85 |
86 | | Prop | Type | Default | Description |
87 | | ------------------- | ------- | ------- | -------------------------------------------------------------------- |
88 | | scale | float | 1 | amount to scale the character model |
89 | | radius | float | 0.3 | value used for creating character capsule collider |
90 | | velocity | float | 4 | speed at which character moves |
91 |
92 | #### characterObj
93 |
94 | you can use any model here compatible with the [mixamo](https://www.mixamo.com) rig. For best results, use a model sized to the default mixamo character.
95 |
96 | #### animationPaths
97 |
98 | this prop expects an object with key/value pairs pointing to a complete set of animations to use on your character model. Refer to the object below for the full list of animations needed, all of which are available as free animations on [mixamo](https://www.mixamo.com).
99 |
100 | ```
101 | {
102 | idle: 'idle.glb',
103 | walk: 'walk.glb',
104 | run: 'run.glb',
105 | jump: 'jump.glb',
106 | landing: 'landing.glb',
107 | inAir: 'falling_idle.glb',
108 | backpedal: 'backpedal.glb',
109 | turnLeft: 'turn_left.glb',
110 | turnRight: 'turn_right.glb',
111 | strafeLeft: 'strafe_left.glb',
112 | strafeRight: 'strafe_right.glb',
113 | }
114 | ```
115 |
116 | ## Example App Usage
117 |
118 | ```js
119 | import React from "react";
120 | import ReactDOM from "react-dom/client";
121 | import { Canvas, useThree } from "@react-three/fiber";
122 | import { Physics, useBox } from "@react-three/cannon";
123 | import manny from "manny";
124 | import ThirdPersonCharacterControls from "react-three-third-person";
125 |
126 | const BASE_ANIMATIONS_PATH =
127 | "https://mannys-game.s3.amazonaws.com/third-person/animations";
128 |
129 | const animationPaths = {
130 | idle: `${BASE_ANIMATIONS_PATH}/idle.glb`,
131 | walk: `${BASE_ANIMATIONS_PATH}/walk.glb`,
132 | run: `${BASE_ANIMATIONS_PATH}/run.glb`,
133 | jump: `${BASE_ANIMATIONS_PATH}/jump.glb`,
134 | landing: `${BASE_ANIMATIONS_PATH}/landing.glb`,
135 | inAir: `${BASE_ANIMATIONS_PATH}/falling_idle.glb`,
136 | backpedal: `${BASE_ANIMATIONS_PATH}/backpedal.glb`,
137 | turnLeft: `${BASE_ANIMATIONS_PATH}/turn_left.glb`,
138 | turnRight: `${BASE_ANIMATIONS_PATH}/turn_right.glb`,
139 | strafeLeft: `${BASE_ANIMATIONS_PATH}/strafe_left.glb`,
140 | strafeRight: `${BASE_ANIMATIONS_PATH}/strafe_right.glb`,
141 | };
142 |
143 | function ThirdPersonCharacter() {
144 | const mannyObj = manny();
145 |
146 | return (
147 |
157 | );
158 | }
159 |
160 | function Lighting() {
161 | return (
162 | <>
163 |
168 |
174 |
175 | );
176 | }
177 |
178 | function Floor() {
179 | const [ref] = useBox(() => ({
180 | type: "Static",
181 | args: [25, 0.2, 25],
182 | mass: 0,
183 | material: {
184 | friction: 0,
185 | name: "floor",
186 | },
187 | collisionFilterGroup: 2,
188 | }));
189 | return (
190 |
191 |
192 |
193 |
194 |
195 |
196 |
197 | );
198 | }
199 |
200 | function Wall({ args, ...props }) {
201 | const [ref] = useBox(() => ({
202 | type: "Static",
203 | args,
204 | mass: 0,
205 | material: {
206 | friction: 0.3,
207 | name: "wall",
208 | },
209 | collisionFilterGroup: 2,
210 | ...props,
211 | }));
212 | return (
213 |
214 |
215 |
216 |
217 | );
218 | }
219 |
220 | function App() {
221 | return (
222 |
223 |
250 |
104 |
135 |