-
-
Notifications
You must be signed in to change notification settings - Fork 385
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding editor.txt #5737
Adding editor.txt #5737
Conversation
Added a short overview for the system editor and updated the modelviewer section with the changes.
editor.txt
Outdated
|
||
Usage: | ||
~~~~~~ | ||
editor -system |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
editor --system
- while it might technically function with a single hyphen here (for backwards compatibility with the modelviewer flag), POSIX style requires the use of two hyphens when the flag contains more than a single character and thus I make no guarantees this remains compatible.
I would suggest removing Modelviewer.txt completely. |
Okay, will do |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should also mention that the editor binary logs to editor.txt instead of output.txt
editor.txt
Outdated
<model> - name of the model defined in lua | ||
|
||
Example: | ||
./editor -mv interdictor |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For symmetry, I'd suggest
Example:
./editor --modelviewer
./editor -mv interdictor
Come to think of it, does passing model name as argument work anymore? (just tried with Dome1
, and cargo
to no avail).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, seems like it does not
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Easier to change documentation than the code :)
(Classic example: "map is wrong, the giant rock is on the wrong side of the road" - move rock to where map said)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should be able to run editor --modelviewer=<modelname>
, supporting the editor -mv <modelname>
case is something that I can restore support for.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That closes the editor immedietelly, after flashing the window for a sec
I've copied over the modelviewer help from the modelviewer.txt, to editor.txt for easier discoverability.
Also added a short overview for the system editor.
I've kept the modelviewer.txt in place for those who are used to the old pioneer -mv way, with a short text about its new home.
Fixes #5736 (In a sense :P )