mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Finished beginner section
This commit is contained in:
parent
0ae9be49da
commit
92e03522db
77
docs/beginner/ask-for-help.md
Normal file
77
docs/beginner/ask-for-help.md
Normal file
@ -0,0 +1,77 @@
|
||||
---
|
||||
parent: Beginner
|
||||
nav_order: 06
|
||||
---
|
||||
# How to ask for help
|
||||
{: .no_toc }
|
||||
|
||||
1. Table of contents
|
||||
{:toc}
|
||||
|
||||
After you have tried to solve the problem on your own, you can also get help
|
||||
from the community.
|
||||
|
||||
{: .highlight }
|
||||
> But it is important to follow certain rules! Read them below.
|
||||
|
||||
## Communities
|
||||
|
||||
There are two ways to communicate with the community.
|
||||
The fastest way is to use Discord:
|
||||
|
||||
- <https://discord.gg/gj68fm969S>{:target="_blank"}
|
||||
|
||||
But if you don't like Discord, you are able to post in the DCS forum.
|
||||
Check out the MOOSE thread here:
|
||||
|
||||
- <https://forums.eagle.ru/showthread.php?t=138043>
|
||||
|
||||
## How to post requests
|
||||
|
||||
MOOSE is a community project and support is community based.
|
||||
|
||||
Please remember when posting a question:
|
||||
|
||||
- Before posting anything follow the [troubleshooting steps].
|
||||
- **Read your logs**.
|
||||
|
||||
A post should contain the following:
|
||||
|
||||
1. A describtion what you expected to happen and what actually happened.
|
||||
- Do not use vague words this stuff is hard to help with! Be specific.
|
||||
|
||||
2. Describe what happens instead.
|
||||
- The less detail you offer, the less chance you can be helped.
|
||||
- Don’t say it doesn’t work. Or is it broken. Say what it actually does.
|
||||
|
||||
3. Post your code in Discord as formatted code:
|
||||
|
||||
- Wrap a single line of code in backticks \` like this:
|
||||
|
||||

|
||||
|
||||
- Multiple lines of code should be posted like this:
|
||||
|
||||

|
||||
|
||||
- Post your log lines with the error or warning messages. Format them like this:
|
||||
|
||||

|
||||
|
||||
- Some complex problems need the mission (.miz file) also.
|
||||
|
||||
- But post your mission only when requested.
|
||||
- Try to simplify your mission if it is complex!
|
||||
|
||||
There are people in the Discord and in the forum, who spend their free time to
|
||||
help you. <br />
|
||||
It is your responsibility to make their "work" as easy as possible.
|
||||
|
||||
Welcome to MOOSE and good luck!
|
||||
|
||||
## Next step
|
||||
|
||||
Last but not least some [tipps and tricks].
|
||||
|
||||
[troubleshooting steps]: problems.md
|
||||
[tipps and tricks]: tipps-and-tricks.md
|
||||
@ -9,5 +9,50 @@ nav_order: 04
|
||||
1. Table of contents
|
||||
{:toc}
|
||||
|
||||
{: .warning }
|
||||
> THIS DOCUMENT IS STILL WORK IN PROGRESS!
|
||||
The best way to get compftable with a Moose class is to try the demo missions of
|
||||
the class you want to learn. The Moose team created a lot of demo missions for
|
||||
most of the classes.
|
||||
|
||||
## Download demo missions
|
||||
|
||||
Go to the repository [MOOSE_MISSIONS]{:target="_blank"}, search the folder of
|
||||
the class, download the mission (`.miz`) and rum them.
|
||||
|
||||
## Read the mission script
|
||||
|
||||
In the same folder a `.lua` file with the same name is placed which is the
|
||||
included mission script. You can watch these mission scripts easily online at
|
||||
GitHub to understand what is happening in the mission.
|
||||
|
||||
## Read documentation
|
||||
|
||||
Next step is to read the [documentation]{:target="_blank"} of the class to
|
||||
understand the code of the demo mission.
|
||||
|
||||
{: .note }
|
||||
> The documentation is quite long and might be confusing for beginners.
|
||||
> Start by looking at the description at the top of the documentation of a
|
||||
> class. It often contains examples and explanations. <br /><br />
|
||||
> Then search for the function names and look at the description of the
|
||||
> functions and its parameters.
|
||||
|
||||
## Make small changes to the script
|
||||
|
||||
Download the `.lua` file, change the parameters to suit your needs in
|
||||
[Notepad++]{:target="_blank"}, add it to the mission and rerun the mission.
|
||||
Observe what happens and adapt the code.
|
||||
|
||||
If you want to use more functions combine them all up.
|
||||
|
||||
{: .note }
|
||||
> But it is wise to do this in small steps. So it is easier to find errors.
|
||||
|
||||
## Next step
|
||||
|
||||
If the mission shows not the expected behaviour take a look at section
|
||||
[problems].
|
||||
|
||||
[MOOSE_MISSIONS]: https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop
|
||||
[documentation]: https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/index.html
|
||||
[Notepad++]: https://notepad-plus-plus.org/downloads/
|
||||
[problems]: problems.md
|
||||
|
||||
@ -144,9 +144,16 @@ have create everything on your own.
|
||||
- Change the text a little bit, like `Hello Dude! ...` and save the file.
|
||||
- Run the mission again.
|
||||
- The text will not be changed in the mission. Why?
|
||||
|
||||
{: .important }
|
||||
The mission editor copies the script into the mission file when you add it.
|
||||
Ever change on the script file on your hard disk is not recognized by mission editor.
|
||||
You have to add the file after each change again.
|
||||
Every change on the script file on your hard disk is not recognized by mission
|
||||
editor. **You have to add the file after each change again!**
|
||||
|
||||
There is also another method available to dynamically load mission scripts.
|
||||
But this method has some brawbacks and will be explained in the advanced section.
|
||||
|
||||
Now we add the mission script again:
|
||||
|
||||
- On the left side of the `TRIGGERS` dialog click on `Load Mission Script`.
|
||||
- On the right side under `ACTIONS` you need to add the script again:
|
||||
|
||||
46
docs/beginner/problems.md
Normal file
46
docs/beginner/problems.md
Normal file
@ -0,0 +1,46 @@
|
||||
---
|
||||
parent: Beginner
|
||||
nav_order: 05
|
||||
---
|
||||
|
||||
# Problems
|
||||
{: .no_toc }
|
||||
|
||||
1. Table of contents
|
||||
{:toc}
|
||||
|
||||
## Something went wrong
|
||||
|
||||
If the mission shows not the expected behaviour do the following steps:
|
||||
|
||||
1. Double check if you added the changed mission script to the mission again!
|
||||
1. Check if the triggers are configured as requested in the last sections.
|
||||
|
||||
## Read the logs
|
||||
|
||||
The DCS log is a super important and useful log for the entire of DCS World.
|
||||
All scripting and other errors are recorded here. It is the one stop shop for
|
||||
things that occurred in your mission. It will tell you if there was a mistake.
|
||||
|
||||
1. Open the file `dcs.log` in the `Logs` subfolder in your DCS
|
||||
[Saved Games folder].
|
||||
|
||||
1. Search for the following line: `*** MOOSE INCLUDE END ***`
|
||||
- If it is included in the log, Moose was loaded.
|
||||
- If the line is not in the log check the triggers again!
|
||||
|
||||
1. Search for lines with `SCRIPTING` and `WARNING` or `ERROR` and read them.
|
||||
- This might help to find your error.
|
||||
|
||||
{: .note }
|
||||
> You will find a lot of warning and error lines in the log which are not
|
||||
> related to `SCRIPTING`. They are related to stuff from Eagle Dynamics or
|
||||
> Third Parties and you have to ignore them. EA does the same. ;o)
|
||||
|
||||
## Next step
|
||||
|
||||
If you don't find the error and/or don't understand the messages in the log file
|
||||
you can [ask for help].
|
||||
|
||||
[Saved Games folder]: tipps-and-tricks.md#find-the-saved-games-folder
|
||||
[ask for help]: ask-for-help.md
|
||||
@ -33,7 +33,9 @@ This folder can be found in your userprofile as subfolder of `Saved Games`.
|
||||
The easiest way to find it, is to open search and paste the text below into it
|
||||
and press Enter:
|
||||
|
||||
```%userprofile%\Saved Games```
|
||||
```
|
||||
%userprofile%\Saved Games
|
||||
```
|
||||
|
||||
{: .note }
|
||||
> The text will work even if your Windows is installed with another language,
|
||||
|
||||
BIN
docs/images/beginner/discord-fomat-logs.png
Normal file
BIN
docs/images/beginner/discord-fomat-logs.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.6 KiB |
BIN
docs/images/beginner/discord-multi-line-code.png
Normal file
BIN
docs/images/beginner/discord-multi-line-code.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.3 KiB |
BIN
docs/images/beginner/discord-single-line-code.png
Normal file
BIN
docs/images/beginner/discord-single-line-code.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.3 KiB |
Loading…
x
Reference in New Issue
Block a user