Merge pull request #261 from Sylfare/feat/editorconfig

EditorConfig file and grammar fixes

.editorconfig

@@ -0,0 +1,174 @@
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+
+[*.{java,kts,toml,html,md,yml}]
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{java,kts,js}]
+indent_style = tab
+max_line_length = 120
+ij_continuation_indent_size = 4
+
+[*.py] 
+indent_style = space
+indent_size = 4
+
+[*.sh]
+indent_size = 2
+tab_width = 2
+ij_shell_binary_ops_start_line = false
+ij_shell_keep_column_alignment_padding = false
+ij_shell_minify_program = false
+ij_shell_redirect_followed_by_space = false
+ij_shell_switch_cases_indented = false
+ij_shell_use_unix_line_separator = true
+
+
+[{*.yaml,*.yml}]
+indent_style = space
+indent_size = 2
+ij_yaml_align_values_properties = do_not_align
+ij_yaml_autoinsert_sequence_marker = true
+ij_yaml_block_mapping_on_new_line = false
+ij_yaml_indent_sequence_value = true
+ij_yaml_keep_indents_on_empty_lines = false
+ij_yaml_keep_line_breaks = true
+ij_yaml_sequence_on_new_line = false
+ij_yaml_space_before_colon = false
+ij_yaml_spaces_within_braces = true
+ij_yaml_spaces_within_brackets = true
+
+
+[{*.htm,*.html,*.sht,*.shtm,*.shtml}]
+ij_html_add_new_line_before_tags = body,div,p,form,h1,h2,h3
+ij_html_align_attributes = true
+ij_html_align_text = false
+ij_html_attribute_wrap = normal
+ij_html_block_comment_add_space = false
+ij_html_block_comment_at_first_column = true
+ij_html_do_not_align_children_of_min_lines = 0
+ij_html_do_not_break_if_inline_tags = title,h1,h2,h3,h4,h5,h6,p
+ij_html_do_not_indent_children_of_tags = html,body,thead,tbody,tfoot
+ij_html_enforce_quotes = false
+ij_html_inline_tags = a,abbr,acronym,b,basefont,bdo,big,br,cite,cite,code,dfn,em,font,i,img,input,kbd,label,q,s,samp,select,small,span,strike,strong,sub,sup,textarea,tt,u,var
+ij_html_keep_blank_lines = 2
+ij_html_keep_indents_on_empty_lines = false
+ij_html_keep_line_breaks = true
+ij_html_keep_line_breaks_in_text = true
+ij_html_keep_whitespaces = false
+ij_html_keep_whitespaces_inside = span,pre,textarea
+ij_html_line_comment_at_first_column = true
+ij_html_new_line_after_last_attribute = never
+ij_html_new_line_before_first_attribute = never
+ij_html_quote_style = double
+ij_html_remove_new_line_before_tags = br
+ij_html_space_after_tag_name = false
+ij_html_space_around_equality_in_attribute = false
+ij_html_space_inside_empty_tag = false
+ij_html_text_wrap = normal
+
+[{*.kt,*.kts}]
+ij_kotlin_align_in_columns_case_branch = false
+ij_kotlin_align_multiline_binary_operation = false
+ij_kotlin_align_multiline_extends_list = false
+ij_kotlin_align_multiline_method_parentheses = false
+ij_kotlin_align_multiline_parameters = true
+ij_kotlin_align_multiline_parameters_in_calls = false
+ij_kotlin_allow_trailing_comma = false
+ij_kotlin_allow_trailing_comma_on_call_site = false
+ij_kotlin_assignment_wrap = normal
+ij_kotlin_blank_lines_after_class_header = 0
+ij_kotlin_blank_lines_around_block_when_branches = 0
+ij_kotlin_blank_lines_before_declaration_with_comment_or_annotation_on_separate_line = 1
+ij_kotlin_block_comment_add_space = false
+ij_kotlin_block_comment_at_first_column = true
+ij_kotlin_call_parameters_new_line_after_left_paren = true
+ij_kotlin_call_parameters_right_paren_on_new_line = true
+ij_kotlin_call_parameters_wrap = on_every_item
+ij_kotlin_catch_on_new_line = false
+ij_kotlin_class_annotation_wrap = split_into_lines
+ij_kotlin_continuation_indent_for_chained_calls = false
+ij_kotlin_continuation_indent_for_expression_bodies = false
+ij_kotlin_continuation_indent_in_argument_lists = false
+ij_kotlin_continuation_indent_in_elvis = false
+ij_kotlin_continuation_indent_in_if_conditions = false
+ij_kotlin_continuation_indent_in_parameter_lists = false
+ij_kotlin_continuation_indent_in_supertype_lists = false
+ij_kotlin_else_on_new_line = false
+ij_kotlin_enum_constants_wrap = off
+ij_kotlin_extends_list_wrap = normal
+ij_kotlin_field_annotation_wrap = split_into_lines
+ij_kotlin_finally_on_new_line = false
+ij_kotlin_if_rparen_on_new_line = true
+ij_kotlin_import_nested_classes = false
+ij_kotlin_imports_layout = *,java.**,javax.**,kotlin.**,^
+ij_kotlin_insert_whitespaces_in_simple_one_line_method = true
+ij_kotlin_keep_blank_lines_before_right_brace = 2
+ij_kotlin_keep_blank_lines_in_code = 2
+ij_kotlin_keep_blank_lines_in_declarations = 2
+ij_kotlin_keep_first_column_comment = true
+ij_kotlin_keep_indents_on_empty_lines = false
+ij_kotlin_keep_line_breaks = true
+ij_kotlin_lbrace_on_next_line = false
+ij_kotlin_line_break_after_multiline_when_entry = true
+ij_kotlin_line_comment_add_space = false
+ij_kotlin_line_comment_add_space_on_reformat = false
+ij_kotlin_line_comment_at_first_column = true
+ij_kotlin_method_annotation_wrap = split_into_lines
+ij_kotlin_method_call_chain_wrap = normal
+ij_kotlin_method_parameters_new_line_after_left_paren = true
+ij_kotlin_method_parameters_right_paren_on_new_line = true
+ij_kotlin_method_parameters_wrap = on_every_item
+ij_kotlin_name_count_to_use_star_import = 5
+ij_kotlin_name_count_to_use_star_import_for_members = 3
+ij_kotlin_packages_to_use_import_on_demand = java.util.*,kotlinx.android.synthetic.**,io.ktor.**
+ij_kotlin_parameter_annotation_wrap = off
+ij_kotlin_space_after_comma = true
+ij_kotlin_space_after_extend_colon = true
+ij_kotlin_space_after_type_colon = true
+ij_kotlin_space_before_catch_parentheses = true
+ij_kotlin_space_before_comma = false
+ij_kotlin_space_before_extend_colon = true
+ij_kotlin_space_before_for_parentheses = true
+ij_kotlin_space_before_if_parentheses = true
+ij_kotlin_space_before_lambda_arrow = true
+ij_kotlin_space_before_type_colon = false
+ij_kotlin_space_before_when_parentheses = true
+ij_kotlin_space_before_while_parentheses = true
+ij_kotlin_spaces_around_additive_operators = true
+ij_kotlin_spaces_around_assignment_operators = true
+ij_kotlin_spaces_around_equality_operators = true
+ij_kotlin_spaces_around_function_type_arrow = true
+ij_kotlin_spaces_around_logical_operators = true
+ij_kotlin_spaces_around_multiplicative_operators = true
+ij_kotlin_spaces_around_range = false
+ij_kotlin_spaces_around_relational_operators = true
+ij_kotlin_spaces_around_unary_operator = false
+ij_kotlin_spaces_around_when_arrow = true
+ij_kotlin_variable_annotation_wrap = off
+ij_kotlin_while_on_new_line = false
+ij_kotlin_wrap_elvis_expressions = 1
+ij_kotlin_wrap_expression_body_functions = 1
+ij_kotlin_wrap_first_method_in_call_chain = false
+
+[{*.markdown,*.md}]
+ij_markdown_force_one_space_after_blockquote_symbol = true
+ij_markdown_force_one_space_after_header_symbol = true
+ij_markdown_force_one_space_after_list_bullet = true
+ij_markdown_force_one_space_between_words = true
+ij_markdown_format_tables = true
+ij_markdown_insert_quote_arrows_on_wrap = true
+ij_markdown_keep_indents_on_empty_lines = false
+ij_markdown_keep_line_breaks_inside_text_blocks = true
+ij_markdown_max_lines_around_block_elements = 1
+ij_markdown_max_lines_around_header = 1
+ij_markdown_max_lines_between_paragraphs = 1
+ij_markdown_min_lines_around_block_elements = 1
+ij_markdown_min_lines_around_header = 1
+ij_markdown_min_lines_between_paragraphs = 1
+ij_markdown_wrap_text_if_long = true
+ij_markdown_wrap_text_inside_blockquotes = true

CONTRIBUTING.md

@@ -7,13 +7,13 @@ If you'd like to contribute, this document will guide you through the most impor
 
 There are a lot of things that you can do to help the project.
 And contributions don't necessarily have to involve coding.
-Below I've written a short checklist of things that you can check:
+Below, I've written a short checklist of things that you can check:
 
 - Help to keep translations up to date or add a new language. [Guide to creating translations](https://github.com/oddlama/vane/wiki/Creating-a-Translation).
 - Submit your ideas or discuss existing ideas on the [Issue Tracker](https://github.com/oddlama/vane/issues)
 - Join our [Discord](https://discord.gg/RueJ6A59x2) and try helping people in the support channel.
 - Check if you'd like to implement a feature from the [Issue Tracker](https://github.com/oddlama/vane/issues).
-- Help us to build a documentation for the internal framework (vane-core)
+- Help us to build documentation for the internal framework (vane-core)
 - Or discuss your own ideas with us on our [Discord](https://discord.gg/RueJ6A59x2).
 - ...
 
@@ -31,15 +31,15 @@ us to provide early feedback on your implementation.
 #### Before submitting your final PR
 
 1. Make sure everything compiles
-2. Make sure that your commits have meaningful messages and follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) style. Just look into the commit history to see examples of good messages.
-3. Rebase your changes on the newest develop branch, if necessary. Usually, GitHub can do that for you.
+2. Make sure that your commits have meaningful messages and follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) style. Look into the commit history to see examples of good messages.
+3. Rebase your changes on the newest development branch, if necessary. Usually, GitHub can do that for you.
 
 If you need help with anything, don't hesitate to ask.
 
 ## Some things to keep in mind
 
 - Vane is opinionated. If you want to make a contribution, please communicate with us before you start implementing,
-  so we can help you design the feature in vane's spirit. We also want to avoid that two people unknowingly work on the same thing.
+  so we can help you design the feature in vane's spirit. We also want to avoid it that two people unknowingly work on the same thing.
 - By submitting a PR, you accept that your contributions will be published under the same [LICENSE](./LICENSE) as the rest of vane.
 
 But most importantly: Have fun! You don't need to work on anything just for the sake of contributing.

README.md

@@ -12,19 +12,19 @@
 
 # About vane
 
-Vane is a plugin-suite which provides many immersive and lore friendly additions to vanilla minecraft.
+Vane is a plugin-suite that provides many immersive and lore-friendly additions to vanilla minecraft.
 It will run on any [PaperMC](https://papermc.io) based minecraft server.
 
 [**For a comprehensive feature overview, visit the official website.**](https://oddlama.github.io/vane/)
 
 - <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/minecraft/textures/item/firework_rocket.png"> Lore friendly and properly integrated immersive features.
   Vane augments the classic vanilla experience, and doesn't try to replace it.
-  Generally, player's are not supposed to notice which features were introduced by vane.
+  Generally, players are not supposed to notice which features were introduced by vane.
 - <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/minecraft/textures/item/wheat.png"> Countless quality-of-life, gameplay and system improvements
 - <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/minecraft/textures/item/end_crystal.png"> Fully-configurable. Disable or configure anything you dislike
 - <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/vane-trifles/items/golden_sickle.png"> Several carefully designed custom items
 - <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/vane-enchantments/items/ancient_tome_of_the_gods.png"> Many custom enchantments for a selection of tools, including the elytra
-- <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/minecraft/textures/item/ender_pearl.png"> The best portals you can imagine. Expensive but worthwile for long distance travel. Supports all entities including minecarts!
+- <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/minecraft/textures/item/ender_pearl.png"> The best portals you can imagine. Expensive but worthwhile for long distance travel. Supports all entities including minecarts!
 - <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/minecraft/textures/item/writable_book.png"> A simple but powerful region system for grief protection
 - <img width="auto" height="20px" src="https://github.com/oddlama/vane/blob/main/docs/assets/minecraft/textures/item/map.png"> [BlueMap](https://bluemap.bluecolored.de/), [Dynmap](https://www.spigotmc.org/resources/dynmap%C2%AE.274/) and [Pl3xMap](https://github.com/BillyGalbreath/Pl3xMap) integration
 - [And a lot more!](https://oddlama.github.io/vane/)
@@ -45,14 +45,14 @@ refer to [**the official website**](https://oddlama.github.io/vane/) for a compl
 <img width="32%" height="auto" src="https://cdn.modrinth.com/data/698NGGtb/images/5b12bef32c5b544ae7cd807117410b1bc5bd5346.gif">
 </p>
 
-(And a whole lot more!)
+(And a lot more!)
 
 ## 📥 Installation
 
 <sup><sub>If you are setting up a new server, check out our [Server Installer](https://oddlama.github.io/minecraft-server)
-for an easy way to properly setup a minecraft server with vane, autostart, 3D online map, and more awesome features.</sub></sup>
+for an easy way to properly set up a minecraft server with vane, autostart, 3D online map, and more awesome features.</sub></sup>
 
-Simply download all desired jars files from the [Releases](https://github.com/oddlama/vane/releases/latest) and put them into the `plugins/` directory.
+Download all desired jars files from the [Releases](https://github.com/oddlama/vane/releases/latest) and put them into the `plugins/` directory.
 Grab the `all-plugins.zip` if you don't want to download each file by hand. You can also download vane from [Modrinth](https://modrinth.com/plugin/vane). Make sure that:
 
 - You are using the correct Paper (or Purpur) server version (compatible versions are listed in the title on the download page)
@@ -72,13 +72,13 @@ permissions plugin, such as [LuckPerms](https://luckperms.net).
 
 ## Building from source
 
-You can of course build the plugin yourself. To do that you need at least JDK 17.
+You can, of course, build the plugin yourself. To do that, you need at least JDK 17.
 
 1. Execute `./gradlew build`
 2. All resulting jar files that can be used on a server will be in `target/`.
 
-If you experience "peer not authenticated" issues from gradle, just retry.
-Seems to be a skittish integration between gradle and maven repositories.
+If you experience "peer not authenticated" issues from Gradle, just retry.
+Seems to be a skittish integration between Gradle and Maven repositories.
 
 ## FAQ
 

TODO

@@ -1,6 +1,6 @@
 #### Important
 
-- Wrong world name in config should issue warning --> hazard protection doesnt do this on wither worlds
+- Wrong world name in config should issue warning --> hazard protection doesn't do this on wither worlds
 
 #### IDEAS
 
@@ -11,8 +11,8 @@
 - [ ] trampelpfad (a trail of path-block that is created automatically when players take a route often, could get fancy.)
 - [ ] add a mechanic to update in-game maps (e.g. with a custom item, or redstone)
 - [ ] player heads from /heads
-- [ ] lodestone portal scrolls teleport ontop of the stone
-- [ ] world rebuild check for armorstands and item frames. dont let them be destroyed
+- [ ] lodestone portal scrolls teleport on top of the stone
+- [ ] world rebuild check for armor stands and item frames. don't let them be destroyed
 - [ ] minecart speed ++++++ only if player in minecart, or maybe with an extra type of minecart. is it time for the netherite minecart?
 - [ ] on first join message: e.g. for link to map and discord link