[pull] main from pylonmc:main

.github/workflows/deploy.yml

@@ -23,7 +23,7 @@ jobs:
         run: mkdocs build
 
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@4b09552702d0b65573696410d4707c765da2630b
+        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e
         with:
           personal_token: ${{ secrets.DOCS_DEPLOY_TOKEN }}
           external_repository: pylonmc/pylonmc.github.io

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

docs/index.md → docs/en/index.md

@@ -3,7 +3,7 @@ Pylon is an **upcoming** Minecraft Java plugin that will hugely expand vanilla g
 Pylon uses an addon system, meaning anyone can add content to Pylon by writing an addon for it! It also comes with a number of really useful features, such as:
 
 - First-class translation support, meaning each player can select their own language.
-- Extensive configuration options, including per-machine configuration. 
+- Extensive configuration options, including per-machine configuration.
 - An intuitive and user-friendly guide to help players figure out the plugin.
 
 ## :frame_photo: Pylon in pictures (so far)
@@ -25,9 +25,9 @@ Pylon uses an addon system, meaning anyone can add content to Pylon by writing a
 
 We have built Pylon with performance and stability in mind from day 1:
 
-- Pylon makes **extensive** use of caching and will run most performance-intensive systems asynchronously, as well as makeing use of modern concurrency/performance features such as coroutines. 
-- In addition, the plugin will have a broad range of config options to help performance - including per-machine tick rates, the ability to limit the number of machines placed by player/chunk/etc, the tick rate of fluid/energy/etc, and more. 
-- The way Pylon is designed minimises the chance of data corruption and has a range of error-handling mechanisms if something does go wrong. 
+- Pylon makes **extensive** use of caching and will run most performance-intensive systems asynchronously, as well as makeing use of modern concurrency/performance features such as coroutines.
+- In addition, the plugin will have a broad range of config options to help performance - including per-machine tick rates, the ability to limit the number of machines placed by player/chunk/etc, the tick rate of fluid/energy/etc, and more.
+- The way Pylon is designed minimises the chance of data corruption and has a range of error-handling mechanisms if something does go wrong.
 Note: Pylon will likely not be fully compatible with bedrock.
 
 ## :calendar: Provisional timeline
@@ -75,4 +75,5 @@ We also have help from:
 If you're interested in helping out, drop us a message on our Discord server! You don't have to be an expert to help, a little plugin development experience is enough - there are plenty of tasks to do, ranging from trivial to exceptionally complex, so just let us know if you're interested and we can find something for you to do.
 
 ## :question: Got questions?
+
 Drop a message on our Discord server and we'll be happy to answer.

docs/en/installation/commands-and-permissions.md

@@ -0,0 +1,30 @@
+# Commands & permissions
+
+## Default commands
+| Command                            | Permission                               | Description |
+|------------------------------------|------------------------------------------|-------------|
+| `/py`                              | `pylon.command.guide`                    | Opens the Pylon guide
+| `/py guide`                        | `pylon.command.guide`                    | Gives you the Pylon guide
+
+## Admin commands
+| Command                                          | Permission                               | Description |
+|--------------------------------------------------|------------------------------------------|-------------|
+| `/py confetti <amount> [speed] [lifetime]`       | `pylon.command.confetti`                 | Spawns confetti particles
+| `/py debug`                                      | `pylon.command.debug`                    | Gives you the debug item, which can be used to view Pylon block/entity data and forcibly remove Pylon blocks/entities
+| `/py exposerecipeconfig <addon> <recipe_type>`   | `pylon.command.exposerecipeconfig`       | Allows recipes to be edited for a specific recipe stype. Doing this will prevent any recipes of the given type from being automatically updated, so use with caution!
+| `/py give <player> <item> [amount]`              | `pylon.command.give`                     | Gives a player a Pylon item
+| `/py key`                                        | `pylon.command.key`                      | Shows you the key of the Pylon item you're holding in your hand
+| `/py research add <player> <research>`           | `pylon.command.research.add`             | Adds the given research to a player
+| `/py research addall <player>`                   | `pylon.command.research.addall`          | Adds all researches to a player
+| `/py research remove <player> <research>`        | `pylon.command.research.remove`          | Removes the given research from a player
+| `/py research points add <player> <amount>`      | `pylon.command.research.points.add`      | Adds research points to a player
+| `/py research points get <player>`               | `pylon.command.research.points.get`      | Shows you the number of research points a player has
+| `/py research points set <player> <amount>`      | `pylon.command.research.points.set`      | Sets the number of research points a player has
+| `/py research points subtract <player> <amount>` | `pylon.command.research.points.subtract` | Removes research points from a player
+| `/py setblock <x> <y> <z> <block>`               | `pylon.command.setblock`                 | Sets the given Pylon block at the coordinates provided
+
+## Other permissions
+| Permission                     | Description |
+|--------------------------------|-------------|
+| `pylon.guide.cheat`            | Allows you to use drop, ctrl+drop, or middle click to cheat in items from the Pylon guide |
+| `pylon.guide.view_admin_pages` | Allows you to see admin-only guide pages                                                  |

mkdocs.yml

@@ -76,3 +76,13 @@ markdown_extensions:
 
 plugins:
   - open-in-new-tab
+  - i18n:
+      docs_structure: folder
+      fallback_to_default: true
+      reconfigure_material: true
+      reconfigure_search: true
+      languages:
+        - locale: en
+          default: true
+          name: English
+          build: true

requirements.txt

@@ -1,3 +1,4 @@
 mkdocs
 mkdocs-material
 mkdocs-open-in-new-tab
+mkdocs-static-i18n[material]