CS461-SimulationCapstone
Setup
This Project requires a FREE 3rd party API KEY in order to work CORRECTLY!
- Go to this website and signup
https://developers.nextzen.org/
- Continue with github (use your github account to create an account)
- Once created and signed in, create a new API key
- It should be on this website: https://developers.nextzen.org/keys
- Then go into the cloned repository and create the ".env" file. It should be on the same directory as the "cargo.toml" file.
- In the ".env" assign your newly created API key to a variable called "Nextzen_API"
- It should look somthing like this: Nextzen_API = xxxxxxxxxxxxxxx
- Done
- WARNING: The ".env" file should NEVER be pushed onto the repository
Tutorial
- Type "cargo run" while in the clone directory containing the cargo.toml file
- Click on the play button in the center of the menu screen
Controls
- Pitch controls: W/S
- Roll left/right: Q/E
- Thrust strength: left shift/left ctrl
- Enable flaps: F
- Flap controls: arrow keys
- Lock cursor: space
- Pause: ESC
- Camera control: mouse/scroll wheel
- Enable Directional arrows: G
Future Project Plans
-
Flesh out UI
- Text fonts, visuals, and background in start menu
- visual pause UI when pressing escape
-
Physics
- Make physics more realistic, primarily the lift force
- Give the plane a hitbox and add collisions
-
Customization
- Allow support for changing between different plane models
- Allow customizable physics osetttings
- Allow users to change keybinds
Project Structure
.
├── docs/
├── src/
├── wip/
├── .gitignore
├── LICENSE
└── README.md
The docs/
directory holds documentations
The src/
directory contains codebase.
The wip/
directory contains assignment templates that we will modify/update during the year. You can add more files there that support your project (e.g., diagrams, design files, documents, reviews, progress reports, etc.)