Skip to content

Commit e610ce8

Browse files
authored
Update README.md
1 parent bb71054 commit e610ce8

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,35 @@ Ensure you have the following prerequisites installed:
2020

2121
1. Clone the repo or download the script file directly.
2222
```bash
23-
git clone https://github.com/yourusername/Unity-FirstPersonCamera-Controller.git
23+
git clone https://github.com/XeinTDM/Unity-FirstPersonCamera-Controller.git
24+
```
25+
2. Add the FirstPersonCamera.cs script to your camera object in your Unity project.
26+
3. Assign the necessary public fields in the Unity Inspector, particularly the playerBody and playerCamera.
27+
28+
### Usage
29+
30+
Adjust the public fields in the Unity Inspector to suit your game's needs:
31+
32+
- mouseSensitivity: Sensitivity of the camera's rotation based on mouse movement.
33+
- playerBody: The Transform component of the player's body, for body rotation.
34+
- playerCamera: The Camera component the script is attached to.
35+
- Additional settings for head bobbing, FOV, and camera sway can be adjusted to achieve the desired effect.
36+
37+
### Contributing
38+
39+
Contributions to enhance the FirstPersonCamera script are welcomed. Please follow these steps to contribute:
40+
41+
1. Fork the Project
42+
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
43+
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
44+
4. Push to the Branch (git push origin feature/AmazingFeature)
45+
5. Open a Pull Request
46+
47+
### License
48+
49+
This project is distributed under the MIT License. See the [LICENSE](https://github.com/XeinTDM/Unity-FirstPersonCamera-Controller/blob/main/LICENSE) file for more information.
50+
51+
### Contact
52+
53+
Discord - @xeintdm
54+
Project Link: https://github.com/XeinTDM/Unity-FirstPersonCamera-Controller

0 commit comments

Comments
 (0)