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

Improve machine-readable commands #1

Open
Nithanim opened this issue Oct 7, 2020 · 0 comments
Open

Improve machine-readable commands #1

Nithanim opened this issue Oct 7, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@Nithanim
Copy link
Owner

Nithanim commented Oct 7, 2020

To be able to support autocomplete, signature help, hover and other features, it is necessary that information about the various commands the game understands are saved in structured form. Sadly, all documentation is only available in some text form, and sometimes there is even any. Additionally, the documentation is mostly in German but some parts have been translated to English.

WARNING: If you are looking to help, it is strongly encouraged that you know the game very well or even attempted to make a map because a lot of stuff is not very logical. Some stuff has to be tried out in the game to gather information.

As an example of what is needed, you can find all currently "translated" commands in this resources folder. All documentation in text form can be found on the German page for docs about the internal editor.
Here are some links that might have relevant information in them:

The goal/result are special commands that are defined by their first argument. The definition can be found in the corresponding sub-folder.

The target:

  • Fix spelling mistakes in documentation
  • Fix inconsistencies in documentation
  • Add missing documentation
  • Fix errors (there should not be any left, really; warning: sometimes there are errors in the documentation above)
  • To look into: add additional fields for extended insight. Current plan is to look at the parameter name to find out what data is expected (e.g. HumanId, VehicleId, HouseId, ...) but this is a bit flimsy and often the generic term "ObjectId" is used.
@Nithanim Nithanim added documentation Improvements or additions to documentation hacktoberfest labels Oct 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

No branches or pull requests

1 participant