From beb609ce81d05eb8f37be3c5e36cd5269c39c825 Mon Sep 17 00:00:00 2001 From: Mustafa Alperen Seki Date: Thu, 12 Oct 2023 16:21:26 +0300 Subject: [PATCH] SDK Update for release-20231010. --- .editorconfig | 843 ++++++++++++++++++++++++++--- .github/workflows/ci.yml | 10 +- .github/workflows/packaging.yml | 3 + .vscode/extensions.json | 9 + .vscode/launch.json | 30 + .vscode/tasks.json | 37 ++ Makefile | 13 +- launch-dedicated.cmd | 5 +- launch-dedicated.sh | 38 +- make.ps1 | 5 +- packaging/windows/buildpackage.nsi | 4 - packaging/windows/buildpackage.sh | 14 +- 12 files changed, 905 insertions(+), 106 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 .vscode/launch.json create mode 100644 .vscode/tasks.json diff --git a/.editorconfig b/.editorconfig index aa72961..a64f570 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,24 +8,440 @@ end_of_line = LF insert_final_newline = true trim_trailing_whitespace = true -; 4-column tab indentation and .NET coding conventions -[*.cs] +; 4-column tab indentation +[*.{cs,csproj,yaml,lua,sh,ps1}] indent_style = tab indent_size = 4 -dotnet_separate_import_directive_groups = false -dotnet_sort_system_directives_first = true +; .NET coding conventions +#### Code Style Rules +#### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ + +# Severity Levels: https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-options#severity-level +# Below we enable specific rules by setting severity to warning. +# Rules are disabled by setting severity to silent (to still allow use in IDE) or none (to prevent all use). +# Rules are listed below with any options available. +# Options are commented out if they match the defaults. + +### Language Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/language-rules + +## this and Me preferences + +# IDE0003/IDE0009 Remove 'this' or 'Me' qualification/Add 'this' or 'Me' qualification +#dotnet_style_qualification_for_field = false +#dotnet_style_qualification_for_property = false +#dotnet_style_qualification_for_method = false +#dotnet_style_qualification_for_event = false +dotnet_diagnostic.IDE0003.severity = warning +dotnet_diagnostic.IDE0009.severity = warning + +## Use languages keywords for types + +# IDE0049 Use language keywords instead of framework type names for type references +#dotnet_style_predefined_type_for_locals_parameters_members = true +#dotnet_style_predefined_type_for_member_access = true +dotnet_diagnostic.IDE0049.severity = warning + +## Modifier preferences + +# IDE0036 Order modifiers +#csharp_preferred_modifier_order = public, private, protected, internal, file, static, extern, new, virtual, abstract, sealed, override, readonly, unsafe, required, volatile, async +dotnet_diagnostic.IDE0036.severity = warning + +# IDE0040 Add accessibility modifiers +dotnet_style_require_accessibility_modifiers = omit_if_default +dotnet_diagnostic.IDE0040.severity = warning + +# IDE0044 Add readonly modifier +#dotnet_style_readonly_field = true +dotnet_diagnostic.IDE0044.severity = warning + +# IDE0062 Make local function static +#csharp_prefer_static_local_function = true +dotnet_diagnostic.IDE0062.severity = warning + +# IDE0064 Make struct fields writable +# No options +dotnet_diagnostic.IDE0064.severity = warning + +## Parentheses preferences + +# IDE0047/IDE0048 Remove unnecessary parentheses/Add parentheses for clarity +dotnet_style_parentheses_in_arithmetic_binary_operators = never_if_unnecessary +dotnet_style_parentheses_in_relational_binary_operators = never_if_unnecessary +#dotnet_style_parentheses_in_other_binary_operators = always_for_clarity +#dotnet_style_parentheses_in_other_operators = never_if_unnecessary +dotnet_diagnostic.IDE0047.severity = warning +dotnet_diagnostic.IDE0048.severity = warning + +## Expression-level preferences + +# IDE0010 Add missing cases to switch statement +# No options +dotnet_diagnostic.IDE0010.severity = silent + +# IDE0017 Use object initializers +#dotnet_style_object_initializer = true +dotnet_diagnostic.IDE0017.severity = warning + +# IDE0018 Inline variable declaration +#csharp_style_inlined_variable_declaration = true +dotnet_diagnostic.IDE0018.severity = warning + +# IDE0028 Use collection initializers +#dotnet_style_collection_initializer = true +dotnet_diagnostic.IDE0028.severity = warning + +# IDE0032 Use auto-implemented property +#dotnet_style_prefer_auto_properties = true +dotnet_diagnostic.IDE0032.severity = warning + +# IDE0033 Use explicitly provided tuple name +#dotnet_style_explicit_tuple_names = true +dotnet_diagnostic.IDE0033.severity = warning + +# IDE0034 Simplify 'default' expression +#csharp_prefer_simple_default_expression = true +dotnet_diagnostic.IDE0034.severity = warning + +# IDE0037 Use inferred member name +#dotnet_style_prefer_inferred_tuple_names = true +#dotnet_style_prefer_inferred_anonymous_type_member_names = true +dotnet_diagnostic.IDE0037.severity = silent + +# IDE0039 Use local function instead of lambda +#csharp_style_prefer_local_over_anonymous_function = true +dotnet_diagnostic.IDE0039.severity = warning + +# IDE0042 Deconstruct variable declaration +#csharp_style_deconstructed_variable_declaration = true +dotnet_diagnostic.IDE0042.severity = warning + +# IDE0045 Use conditional expression for assignment +#dotnet_style_prefer_conditional_expression_over_assignment = true +dotnet_diagnostic.IDE0045.severity = silent + +# IDE0046 Use conditional expression for return +#dotnet_style_prefer_conditional_expression_over_return = true +dotnet_diagnostic.IDE0046.severity = silent + +# IDE0050 Convert anonymous type to tuple +# No options +dotnet_diagnostic.IDE0050.severity = silent + +# IDE0054/IDE0074 Use compound assignment/Use coalesce compound assignment +#dotnet_style_prefer_compound_assignment = true +dotnet_diagnostic.IDE0054.severity = warning +dotnet_diagnostic.IDE0074.severity = warning + +# IDE0056 Use index operator +#csharp_style_prefer_index_operator = true +dotnet_diagnostic.IDE0056.severity = warning + +# IDE0057 Use range operator +#csharp_style_prefer_range_operator = true +dotnet_diagnostic.IDE0057.severity = warning + +# IDE0070 Use 'System.HashCode.Combine' +# No options +dotnet_diagnostic.IDE0070.severity = warning + +# IDE0071 Simplify interpolation +#dotnet_style_prefer_simplified_interpolation = true +dotnet_diagnostic.IDE0071.severity = warning + +# IDE0072 Add missing cases to switch expression +# No options +dotnet_diagnostic.IDE0072.severity = silent + +# IDE0075 Simplify conditional expression +#dotnet_style_prefer_simplified_boolean_expressions = true +dotnet_diagnostic.IDE0075.severity = warning + +# IDE0082 Convert 'typeof' to 'nameof' +# No options +dotnet_diagnostic.IDE0082.severity = warning + +# IDE0090 Simplify 'new' expression +#csharp_style_implicit_object_creation_when_type_is_apparent = true +dotnet_diagnostic.IDE0090.severity = warning + +# IDE0180 Use tuple to swap values +#csharp_style_prefer_tuple_swap = true +dotnet_diagnostic.IDE0180.severity = warning + +## Namespace declaration preferences + +# IDE0160/IDE0161 Use block-scoped namespace/Use file-scoped namespace +#csharp_style_namespace_declarations = block_scoped +dotnet_diagnostic.IDE0160.severity = warning +dotnet_diagnostic.IDE0161.severity = warning + +## Null-checking preferences + +# IDE0016 Use throw expression +#csharp_style_throw_expression = true +dotnet_diagnostic.IDE0016.severity = silent + +# IDE0029/IDE0030/IDE0270 Use coalesce expression (non-nullable types)/Use coalesce expression (nullable types)/Use coalesce expression (if null) +#dotnet_style_coalesce_expression = true +dotnet_diagnostic.IDE0029.severity = warning +dotnet_diagnostic.IDE0030.severity = warning +dotnet_diagnostic.IDE0270.severity = silent + +# IDE0031 Use null propagation +#dotnet_style_null_propagation = true +dotnet_diagnostic.IDE0031.severity = warning + +# IDE0041 Use 'is null' check +#dotnet_style_prefer_is_null_check_over_reference_equality_method = true +dotnet_diagnostic.IDE0041.severity = warning + +# IDE0150 Prefer 'null' check over type check +#csharp_style_prefer_null_check_over_type_check = true +dotnet_diagnostic.IDE0150.severity = warning + +# IDE1005 Use conditional delegate call +csharp_style_conditional_delegate_call = true # true is the default, but the rule is not triggered if this is not specified. +dotnet_diagnostic.IDE1005.severity = warning + +## var preferences + +# IDE0007/IDE0008 Use 'var' instead of explicit type/Use explicit type instead of 'var' +csharp_style_var_for_built_in_types = true +csharp_style_var_when_type_is_apparent = true +csharp_style_var_elsewhere = true +dotnet_diagnostic.IDE0007.severity = warning +dotnet_diagnostic.IDE0008.severity = warning + +## Expression-bodied-members + +# IDE0021 Use expression body for constructors +#csharp_style_expression_bodied_constructors = false +dotnet_diagnostic.IDE0021.severity = silent + +# IDE0022 Use expression body for methods +#csharp_style_expression_bodied_methods = false +dotnet_diagnostic.IDE0022.severity = silent + +# IDE0023/IDE0024 Use expression body for conversion operators/Use expression body for operators +#csharp_style_expression_bodied_operators = false +dotnet_diagnostic.IDE0023.severity = silent +dotnet_diagnostic.IDE0024.severity = silent + +# IDE0025 Use expression body for properties +#csharp_style_expression_bodied_properties = true +dotnet_diagnostic.IDE0025.severity = silent + +# IDE0026 Use expression body for indexers +#csharp_style_expression_bodied_indexers = true +dotnet_diagnostic.IDE0026.severity = silent + +# IDE0027 Use expression body for accessors +#csharp_style_expression_bodied_accessors = true +dotnet_diagnostic.IDE0027.severity = warning + +# IDE0053 Use expression body for lambdas +# This rule is buggy and not enforced for builds. ':warning' will at least enforce it in the IDE. +csharp_style_expression_bodied_lambdas = when_on_single_line:warning +dotnet_diagnostic.IDE0053.severity = warning + +# IDE0061 Use expression body for local functions +csharp_style_expression_bodied_local_functions = when_on_single_line +dotnet_diagnostic.IDE0061.severity = warning + +## Pattern matching preferences + +# IDE0019 Use pattern matching to avoid 'as' followed by a 'null' check +#csharp_style_pattern_matching_over_as_with_null_check = true +dotnet_diagnostic.IDE0019.severity = warning + +# IDE0020/IDE0038 Use pattern matching to avoid 'is' check followed by a cast (with variable)/Use pattern matching to avoid 'is' check followed by a cast (without variable) +#csharp_style_pattern_matching_over_is_with_cast_check = true +dotnet_diagnostic.IDE0020.severity = warning +dotnet_diagnostic.IDE0038.severity = warning + +# IDE0066 Use switch expression +#csharp_style_prefer_switch_expression = true +dotnet_diagnostic.IDE0066.severity = silent + +# IDE0078 Use pattern matching +#csharp_style_prefer_pattern_matching = true +dotnet_diagnostic.IDE0078.severity = silent + +# IDE0083 Use pattern matching ('not' operator) +#csharp_style_prefer_not_pattern = true +dotnet_diagnostic.IDE0083.severity = warning + +# IDE0170 Simplify property pattern +#csharp_style_prefer_extended_property_pattern = true +dotnet_diagnostic.IDE0170.severity = silent # Requires C# 10 + +## Code block preferences + +# IDE0011 Add braces +#csharp_prefer_braces = true +# No options match the style used in OpenRA. +dotnet_diagnostic.IDE0011.severity = none + +# IDE0063 Use simple 'using' statement +#csharp_prefer_simple_using_statement = true +dotnet_diagnostic.IDE0063.severity = silent + +## 'using' directive preferences + +# IDE0065 'using' directive placement +#csharp_using_directive_placement = outside_namespace +dotnet_diagnostic.IDE0065.severity = silent + +## File header preferences + +# IDE0073 Require file header +#file_header_template = unset +# This rule does not allow us to enforce our desired header, as it prefixes the header lines with // comments, meaning we can't apply a region. +dotnet_diagnostic.IDE0073.severity = none + +## Namespace naming preferences + +# IDE0130 Namespace does not match folder structure +#dotnet_style_namespace_match_folder = true +# This rule doesn't appear to work (never reports violations) +dotnet_diagnostic.IDE0130.severity = none + +### Unnecessary Code Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/unnecessary-code-rules + +# IDE0001 Simplify name +# No options +dotnet_diagnostic.IDE0001.severity = warning -csharp_style_var_elsewhere = true:suggestion -csharp_style_var_for_built_in_types = true:suggestion -csharp_style_var_when_type_is_apparent = true:suggestion +# IDE0002 Simplify member access +# No options +dotnet_diagnostic.IDE0002.severity = warning -csharp_prefer_braces = when_multiline:suggestion -csharp_using_directive_placement = outside_namespace:suggestion -csharp_new_line_before_open_brace = all -csharp_space_around_binary_operators = before_and_after +# IDE0004 Remove unnecessary cast +# No options +dotnet_diagnostic.IDE0004.severity = warning -## Naming styles: +# IDE0005 Remove unnecessary import +# No options +# IDE0005 is only enabled in the IDE by default. https://github.com/dotnet/roslyn/issues/41640 +# To enable it for builds outside the IDE the 'GenerateDocumentationFile' property must be enabled on the build. +# GenerateDocumentationFile generates additional warnings about XML docs, so disable any we don't care about. +dotnet_diagnostic.CS1591.severity = none # Missing XML comment for publicly visible type or member +dotnet_diagnostic.IDE0005.severity = warning + +# IDE0035 Remove unreachable code +# No options +# Duplicates compiler warning CS0162 +dotnet_diagnostic.IDE0035.severity = none + +# IDE0051 Remove unused private member +# No options +dotnet_diagnostic.IDE0051.severity = warning + +# IDE0052 Remove unread private member +# No options +dotnet_diagnostic.IDE0052.severity = warning + +# IDE0058 Remove unnecessary expression value +#csharp_style_unused_value_expression_statement_preference = discard_variable +dotnet_diagnostic.IDE0058.severity = silent + +# IDE0059 Remove unnecessary value assignment +#csharp_style_unused_value_assignment_preference = discard_variable +dotnet_diagnostic.IDE0059.severity = warning + +# IDE0060 Remove unused parameter +dotnet_code_quality_unused_parameters = non_public +dotnet_diagnostic.IDE0060.severity = warning + +# IDE0079 Remove unnecessary suppression +#dotnet_remove_unnecessary_suppression_exclusions = none +dotnet_diagnostic.IDE0079.severity = warning + +# IDE0080 Remove unnecessary suppression operator +# No options +dotnet_diagnostic.IDE0080.severity = warning + +# IDE0100 Remove unnecessary equality operator +# No options +dotnet_diagnostic.IDE0100.severity = warning + +# IDE0110 Remove unnecessary discard +# No options +dotnet_diagnostic.IDE0110.severity = warning + +### Miscellaneous Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/miscellaneous-rules + +# IDE0076 Remove invalid global 'SuppressMessageAttribute' +# No options +dotnet_diagnostic.IDE0076.severity = warning + +# IDE0077 Avoid legacy format target in global 'SuppressMessageAttribute' +# No options +dotnet_diagnostic.IDE0077.severity = warning + +### Formatting Rules (IDE0055) +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0055 + +# We may eventually wish to enforce this rule, however some existing formatting conflicts with the rule despite being reasonable. +# Additionally, the rule is buggy and likes to report spuriously after invoking Format Document in the IDE. +dotnet_diagnostic.IDE0055.severity = none + +#dotnet_sort_system_directives_first = true +#dotnet_separate_import_directive_groups = false +#dotnet_style_namespace_match_folder = true + +#csharp_new_line_before_open_brace = all +#csharp_new_line_before_else = true +#csharp_new_line_before_catch = true +#csharp_new_line_before_finally = true +#csharp_new_line_before_members_in_object_initializers = true +#csharp_new_line_before_members_in_anonymous_types = true +#csharp_new_line_between_query_expression_clauses = true + +#csharp_indent_case_contents = true +#csharp_indent_switch_labels = true +#csharp_indent_labels = one_less_than_current +#csharp_indent_block_contents = true +#csharp_indent_braces = false +#csharp_indent_case_contents_when_block = true + +#csharp_space_after_cast = false +#csharp_space_after_keywords_in_control_flow_statements = true +#csharp_space_between_parentheses = +#csharp_space_before_colon_in_inheritance_clause = true +#csharp_space_after_colon_in_inheritance_clause = true +#csharp_space_around_binary_operators = before_and_after +#csharp_space_between_method_declaration_parameter_list_parentheses = false +#csharp_space_between_method_declaration_empty_parameter_list_parentheses = false +#csharp_space_between_method_declaration_name_and_open_parenthesis = false +#csharp_space_between_method_call_parameter_list_parentheses = false +#csharp_space_between_method_call_empty_parameter_list_parentheses = false +#csharp_space_between_method_call_name_and_opening_parenthesis = false +#csharp_space_after_comma = true +#csharp_space_before_comma = false +#csharp_space_after_dot = false +#csharp_space_before_dot = false +#csharp_space_after_semicolon_in_for_statement = true +#csharp_space_before_semicolon_in_for_statement = false +#csharp_space_around_declaration_statements = false +#csharp_space_before_open_square_brackets = false +#csharp_space_between_empty_square_brackets = false +#csharp_space_between_square_brackets = false + +#csharp_preserve_single_line_statements = true +#csharp_preserve_single_line_blocks = true + + +### Naming Rules (IDE1006) +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/naming-rules +dotnet_diagnostic.IDE1006.severity = warning + +## Naming styles dotnet_naming_style.camel_case.capitalization = camel_case @@ -34,7 +450,7 @@ dotnet_naming_style.pascal_case.capitalization = pascal_case dotnet_naming_style.i_prefix_pascal_case.capitalization = pascal_case dotnet_naming_style.i_prefix_pascal_case.required_prefix = I -## Symbol specifications: +## Naming Symbols dotnet_naming_symbols.const_locals.applicable_kinds = local dotnet_naming_symbols.const_locals.applicable_accessibilities = * @@ -64,7 +480,7 @@ dotnet_naming_symbols.parameters_and_locals.applicable_accessibilities = * dotnet_naming_symbols.most_symbols.applicable_kinds = namespace, class, struct, enum, field, property, method, local_function, event, delegate, type_parameter dotnet_naming_symbols.most_symbols.applicable_accessibilities = * -## Naming rules: +## Naming Rules dotnet_naming_rule.const_locals_should_be_pascal_case.symbols = const_locals dotnet_naming_rule.const_locals_should_be_pascal_case.style = pascal_case @@ -98,89 +514,378 @@ dotnet_naming_rule.most_symbols_should_be_pascal_case.symbols = most_symbols dotnet_naming_rule.most_symbols_should_be_pascal_case.style = pascal_case dotnet_naming_rule.most_symbols_should_be_pascal_case.severity = warning -## Formatting: -# Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly. -csharp_space_after_colon_in_inheritance_clause = true +### StyleCop.Analyzers +### https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/DOCUMENTATION.md + +# Below we enable rule categories by setting severity to warning. +# We'll only list rules to disable. +# Individual rules we wish to disable are typically set to none severity. + +# Covers SAxxxx and SXxxxx rules +dotnet_analyzer_diagnostic.category-StyleCop.CSharp.DocumentationRules.severity = warning +dotnet_analyzer_diagnostic.category-StyleCop.CSharp.LayoutRules.severity = warning +dotnet_analyzer_diagnostic.category-StyleCop.CSharp.MaintainabilityRules.severity = warning +dotnet_analyzer_diagnostic.category-StyleCop.CSharp.NamingRules.severity = warning +dotnet_analyzer_diagnostic.category-StyleCop.CSharp.OrderingRules.severity = warning +dotnet_analyzer_diagnostic.category-StyleCop.CSharp.ReadabilityRules.severity = warning +dotnet_analyzer_diagnostic.category-StyleCop.CSharp.SpacingRules.severity = warning +dotnet_analyzer_diagnostic.category-StyleCop.CSharp.SpecialRules.severity = warning + +# Rules that are covered by IDE0001 Simplify name +dotnet_diagnostic.SA1125.severity = none # UseShorthandForNullableTypes + +# Rules that are covered by IDE0047 Remove unnecessary parentheses +dotnet_diagnostic.SA1119.severity = none # StatementMustNotUseUnnecessaryParenthesis + +# Rules that are covered by IDE0055 Formatting Rules +dotnet_diagnostic.SA1027.severity = none # UseTabsCorrectly + +# Rules that are covered by IDE1006 Naming Rules +dotnet_diagnostic.SA1300.severity = none # ElementMustBeginWithUpperCaseLetter +dotnet_diagnostic.SA1302.severity = none # InterfaceNamesMustBeginWithI +dotnet_diagnostic.SA1303.severity = none # ConstFieldNamesMustBeginWithUpperCaseLetter +dotnet_diagnostic.SA1304.severity = none # NonPrivateReadonlyFieldsMustBeginWithUpperCaseLetter +dotnet_diagnostic.SA1306.severity = none # FieldNamesMustBeginWithLowerCaseLetter +dotnet_diagnostic.SA1307.severity = none # AccessibleFieldsMustBeginWithUpperCaseLetter +dotnet_diagnostic.SA1311.severity = none # StaticReadonlyFieldsMustBeginWithUpperCaseLetter +dotnet_diagnostic.SA1312.severity = none # VariableNamesMustBeginWithLowerCaseLetter +dotnet_diagnostic.SA1313.severity = none # ParameterNamesMustBeginWithLowerCaseLetter + +# Rules that conflict with OpenRA project style conventions +dotnet_diagnostic.SA1101.severity = none # PrefixLocalCallsWithThis +dotnet_diagnostic.SA1107.severity = none # CodeMustNotContainMultipleStatementsOnOneLine +dotnet_diagnostic.SA1116.severity = none # SplitParametersMustStartOnLineAfterDeclaration +dotnet_diagnostic.SA1117.severity = none # ParametersMustBeOnSameLineOrSeparateLines +dotnet_diagnostic.SA1118.severity = none # ParameterMustNotSpanMultipleLines +dotnet_diagnostic.SA1122.severity = none # UseStringEmptyForEmptyStrings +dotnet_diagnostic.SA1124.severity = none # DoNotUseRegions +dotnet_diagnostic.SA1127.severity = none # GenericTypeConstraintsMustBeOnOwnLine +dotnet_diagnostic.SA1132.severity = none # DoNotCombineFields +dotnet_diagnostic.SA1135.severity = none # UsingDirectivesMustBeQualified +dotnet_diagnostic.SA1136.severity = none # EnumValuesShouldBeOnSeparateLines +dotnet_diagnostic.SA1200.severity = none # UsingDirectivesMustBePlacedCorrectly +dotnet_diagnostic.SA1201.severity = none # ElementsMustAppearInTheCorrectOrder +dotnet_diagnostic.SA1202.severity = none # ElementsMustBeOrderedByAccess +dotnet_diagnostic.SA1204.severity = none # StaticElementsMustAppearBeforeInstanceElements +dotnet_diagnostic.SA1214.severity = none # ReadonlyElementsMustAppearBeforeNonReadonlyElements +dotnet_diagnostic.SX1309.severity = none # FieldNamesMustBeginWithUnderscore +dotnet_diagnostic.SX1309S.severity = none # StaticFieldNamesMustBeginWithUnderscore +dotnet_diagnostic.SA1314.severity = none # TypeParameterNamesMustBeginWithT +dotnet_diagnostic.SA1400.severity = none # AccessModifierMustBeDeclared +dotnet_diagnostic.SA1401.severity = none # FieldsMustBePrivate +dotnet_diagnostic.SA1402.severity = none # FileMayOnlyContainASingleType +dotnet_diagnostic.SA1407.severity = none # ArithmeticExpressionsMustDeclarePrecedence +dotnet_diagnostic.SA1413.severity = none # UseTrailingCommasInMultiLineInitializers +dotnet_diagnostic.SA1501.severity = none # StatementMustNotBeOnSingleLine +dotnet_diagnostic.SA1502.severity = none # ElementMustNotBeOnSingleLine +dotnet_diagnostic.SA1503.severity = none # BracesMustNotBeOmitted +dotnet_diagnostic.SA1516.severity = none # ElementsMustBeSeparatedByBlankLine +dotnet_diagnostic.SA1519.severity = none # BracesMustNotBeOmittedFromMultiLineChildStatement +dotnet_diagnostic.SA1520.severity = none # UseBracesConsistently +dotnet_diagnostic.SA1600.severity = none # ElementsMustBeDocumented +dotnet_diagnostic.SA1601.severity = none # PartialElementsMustBeDocumented +dotnet_diagnostic.SA1602.severity = none # EnumerationItemsMustBeDocumented +dotnet_diagnostic.SA1611.severity = none # ElementParametersShouldBeDocumented +dotnet_diagnostic.SA1615.severity = none # ElementReturnValueShouldBeDocumented +dotnet_diagnostic.SA1618.severity = none # GenericTypeParametersShouldBeDocumented +dotnet_diagnostic.SA1623.severity = none # PropertySummaryDocumentationShouldMatchAccessors +dotnet_diagnostic.SA1633.severity = none # FileMustHaveHeader +dotnet_diagnostic.SA1642.severity = none # ConstructorSummaryDocumentationShouldBeginWithStandardText +dotnet_diagnostic.SA1649.severity = none # FileNameMustMatchTypeName + +#### Code Quality Rules +#### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ + +# Below we enable specific rules by setting severity to warning. +# Rules are listed below with any options available. +# Options are commented out if they match the defaults. + +# Rule options that apply over multiple rules are set here. +# https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/code-quality-rule-options +dotnet_code_quality.api_surface = all + +### Design Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/design-warnings + +# Collections should implement generic interface. +#dotnet_code_quality.CA1010.additional_required_generic_interfaces = +dotnet_diagnostic.CA1010.severity = warning + +# Abstract types should not have public constructors. +dotnet_diagnostic.CA1012.severity = warning + +# Mark attributes with 'AttributeUsageAttribute'. +dotnet_diagnostic.CA1018.severity = warning + +# Override methods on comparable types. +dotnet_diagnostic.CA1036.severity = warning + +# Provide ObsoleteAttribute message. +dotnet_diagnostic.CA1041.severity = warning + +# Do not declare protected members in sealed types. +dotnet_diagnostic.CA1047.severity = warning + +# Declare types in namespaces. +dotnet_diagnostic.CA1050.severity = warning + +# Static holder types should be 'Static' or 'NotInheritable'. +dotnet_diagnostic.CA1052.severity = warning + +# Do not hide base class methods. +dotnet_diagnostic.CA1061.severity = warning + +# Exceptions should be public. +dotnet_diagnostic.CA1064.severity = warning + +# Implement 'IEquatable' when overriding 'Equals'. +dotnet_diagnostic.CA1066.severity = warning + +# Override 'Equals' when implementing 'IEquatable'. +dotnet_diagnostic.CA1067.severity = warning + +# 'CancellationToken' parameters must come last. +dotnet_diagnostic.CA1068.severity = warning + +# Do not declare event fields as virtual. +dotnet_diagnostic.CA1070.severity = warning + +### Documentation Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/documentation-warnings + +# Avoid using 'cref' tags with a prefix. +dotnet_diagnostic.CA1200.severity = warning + +### Globalization Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/globalization-warnings + +### Portability and Interoperability Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/interoperability-warnings -# Also handled by StyleCopAnalyzers - SA1024: ColonsMustBeSpacedCorrectly. -csharp_space_before_colon_in_inheritance_clause = true +# Do not use 'OutAttribute' on string parameters for P/Invokes. +dotnet_diagnostic.CA1417.severity = warning -# Also handled by StyleCopAnalyzers - SA1000: KeywordsMustBeSpacedCorrectly. -csharp_space_after_keywords_in_control_flow_statements = true +### Maintainability Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/maintainability-warnings -# Leave code block on single line. -csharp_preserve_single_line_blocks = true +# Use 'nameof' in place of string. +dotnet_diagnostic.CA1507.severity = warning -# Leave statements and member declarations on the same line. -csharp_preserve_single_line_statements = true +### Naming Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/naming-warnings -# IDE0049, IDE-only counterpart of StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias. -dotnet_style_predefined_type_for_member_access = true +# Do not prefix enum values with type name. +dotnet_code_quality.CA1712.enum_values_prefix_trigger = AnyEnumValue +dotnet_diagnostic.CA1712.severity = warning -# IDE0049, IDE-only counterpart of StyleCopAnalyzers - SA1121: UseBuiltInTypeAlias. -dotnet_style_predefined_type_for_locals_parameters_members = true +# Flags enums should have plural names. +dotnet_diagnostic.CA1714.severity = warning -## Others: +# Only 'FlagsAttribute' enums should have plural names. +dotnet_diagnostic.CA1717.severity = warning -# Show an IDE warning when default access modifiers are explicitly specified. -dotnet_style_require_accessibility_modifiers = omit_if_default:warning +### Performance Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/performance-warnings -# Use 'var' instead of explicit type. -dotnet_diagnostic.IDE0007.severity = warning +# Use Literals Where Appropriate. +#dotnet_code_quality.CA1802.required_modifiers = static +dotnet_diagnostic.CA1802.severity = warning -# Don't prefer braces (for one liners). -dotnet_diagnostic.IDE0011.severity = silent +# Remove empty finalizers. +dotnet_diagnostic.CA1821.severity = warning -# Object initialization can be simplified / Use object initializer. -dotnet_diagnostic.IDE0017.severity = warning +# Mark members as static. +dotnet_code_quality.CA1822.api_surface = private,internal +dotnet_diagnostic.CA1822.severity = warning -# Collection initialization can be simplified -dotnet_diagnostic.IDE0028.severity = warning +# Avoid unused private fields. +dotnet_diagnostic.CA1823.severity = warning -# Simplify 'default' expression -dotnet_diagnostic.IDE0034.severity = warning +# Avoid zero-length array allocations. +dotnet_diagnostic.CA1825.severity = warning -# Modifiers are not ordered. -dotnet_diagnostic.IDE0036.severity = warning +# Use property instead of Linq Enumerable method. +#dotnet_code_quality.CA1826.exclude_ordefault_methods = false +dotnet_diagnostic.CA1826.severity = warning -# Raise a warning on build when default access modifiers are explicitly specified. -dotnet_diagnostic.IDE0040.severity = warning +# Do not use Count/LongCount when Any can be used. +dotnet_diagnostic.CA1827.severity = warning -# Make field readonly. -dotnet_diagnostic.IDE0044.severity = warning +# Do not use CountAsync/LongCountAsync when AnyAsync can be used. +dotnet_diagnostic.CA1828.severity = warning -# Unused private member. -dotnet_diagnostic.IDE0052.severity = warning +# Use Length/Count property instead of Enumerable.Count method. +dotnet_diagnostic.CA1829.severity = warning -# Unnecessary value assignment. -dotnet_diagnostic.IDE0059.severity = warning +# Prefer strongly-typed Append and Insert method overloads on StringBuilder. +dotnet_diagnostic.CA1830.severity = warning -# Unused parameter. -dotnet_diagnostic.IDE0060.severity = warning +# Use AsSpan instead of Range-based indexers for string when appropriate. +dotnet_diagnostic.CA1831.severity = warning -# Naming rule violation. -dotnet_diagnostic.IDE1006.severity = warning +# Use AsSpan or AsMemory instead of Range-based indexers for getting ReadOnlySpan or ReadOnlyMemory portion of an array. +dotnet_diagnostic.CA1832.severity = warning -# Avoid unnecessary zero-length array allocations. -dotnet_diagnostic.CA1825.severity = warning +# Use AsSpan or AsMemory instead of Range-based indexers for getting Span or Memory portion of an array. +dotnet_diagnostic.CA1833.severity = warning -# Do not use Enumerable methods on indexable collections. Instead use the collection directly. -dotnet_diagnostic.CA1826.severity = warning +# Use StringBuilder.Append(char) for single character strings. +dotnet_diagnostic.CA1834.severity = warning -# Count() is used where Any() could be used instead to improve performance. -dotnet_diagnostic.CA1827.severity = warning +# Prefer the memory-based overloads of ReadAsync/WriteAsync methods in stream-based classes. +dotnet_diagnostic.CA1835.severity = warning -# Use Length/Count property instead of Enumerable.Count method. -dotnet_diagnostic.CA1829.severity = warning +# Prefer IsEmpty over Count when available. +dotnet_diagnostic.CA1836.severity = warning + +# Use Environment.ProcessId instead of Process.GetCurrentProcess().Id. +dotnet_diagnostic.CA1837.severity = warning + +# Avoid StringBuilder parameters for P/Invokes. +dotnet_diagnostic.CA1838.severity = warning + +# Use Environment.ProcessPath instead of Process.GetCurrentProcess().MainModule.FileName. +dotnet_diagnostic.CA1839.severity = warning + +# Use Environment.CurrentManagedThreadId instead of Thread.CurrentThread.ManagedThreadId. +dotnet_diagnostic.CA1840.severity = warning + +# Prefer Dictionary Contains methods. +dotnet_diagnostic.CA1841.severity = warning + +# Do not use 'WhenAll' with a single task. +dotnet_diagnostic.CA1842.severity = warning + +# Do not use 'WaitAll' with a single task. +dotnet_diagnostic.CA1843.severity = warning + +# Provide memory-based overrides of async methods when subclassing 'Stream'. +dotnet_diagnostic.CA1844.severity = warning + +# Use span-based 'string.Concat'. (Not available on mono) +dotnet_diagnostic.CA1845.severity = none + +# Prefer AsSpan over Substring. +dotnet_diagnostic.CA1846.severity = warning # Use string.Contains(char) instead of string.Contains(string) with single characters. dotnet_diagnostic.CA1847.severity = warning -; 4-column tab indentation -[*.yaml] -indent_style = tab -indent_size = 4 +# Call async methods when in an async method. +dotnet_diagnostic.CA1849.severity = warning + +# Prefer static HashData method over ComputeHash. (Not available on mono) +dotnet_diagnostic.CA1850.severity = none + +# Seal internal types. +dotnet_diagnostic.CA1852.severity = warning + +# Unnecessary call to 'Dictionary.ContainsKey(key)'. +dotnet_diagnostic.CA1853.severity = warning + +# Prefer the IDictionary.TryGetValue(TKey, out TValue) method. +dotnet_diagnostic.CA1854.severity = warning + +# Use Span.Clear() instead of Span.Fill(). +dotnet_diagnostic.CA1855.severity = warning + +# Use StartsWith instead of IndexOf. +dotnet_diagnostic.CA1858.severity = warning + +# Avoid using 'Enumerable.Any()' extension method. +dotnet_diagnostic.CA1860.severity = warning + +### Reliability Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/reliability-warnings + +# Do not assign property within its setter. +dotnet_diagnostic.CA2011.severity = warning + +# Use ValueTasks correctly. +dotnet_diagnostic.CA2012.severity = warning + +# Do not use ReferenceEquals with value types. +dotnet_diagnostic.CA2013.severity = warning + +# Do not use stackalloc in loops. +dotnet_diagnostic.CA2014.severity = warning + +# Forward the CancellationToken parameter to methods that take one. +dotnet_diagnostic.CA2016.severity = warning + +# The 'count' argument to Buffer.BlockCopy should specify the number of bytes to copy. +dotnet_diagnostic.CA2018.severity = warning + +# ThreadStatic fields should not use inline initialization. +dotnet_diagnostic.CA2019.severity = warning + +### Security Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/security-warnings + +# Do Not Use Broken Cryptographic Algorithms. +dotnet_diagnostic.CA5351.severity = warning + +### Usage Rules +### https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/usage-warnings + +# Call GC.SuppressFinalize correctly. +dotnet_diagnostic.CA1816.severity = warning + +# Rethrow to preserve stack details. +dotnet_diagnostic.CA2200.severity = warning + +# Initialize value type static fields inline. +dotnet_diagnostic.CA2207.severity = warning + +# Instantiate argument exceptions correctly. +dotnet_diagnostic.CA2208.severity = warning + +# Dispose methods should call base class dispose. +dotnet_diagnostic.CA2215.severity = warning + +# Disposable types should declare finalizer. +dotnet_diagnostic.CA2216.severity = warning + +# Override GetHashCode on overriding Equals. +dotnet_diagnostic.CA2218.severity = warning + +# Overload operator equals on overriding ValueType.Equals. +dotnet_diagnostic.CA2231.severity = warning + +# Provide correct arguments to formatting methods. +#dotnet_code_quality.CA2241.additional_string_formatting_methods = +dotnet_code_quality.CA2241.try_determine_additional_string_formatting_methods_automatically = true +dotnet_diagnostic.CA2241.severity = warning + +# Test for NaN correctly. +dotnet_diagnostic.CA2242.severity = warning + +# Attribute string literals should parse correctly. +dotnet_diagnostic.CA2243.severity = warning + +# Do not duplicate indexed element initializations. +dotnet_diagnostic.CA2244.severity = warning + +# Do not assign a property to itself. +dotnet_diagnostic.CA2245.severity = warning + +# Argument passed to TaskCompletionSource constructor should be TaskCreationOptions enum instead of TaskContinuationOptions enum. +dotnet_diagnostic.CA2247.severity = warning + +# Provide correct enum argument to Enum.HasFlag. +dotnet_diagnostic.CA2248.severity = warning + +# Use ThrowIfCancellationRequested. +dotnet_diagnostic.CA2250.severity = warning + +# Ensure ThreadStatic is only used with static fields. +dotnet_diagnostic.CA2259.severity = warning + +### Roslynator +### https://github.com/JosefPihrt/Roslynator/tree/main/docs/analyzers + +# Below we enable specific rules by setting severity to warning. # Use 'Count' property instead of 'Any' method. dotnet_diagnostic.RCS1080.severity = warning @@ -210,4 +915,4 @@ dotnet_diagnostic.RCS1160.severity = warning dotnet_diagnostic.RCS1235.severity = warning # Call extension method as instance method. -dotnet_diagnostic.RCS1196.severity = warning +dotnet_diagnostic.RCS1196.severity = warning \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c55fc01..73749d0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,6 +4,9 @@ on: push: pull_request: +permissions: + contents: read # to fetch code (actions/checkout) + jobs: linux: name: Linux (.NET 6.0) @@ -32,7 +35,7 @@ jobs: run: | sudo apt-get install lua5.1 make check-scripts - make test + make TREAT_WARNINGS_AS_ERRORS=true test linux-mono: name: Linux (mono) @@ -56,7 +59,7 @@ jobs: - name: Check Mod run: | # check-scripts does not depend on .net/mono, so is not needed here - make RUNTIME=mono test + make RUNTIME=mono TREAT_WARNINGS_AS_ERRORS=true test windows: name: Windows (.NET 6.0) @@ -80,7 +83,8 @@ jobs: - name: Check Mods run: | - chocolatey install lua --version 5.1.5.52 + choco install lua --version 5.1.5.52 $ENV:Path = $ENV:Path + ";C:\Program Files (x86)\Lua\5.1\" + $ENV:TREAT_WARNINGS_AS_ERRORS = "true" .\make.ps1 check-scripts .\make.ps1 test diff --git a/.github/workflows/packaging.yml b/.github/workflows/packaging.yml index 7b4711c..7a32f93 100644 --- a/.github/workflows/packaging.yml +++ b/.github/workflows/packaging.yml @@ -5,6 +5,9 @@ on: tags: - '*' +permissions: + contents: write # for release creation (svenstaro/upload-release-action) + jobs: linux: name: Linux AppImages diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..f1b14b9 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,9 @@ +{ + "recommendations": [ + "EditorConfig.EditorConfig", + "ms-dotnettools.csharp", + "openra.oraide-vscode", + "openra.vscode-openra-lua", + "macabeus.vscode-fluent", + ] +} diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..8e4482f --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,30 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "name": "Launch (Example)", + "type": "coreclr", + "request": "launch", + "program": "${workspaceRoot}/engine/bin/OpenRA.dll", + "args": [ + "Game.Mod=example", + "Engine.EngineDir=${workspaceRoot}/engine", + "Engine.ModSearchPaths=${workspaceRoot}/mods, ${workspaceRoot}/engine/mods", + "Debug.DisplayDeveloperSettings=true", + ], + "preLaunchTask": "build", + }, + { + "name": "Launch Utility", + "type": "coreclr", + "request": "launch", + "program": "${workspaceRoot}/engine/bin/OpenRA.Utility.dll", + "args": ["example", "--check-yaml"], + "env": { + "ENGINE_DIR": "${workspaceRoot}/engine", + "MOD_SEARCH_PATHS": "${workspaceRoot}/mods, ${workspaceRoot}/engine/mods" + }, + "preLaunchTask": "build", + }, + ], +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..a81ea02 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,37 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "build", + "command": "make", + "args": ["all", "CONFIGURATION=Debug"], + "windows": { + "command": "make.cmd" + } + }, + { + "label": "Run Utility", + "command": "dotnet ${workspaceRoot}/engine/bin/OpenRA.Utility.dll ${input:modId} ${input:command}", + "type": "shell", + "options": { + "env": { + "ENGINE_DIR": "${workspaceRoot}/engine", + "MOD_SEARCH_PATHS": "${workspaceRoot}/mods,${workspaceRoot}/engine/mods" + } + } + } + ], + "inputs": [ + { + "id": "modId", + "description": "ID of the mod to run", + "default": "all", + "type": "promptString" + }, { + "id": "command", + "description": "Name of the command + parameters", + "default": "", + "type": "promptString" + }, + ] +} diff --git a/Makefile b/Makefile index 7dbd192..9452a97 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ # to compile, run: # make # -# to compile using Mono (version 6.4 or greater) instead of .NET 6, run: +# to compile using Mono (version 6.12 or greater) instead of .NET 6, run: # make RUNTIME=mono # # to compile using system libraries for native dependencies, run: @@ -22,7 +22,7 @@ # make [RUNTIME=net6] check # # to check your mod yaml for errors, run: -# make [RUNTIME=net6] test +# make [RUNTIME=net6] [TREAT_WARNINGS_AS_ERRORS=false] test # # the following are internal sdk helpers that are not intended to be run directly: # make check-variables @@ -145,7 +145,7 @@ engine: check-variables check-sdk-scripts all: engine ifeq ($(RUNTIME), mono) - @command -v $(MSBUILD) >/dev/null || (echo "OpenRA requires the '$(MSBUILD)' tool provided by Mono >= 6.4."; exit 1) + @command -v $(MSBUILD) >/dev/null || (echo "OpenRA requires the '$(MSBUILD)' tool provided by Mono >= 6.12."; exit 1) ifneq ("$(MOD_SOLUTION_FILES)","") @find . -maxdepth 1 -name '*.sln' -exec $(MSBUILD) -t:Build -restore -p:Configuration=${CONFIGURATION} -p:TargetPlatform=$(TARGETPLATFORM) -p:Mono=true \; endif @@ -181,11 +181,10 @@ check: engine ifneq ("$(MOD_SOLUTION_FILES)","") @echo "Compiling in Debug mode..." ifeq ($(RUNTIME), mono) -# Enabling EnforceCodeStyleInBuild and GenerateDocumentationFile as a workaround for some code style rules (in particular IDE0005) being bugged and not reporting warnings/errors otherwise. - @$(MSBUILD) -t:build -restore -p:Configuration=Debug -warnaserror -p:TargetPlatform=$(TARGETPLATFORM) -p:Mono=true -p:EnforceCodeStyleInBuild=true -p:GenerateDocumentationFile=true + @$(MSBUILD) -t:clean\;build -restore -p:Configuration=Debug -warnaserror -p:TargetPlatform=$(TARGETPLATFORM) else -# Enabling EnforceCodeStyleInBuild and GenerateDocumentationFile as a workaround for some code style rules (in particular IDE0005) being bugged and not reporting warnings/errors otherwise. - @$(DOTNET) build -c Debug -nologo -warnaserror -p:TargetPlatform=$(TARGETPLATFORM) -p:EnforceCodeStyleInBuild=true -p:GenerateDocumentationFile=true + @$(DOTNET) clean -c Debug --nologo --verbosity minimal + @$(DOTNET) build -c Debug -nologo -warnaserror -p:TargetPlatform=$(TARGETPLATFORM) endif endif @echo "Checking for explicit interface violations..." diff --git a/launch-dedicated.cmd b/launch-dedicated.cmd index df36e4a..6d3bdab 100644 --- a/launch-dedicated.cmd +++ b/launch-dedicated.cmd @@ -3,6 +3,7 @@ @echo on set Name="Dedicated Server" +set Map="" set ListenPort=1234 set AdvertiseOnline=True set Password="" @@ -18,7 +19,7 @@ set EnableGeoIP=True set EnableLintChecks=True set ShareAnonymizedIPs=True -set JoinChatDelay=5000 +set FloodLimitJoinCooldown=5000 @echo off setlocal EnableDelayedExpansion @@ -37,7 +38,7 @@ if not exist %ENGINE_DIRECTORY%\bin\OpenRA.exe goto noengine cd %ENGINE_DIRECTORY% :loop -bin\OpenRA.Server.exe Game.Mod=%MOD_ID% Engine.EngineDir=".." Server.Name=%Name% Server.ListenPort=%ListenPort% Server.AdvertiseOnline=%AdvertiseOnline% Server.EnableSingleplayer=%EnableSingleplayer% Server.Password=%Password% Server.RequireAuthentication=%RequireAuthentication% Server.RecordReplays=%RecordReplays% Server.ProfileIDBlacklist=%ProfileIDBlacklist% Server.ProfileIDWhitelist=%ProfileIDWhitelist% Server.EnableSyncReports=%EnableSyncReports% Server.EnableGeoIP=%EnableGeoIP% Server.ShareAnonymizedIPs=%ShareAnonymizedIPs% Server.EnableLintChecks=%EnableLintChecks% Engine.SupportDir=%SupportDir% Server.JoinChatDelay=%JoinChatDelay% +bin\OpenRA.Server.exe Game.Mod=%MOD_ID% Engine.EngineDir=".." Server.Name=%Name% Server.Map=%Map% Server.ListenPort=%ListenPort% Server.AdvertiseOnline=%AdvertiseOnline% Server.EnableSingleplayer=%EnableSingleplayer% Server.Password=%Password% Server.RequireAuthentication=%RequireAuthentication% Server.RecordReplays=%RecordReplays% Server.ProfileIDBlacklist=%ProfileIDBlacklist% Server.ProfileIDWhitelist=%ProfileIDWhitelist% Server.EnableSyncReports=%EnableSyncReports% Server.EnableGeoIP=%EnableGeoIP% Server.ShareAnonymizedIPs=%ShareAnonymizedIPs% Server.EnableLintChecks=%EnableLintChecks% Engine.SupportDir=%SupportDir% Server.FloodLimitJoinCooldown=%FloodLimitJoinCooldown% goto loop :noengine diff --git a/launch-dedicated.sh b/launch-dedicated.sh index ae52ac8..8549328 100755 --- a/launch-dedicated.sh +++ b/launch-dedicated.sh @@ -50,6 +50,7 @@ fi NAME="${Name:-"Dedicated Server"}" LAUNCH_MOD="${Mod:-"${MOD_ID}"}" +MAP="${Map:-""}" LISTEN_PORT="${ListenPort:-"1234"}" ADVERTISE_ONLINE="${AdvertiseOnline:-"True"}" PASSWORD="${Password:-""}" @@ -65,7 +66,7 @@ ENABLE_GEOIP="${EnableGeoIP:-"True"}" ENABLE_LINT_CHECKS="${EnableLintChecks:-"True"}" SHARE_ANONYMISED_IPS="${ShareAnonymizedIPs:-"True"}" -JOIN_CHAT_DELAY="${JoinChatDelay:-"5000"}" +FLOOD_LIMIT_JOIN_COOLDOWN="${FloodLimitJoinCooldown:-"5000"}" SUPPORT_DIR="${SupportDir:-""}" @@ -79,21 +80,22 @@ fi cd "${ENGINE_DIRECTORY}" while true; do - MOD_SEARCH_PATHS="${MOD_SEARCH_PATHS}" - ${RUNTIME_LAUNCHER} bin/OpenRA.Server.dll Engine.EngineDir=".." Game.Mod="${LAUNCH_MOD}" \ - Server.Name="${NAME}" \ - Server.ListenPort="${LISTEN_PORT}" \ - Server.AdvertiseOnline="${ADVERTISE_ONLINE}" \ - Server.Password="${PASSWORD}" \ - Server.RecordReplays="${RECORD_REPLAYS}" \ - Server.RequireAuthentication="${REQUIRE_AUTHENTICATION}" \ - Server.ProfileIDBlacklist="${PROFILE_ID_BLACKLIST}" \ - Server.ProfileIDWhitelist="${PROFILE_ID_WHITELIST}" \ - Server.EnableSingleplayer="${ENABLE_SINGLE_PLAYER}" \ - Server.EnableSyncReports="${ENABLE_SYNC_REPORTS}" \ - Server.EnableGeoIP="${ENABLE_GEOIP}" \ - Server.EnableLintChecks="${ENABLE_LINT_CHECKS}" \ - Server.ShareAnonymizedIPs="${SHARE_ANONYMISED_IPS}" \ - Server.JoinChatDelay="${JOIN_CHAT_DELAY}" \ - Engine.SupportDir="${SUPPORT_DIR}" + MOD_SEARCH_PATHS="${MOD_SEARCH_PATHS}" \ + ${RUNTIME_LAUNCHER} bin/OpenRA.Server.dll Engine.EngineDir=".." Game.Mod="${LAUNCH_MOD}" \ + Server.Name="${NAME}" \ + Server.Map="${MAP}" \ + Server.ListenPort="${LISTEN_PORT}" \ + Server.AdvertiseOnline="${ADVERTISE_ONLINE}" \ + Server.Password="${PASSWORD}" \ + Server.RecordReplays="${RECORD_REPLAYS}" \ + Server.RequireAuthentication="${REQUIRE_AUTHENTICATION}" \ + Server.ProfileIDBlacklist="${PROFILE_ID_BLACKLIST}" \ + Server.ProfileIDWhitelist="${PROFILE_ID_WHITELIST}" \ + Server.EnableSingleplayer="${ENABLE_SINGLE_PLAYER}" \ + Server.EnableSyncReports="${ENABLE_SYNC_REPORTS}" \ + Server.EnableGeoIP="${ENABLE_GEOIP}" \ + Server.EnableLintChecks="${ENABLE_LINT_CHECKS}" \ + Server.ShareAnonymizedIPs="${SHARE_ANONYMISED_IPS}" \ + Server.FloodLimitJoinCooldown="${FLOOD_LIMIT_JOIN_COOLDOWN}" \ + Engine.SupportDir="${SUPPORT_DIR}" done diff --git a/make.ps1 b/make.ps1 index 4bf144a..548adbe 100644 --- a/make.ps1 +++ b/make.ps1 @@ -118,8 +118,9 @@ function Check-Command Write-Host "Compiling $modID in Debug configuration..." -ForegroundColor Cyan - # Enabling EnforceCodeStyleInBuild and GenerateDocumentationFile as a workaround for some code style rules (in particular IDE0005) being bugged and not reporting warnings/errors otherwise. - dotnet build -c Debug --nologo -warnaserror -p:TargetPlatform=win-x64 -p:EnforceCodeStyleInBuild=true -p:GenerateDocumentationFile=true + dotnet clean -c Debug --nologo --verbosity minimal + dotnet build -c Debug --nologo -warnaserror -p:TargetPlatform=win-x64 + if ($lastexitcode -ne 0) { Write-Host "Build failed." -ForegroundColor Red diff --git a/packaging/windows/buildpackage.nsi b/packaging/windows/buildpackage.nsi index 0d70e06..2a57dfe 100644 --- a/packaging/windows/buildpackage.nsi +++ b/packaging/windows/buildpackage.nsi @@ -111,9 +111,6 @@ Section "Game" GAME "$OUTDIR\${PACKAGING_WINDOWS_LAUNCHER_NAME}.exe" "" "" "" "" !insertmacro MUI_STARTMENU_WRITE_END - SetOutPath "$INSTDIR\lua" - File "${SRCDIR}\lua\*.lua" - SetOutPath "$INSTDIR\glsl" File "${SRCDIR}\glsl\*.frag" File "${SRCDIR}\glsl\*.vert" @@ -162,7 +159,6 @@ Function ${UN}Clean RMDir /r $INSTDIR\mods RMDir /r $INSTDIR\maps RMDir /r $INSTDIR\glsl - RMDir /r $INSTDIR\lua Delete $INSTDIR\*.exe Delete $INSTDIR\*.dll Delete $INSTDIR\*.ico diff --git a/packaging/windows/buildpackage.sh b/packaging/windows/buildpackage.sh index a5fbcee..3ca5056 100755 --- a/packaging/windows/buildpackage.sh +++ b/packaging/windows/buildpackage.sh @@ -108,11 +108,23 @@ function build_platform() echo "Mod version ${MOD_VERSION} will remain unchanged."; fi + TAG_TYPE="${TAG%%-*}" + TAG_VERSION="${TAG#*-}" + BACKWARDS_TAG="${TAG_VERSION}-${TAG_TYPE}" + # Create multi-resolution icon convert "${ARTWORK_DIR}/icon_16x16.png" "${ARTWORK_DIR}/icon_24x24.png" "${ARTWORK_DIR}/icon_32x32.png" "${ARTWORK_DIR}/icon_48x48.png" "${ARTWORK_DIR}/icon_256x256.png" "${BUILTDIR}/${MOD_ID}.ico" echo "Compiling Windows launcher (${PLATFORM})" - install_windows_launcher "${TEMPLATE_ROOT}/${ENGINE_DIRECTORY}" "${BUILTDIR}" "win-${PLATFORM}" "${MOD_ID}" "${PACKAGING_WINDOWS_LAUNCHER_NAME}" "${PACKAGING_DISPLAY_NAME}" "${PACKAGING_FAQ_URL}" + install_windows_launcher "${TEMPLATE_ROOT}/${ENGINE_DIRECTORY}" "${BUILTDIR}" "win-${PLATFORM}" "${MOD_ID}" "${PACKAGING_WINDOWS_LAUNCHER_NAME}" "${PACKAGING_DISPLAY_NAME}" "${PACKAGING_FAQ_URL}" "${TAG}" + + # Use rcedit to patch the generated EXE with missing assembly/PortableExecutable information because .NET 6 ignores that when building on Linux. + # Using a backwards version tag because rcedit is unable to set versions starting with a letter. + wine64 rcedit-x64.exe "${BUILTDIR}/${PACKAGING_WINDOWS_LAUNCHER_NAME}.exe" --set-product-version "${BACKWARDS_TAG}" + wine64 rcedit-x64.exe "${BUILTDIR}/${PACKAGING_WINDOWS_LAUNCHER_NAME}.exe" --set-version-string "ProductName" "OpenRA" + wine64 rcedit-x64.exe "${BUILTDIR}/${PACKAGING_WINDOWS_LAUNCHER_NAME}.exe" --set-version-string "CompanyName" "The OpenRA team" + wine64 rcedit-x64.exe "${BUILTDIR}/${PACKAGING_WINDOWS_LAUNCHER_NAME}.exe" --set-version-string "FileDescription" "${PACKAGING_WINDOWS_LAUNCHER_NAME} mod for OpenRA" + wine64 rcedit-x64.exe "${BUILTDIR}/${PACKAGING_WINDOWS_LAUNCHER_NAME}.exe" --set-version-string "LegalCopyright" "Copyright (c) The OpenRA Developers and Contributors" wine64 rcedit-x64.exe "${BUILTDIR}/${PACKAGING_WINDOWS_LAUNCHER_NAME}.exe" --set-icon "${BUILTDIR}/${MOD_ID}.ico"