Skip to content

Commit aaba5f0

Browse files
committed
Formatting and note about mp3 format
1 parent 586951f commit aaba5f0

File tree

3 files changed

+36
-27
lines changed

3 files changed

+36
-27
lines changed

docs/acars/plugins/callbacks.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ will use.
9696
#### Example
9797

9898
```typescript
99-
setup() {
99+
setup()
100+
{
100101
Acars.Set('above_1k', false)
101102
Acars.Set('launched_message', false)
102103
}
@@ -105,7 +106,13 @@ setup() {
105106
### 2. `run()`
106107

107108
```typescript
108-
run(pirep: Pirep, data: Telemetry, previousData?: Telemetry): void
109+
run(pirep
110+
:
111+
Pirep, data
112+
:
113+
Telemetry, previousData ? : Telemetry
114+
):
115+
void
109116
```
110117

111118
#### Purpose
@@ -171,7 +178,17 @@ etc.).
171178
#### Example
172179

173180
```typescript
174-
phaseChange(pirep: Pirep, data: Telemetry, newPhase: PirepState, oldPhase: PirepState) {
181+
phaseChange(pirep
182+
:
183+
Pirep, data
184+
:
185+
Telemetry, newPhase
186+
:
187+
PirepState, oldPhase
188+
:
189+
PirepState
190+
)
191+
{
175192
Acars.AddPirepLog(`Phase changed from ${oldPhase} to ${newPhase}`)
176193

177194
if (newPhase === PirepState.TaxiOut) {
@@ -219,6 +236,6 @@ export default class MyScript implements CallbackHook {
219236

220237
### Sounds
221238

222-
Place your sounds (`mp3` or `wav`) format in the `src/sounds` directory (create
223-
it if it doesn't exist). When you call `Acars.PlayAudio`, it will look in this
224-
directory for them.
239+
Place your sounds, in mp3, 44100hz stereo format in the `src/sounds` directory (
240+
create it if it doesn't exist). When you call `Acars.PlayAudio`, it will look in
241+
this directory for them.

docs/help.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Before asking for help, try to reproduce on the
1414

1515
:::
1616

17-
Without a lot of this information, it will be difficult to provide help.
17+
Without a lot of this information, it will be challenging to provide help.
1818

1919
---
2020

@@ -23,7 +23,7 @@ Without a lot of this information, it will be difficult to provide help.
2323
### Forums
2424

2525
The forums are located at [https://forum.phpvms.net](https://forum.phpvms.net).
26-
Search in the forums and on Github first for your issue before asking. For 3rd
26+
Search in the forums and on GitHub first for your issue before asking. For third
2727
party addons, be sure to post in your own
2828

2929
### Discord
@@ -34,8 +34,8 @@ There's also a Discord channel for quick questions.
3434
### Github
3535

3636
The bug tracker is located on
37-
[Github](https://github.com/nabeelio/phpvms/issues). To post an issue, you need
38-
a Github account, and then select "New Issue". After that, select "Bug Report".
37+
[GitHub](https://github.com/nabeelio/phpvms/issues). To post an issue, you need
38+
a GitHub account, and then select "New Issue." After that, select "Bug Report."
3939
There is a small template there that you can use, but try to include as much of
4040
the information below:
4141

@@ -45,41 +45,41 @@ the information below:
4545

4646
- A clear description of the issue
4747
- What page stuff happened on
48-
- Relevent data
48+
- Relevant data
4949
- Versions
5050
- **PHP Version**
51-
- **Database versions** - MySQL, MariaDB or Percona, or whatever other backend
52-
your running
51+
- **Database versions**MySQL, MariaDB or Percona, or whatever other backend
52+
you're running
5353
- **phpVMS Version**
5454
- From either the admin panel (bottom left, click on the version for the
5555
full version)
5656
- Running `php artisan phpvms:version` ![](img/version.png)
5757
- How to reproduce the error
5858
- Include as much detail as possible
59-
- Include any relevent data - for example, an error with expenses, include how
59+
- Include any relevant datafor example, an error with expenses, include how
6060
the expenses are configured. See "Exporting Data" below.
6161
- Screenshots
62-
- Type of hosting - shared, VPS, dedicated, etc
62+
- Type of hostingshared, VPS, dedicated, etc.
6363

6464
### Logs
6565

6666
- **Laravel logs**: These are located in `storage/logs`, you must include these.
6767
Look through the logs to also ensure that no sensitive information is included
68-
inadvertantly
68+
inadvertently
6969
- **PHP logs**: These can be found wherever your PHP error logs are kept, for
7070
example, the PHP-FPM logs. Ask your host, if you don't know. They're often
7171
found in cPanel, under Error Logs.
7272
- **HTTP logs**: These are, for example, your Apache logs. These might be
7373
required, depending on the issue. If you're not sure how to get them, ask your
7474
host. They're often found in cPanel, under Error Logs.
7575
- Exported data data - see below
76-
- Any and all other relevent details
76+
- Any other relevant details
7777

7878
---
7979

8080
## Enable Debug and Debugging
8181

82-
- Look at the logs - they're located in `storage/logs`
82+
- Look at the logsthey're located in `storage/logs`
8383
- Enable debug logging and the Laravel Debug Toolbar, open your `.env`
8484
- `APP_DEBUG` to `true`
8585
- `DEBUG_TOOLBAR` to `true` (if you want the debug toolbar)
@@ -104,7 +104,7 @@ Before asking for help, make sure to:
104104
- Rescan your scenery (Required for FS9, FSX, P3D and X-Plane)
105105
- If crashing, delete the `data` folder, and restart
106106
- If using MSFS (2020 and/or 2024) be sure your `fsuipc-lvar-module` is up to
107-
date (Also known as FsUipc WASM Module)
107+
date (Also known as FSUIPC WASM Module)
108108

109109
When asking for help:
110110

docusaurus.config.js

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,6 @@ module.exports = {
8585
priority: 0.5,
8686
},
8787
},
88-
'@docusaurus/plugin-ideal-image',
89-
{
90-
quality: 90,
91-
max: 1030, // max resized image's size.
92-
min: 640, // min resized image's size. if original is lower, use that size.
93-
steps: 2, // the max number of images generated between min and max (inclusive)
94-
disableInDev: false,
95-
},
9688
],
9789
],
9890
plugins: [

0 commit comments

Comments
 (0)