Skip to content

Commit 3251e90

Browse files
authored
Merge pull request #14 from humble-barnacle001/patch-1
Update README.md
2 parents 1541f03 + bc99b9e commit 3251e90

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ To most accurately simulate the effects of special relativity using our toolkit,
3333

3434
We have set up this project with a few basic settings that are meant to make our code base work smoothly. First, under Render Settings, we have the skybox's shader. This shader is slightly different from the one on every other object, and it also determines the basic texture of the sky. We do not work with anything other than solid colors, but if you would like to experiment with a more interesting texture on the skybox, feel free to do so. Next, under the Project Settings/Tags, we have a custom tag of "Playermesh" and a custom layer "Player." The Playermesh tag is used to access the top level player object, which contains the player's mesh and physical information. The Player layer is used to denote which objects should collide with the player. We currently have the Project Settings/Physics collision layers set up so that objects collide only with objects denoted "Player" and not with other objects in the scene. There is one exception to this, in the Receiver object, but that will be covered later. Apart from this, the scene is as it should be normally.
3535

36-
###The Player
36+
### The Player
3737

3838
The player is already set up with our movement code, game state code, and a quick script that puts the speed of light and player speed on the screen. It is set up as a nested object. The player mesh is the parent object, which has the physical aspects of the player. It has a mesh renderer, a collider, and a rigidbody. Each of these components is necessary for our code base. Any of these attributes can be modified, but if the rigidbody's drag, gravity, or frozen rotation settings are changed, the project will no longer adhere to the rules of special relativity and it may react unpredictably with our code, so please don't change these settings unless you know what you're doing. If you wish to change the player's mesh, that won't cause any problems, but keep in mind that this framework was meant to provide a first-person view of relativity, and anything but a first person view will no longer be physically accurate.
3939

4040
At the second level, we have the Player gameobject, which is where we keep the code. There are three pieces of code on the player character. Movement Scripts takes care of the player's movement, the camera's movement, and the change in the speed of light by user input. Game State keeps track of many important variables for the relativistic effects, and controls pausing and ending the game.
4141

4242
Finally, we have the camera. The camera does not have any scripts on it, but is affected by Movement Scripts and must be attached to the player or else the perspective will be off.
4343

44-
###Other Objects
44+
### Other Objects
4545

4646
By a few simple steps, any object can be added to the scene of Open Relativity. These steps mostly consist of adding the following components to your new object.
4747

@@ -99,7 +99,7 @@ This is the receiver side of the objects that create new moving characters. The
9999

100100
The Sender script is the other half of the objects that create moving characters. It takes the name of a prefab in the Resources/Gameobjects folder, time interval, a velocity, and a receiver's transform. On start up it will point the object to look at the receiver, and at every interval specified will create a new Moving Person object. The Moving Person object will then move with a velocity specified in the Sender Script until it hits the Receiver2 object.
101101

102-
##Prefabs
102+
## Prefabs
103103

104104
### Receiver
105105

@@ -146,10 +146,10 @@ The controls are as follows:
146146

147147
## License
148148

149-
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
149+
This project is licensed under the MIT License - see the [LICENSE](MITLicense.md) file for details
150150

151151
## Acknowledgments
152152

153153
Thank you to Gerd Kortemeyer and the MIT Game Lab for their contribution and instruction on this project.
154154

155-
Thanks to users tyoc213, matthewh806, and sethwoodworth for contributing to the repo!
155+
Thanks to users tyoc213, matthewh806, and sethwoodworth for contributing to the repo!

0 commit comments

Comments
 (0)