Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,28 @@ The third iteration of the Advanced Cockpit Emulator.
## Recommended IDE Setup for development

- [VS Code](https://code.visualstudio.com) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)


## Creating New Project

1. Project Name : The project name is simply the name you want to give to the project, for exemple `A380X`.
2. Project Root : It is the root of youre project it will also contain the `.ace` directory wich contains the project simvars, ... (exemple for the A380X: `/fbw-a380x/`)
3. Instruments : The instruments directory contains multiple subdirectories for each instruments. (exemple for the A380X: `/fbw-a380x/src/systems/instruments/src/`)
4. Bundles : Bundles directory is generated as a side-effect of your build system. If you use rollup or webpack, you'll have to configure it by yourself, a simpler option is mach where it is done automaticlly. (exemple for the A380X (the FBW builder generates a bundles directory by default): `/fbw-a380x/bundles`)
5. HTML_UI : Wherever you throw in the files for the MSFS virtual file system. This is the directory used for resource GET requests such as fonts loaded with the url function. (exemple for the A380X: `/fbw-A380X/out/`)

## Configuring the Instruments

The config.json of your instruments should look like this
```bash
{
"index": "./instrument.tsx",
"name": "MFD",
"dimensions": {
"width": 1536,
"height": 1024
},
"isInteractive": true
}
```
(exemple from the A380X MFD config.json)