Skip to content
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

Merged
merged 4 commits into from
Feb 7, 2024
Merged

Adding editor.txt #5737

merged 4 commits into from
Feb 7, 2024

Conversation

bszlrd
Copy link
Contributor

@bszlrd bszlrd commented Feb 3, 2024

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 )

Added a short overview for the system editor and updated the modelviewer section with the changes.
editor.txt Outdated

Usage:
~~~~~~
editor -system
Copy link
Member

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.

@impaktor
Copy link
Member

impaktor commented Feb 4, 2024

I would suggest removing Modelviewer.txt completely.

@bszlrd
Copy link
Contributor Author

bszlrd commented Feb 4, 2024

Okay, will do

Copy link
Member

@impaktor impaktor left a 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
Copy link
Member

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).

Copy link
Contributor Author

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

Copy link
Member

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)

Copy link
Member

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.

Copy link
Contributor Author

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

@sturnclaw sturnclaw merged commit 7334462 into pioneerspacesim:master Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

couldn't run a editor
3 participants