Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Janne252 authored Jul 23, 2020
1 parent f28e073 commit 65889a6
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Intro
This project aims to provide comprehensive intellisense for writing Company of Heroes 2 SCAR scripts.
The project that generates this API documentation is currently not made public as it is incredibly messy due to several iterations and rewrites over the years.

This documentation is generated from 3 sources:
- [ScarDoc released by Relic Entertainment](https://community.companyofheroes.com/discussion/43250/scar-documentation)
- Exported lists of values that exist in the runtime `_G` object
- Custom list of documentation for previously undocumented functions such as `scartype` and all the [UI functions](http://modding.companyofheroes.com/scripting-ui).

> The project that generates this API documentation is currently not made public as it is incredibly messy due to several iterations and rewrites over the years.
- Official [ScarDoc released by Relic Entertainment](https://community.companyofheroes.com/discussion/43250/scar-documentation)
- Exported lists of values that exist in the runtime `_G` table while in a standard multiplayer match context
- Added documentation for previously undocumented functions such as `scartype` and some of the [UI functions](http://modding.companyofheroes.com/scripting-ui).

Currently all symbols are included in the documentation. This includes symbols whose name starts with an underscore `_` or `AE` prefix. The underscore prefixed symbols are likely intended for internal use and the `AE` prefixed are intended to be called from attribute instances via `scar_function_call`.
If a version of this API documentation should be made available without underscore and `AE` prefixed symbols, please open an issue.
Expand All @@ -27,11 +27,9 @@ If a version of this API documentation should be made available without undersco
1. Search for "Lua color mode" and change the setting to `Grammar`
> _As of July 22nd 2020, the VS Code extension `sumneko.lua` does not support Semantic highlighting_.

# Troubleshooting
- Undocumented symbols (function, constant, blueprint such as `SBP.FOO.BAR`, etc.): Please open an issue.
- Error in documentation: Please open an issue.

# Contributing
- Undocumented/missing symbols (function, constant, blueprint such as `SBP.FOO.BAR`, etc.): Please open an issue.
- Error in documentation: Please open an issue.

The vast majority of this API documentation is based on the official [ScarDoc released by Relic Entertainment](https://community.companyofheroes.com/discussion/43250/scar-documentation). Documentation improvements or changes will generally not be accepted for symbols covered by the official ScarDoc. However changes can be considered for clear errors in documentation. Please open an issue after checking the Official ScarDoc documentation.

Expand Down

0 comments on commit 65889a6

Please sign in to comment.