TO HELP UNDERSTAND THE GAME AND HOW THE SCRIPTS/VARIABLES WORK. We will be updating this regularly.
Starting with the Assets folder:
Materials - these are just the basic materials used for the planes, buildings and ground.
Prefabs - this folder splits into both the PaperPlanes & Target Indicators folder. The Target Indicators here are used for the World empty object to see enemy/ally planes.(These get dragged onto the UI Controller scripts for "Target Indicator Prefab".)
Scenes - these are the two scenes for this project file. Once again, I just like to keep my testing files separate from the actual game just to keep things less cluttered and organized. It's also easier on my CPU and allows me to have ONLY what I need in the actual game at all times so I don't get confused lol. Don't worry, I'm working on putting the actual full game file on GitHub as well.
Scripts - this folder splits into the AI Scripts, Collision Avoid(Incomplete), & UI Controller Scripts folders. Read how the scripts works below carefully:
*AI Scripts:* these scripts are the current AI scripts at the moment.(These are added onto the different paper plane prefabs.) Right now the Ally Follow AI script is the main one currently being used and modified. The "Torque" can be adjusted in increments of 1000 to make the AI move faster/sharper. And of course the "Player" on this script is whatever plane prefab desired for the enemy/ally. The E, N, and H Wander AI scripts were my first prototype AI.(E,N, and H stand for Easy, Normal, Hard difficulty.) They basically just wander around, but I had an issue with them going a little too far out of bounds. This could probaby be fixed however with some invisible walls and a Sphere Collider or something, in addition to an Out-Of-Bounds script that I'm working on.
*Collision Avoid(Incomplete):* this folder has both the Ground Boundary & Ground Script. The Ground Boundary script will probably be renamed to Terrain Boundary at some point. It works with Sphere Colliders on the AI planes to keep them from getting stuck on the ground/buildings/terrain. Its not perfected yet however, and I'm still working on it. We will update this once it's finished. The "Player" of course is the plane prefab desired for the AI. The "Smooth" is useless and will be removed, pay it no mind for now. The "Torque" and "Rotation Speed" I've found to be best kept at 800 & 100. And then the Ground Script goes on the actual terrain Prefabs.(Make sure the tag on each terrain is set to "Terrain" or else it won't work at all.)
*UI Controller Scripts:* these UI Controller scripts all go on an empty object called World. This is basically what makes the Target Indicators in the earlier mentioned Prefabs folder show up. I Right-Clicked on the Hierarchy to Create a Canvas. Then on the UI Controller scripts, dragged the Canvas in the Hierarchy to "Canvas", the Main Camera to "Main Camera", and then TargetIndicator(name) Prefab to "Target Indicator Prefab". Make sure these correspond with the correct target names. For example: the "TargetIndicatorEmber" Prefab needs to be on "UIControllerEmber" script, and so on and so forth. This folder also has a "Target Objects" folder. These little scripts are easy to miss, but very important. They are also added to every AI plane with its corresponding name. Example: whichever plane prefab you'd like to be your ally Terra, the "Target Object Terra" script should be on that plane. If you don't have this, the target indicators won't show.
Now that we are done with the script folders, all that's left is the scripts outside of those folders.
The Trail Follow Script: tbh you don't have to pay much attention to this script. Just make sure it is on the empty game object in the Hierarchy.
The Player Final Script: This script is pretty much the bread and butter of the whole game, as it's how the Player controls ALL the planes. This script so far is meant to be used with WASD Keyboard controls, so definitely make sure everything is set up/mapped correctly there. Currently, Spacebar input is the Throttle, and letter key "B" is how you brake. You can press them both at the same time to fly at a slower speed.(I would like to implement a more subtle brake where the "B" key is held down, but not sure how to yet.) You can also coast for about 3 secs if you just let off the Throttle. All the plane prefabs come with preset parameters I want in the game, however feel free to play with the Torque, Thrust, etc just to see how it all works. This is basically how I've given different planes different stats and characteristics. This script also works with Rigidbody so you can also change the Mass and Drag there as well. Just make sure the tag is set to "Player" so that way the script works.
The Follow Cam Script: This is basically how the camera follows the player as you are flying. It goes on Main Camera in the Hierarchy, and the "Target" will always be your plane you're flying. The 3 "Rigs" are basically the different camera angles you can switch to mid-flight. I have it set in the script to toggle them using letter "C" key on your keyboard.(The Rigs are just empty children objects of the planes located within their prefabs.)
Alright! And that's pretty much it for the scripts for now lol.
Sprites - I won't go too much into this folder, it's just the image sprite files for the target indicators. Once you open the project, everything should be right where it needs to be, but if there are issues just let know! Once I put the full game file here, you will also see the mini-map stuff too.
Moving on to the Project folder:
I'm actually not sure if this will work, but as I mentioned ealier, the WASD mapping and setttings are set a certain way for now. Hope this folder allows you to just copy and paste, hopefully it just loads up automatically. You can look at the InputManager.asset file to see my Input settings. This should be useful once we get more into the full game.