|
20 | 20 |
|
21 | 21 |
|
22 | 22 | <link rel="icon" href="../../img/favicon.png"> |
23 | | - <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.15"> |
| 23 | + <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11"> |
24 | 24 |
|
25 | 25 |
|
26 | 26 |
|
27 | 27 | <title>Getting started - Pylon Docs</title> |
28 | 28 |
|
29 | 29 |
|
30 | 30 |
|
31 | | - <link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css"> |
| 31 | + <link rel="stylesheet" href="../../assets/stylesheets/main.4af4bdda.min.css"> |
32 | 32 |
|
33 | 33 |
|
34 | 34 | <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css"> |
|
409 | 409 |
|
410 | 410 |
|
411 | 411 | <span class="md-ellipsis"> |
412 | | - 0 - Getting started |
| 412 | + Getting started |
413 | 413 |
|
414 | 414 | </span> |
415 | 415 |
|
|
443 | 443 |
|
444 | 444 |
|
445 | 445 | <span class="md-ellipsis"> |
446 | | - 1 - Your first item |
| 446 | + Your first item |
447 | 447 |
|
448 | 448 | </span> |
449 | 449 |
|
|
454 | 454 | <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false"> |
455 | 455 | <label class="md-nav__title" for="__nav_3_2"> |
456 | 456 | <span class="md-nav__icon md-icon"></span> |
457 | | - 1 - Your first item |
| 457 | + Your first item |
458 | 458 | </label> |
459 | 459 | <ul class="md-nav__list" data-md-scrollfix> |
460 | 460 |
|
|
753 | 753 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> |
754 | 754 |
|
755 | 755 | <li class="md-nav__item"> |
756 | | - <a href="#before-contributing" class="md-nav__link"> |
| 756 | + <a href="#how-to-get-started" class="md-nav__link"> |
757 | 757 | <span class="md-ellipsis"> |
758 | | - Before contributing |
| 758 | + How to get started |
759 | 759 | </span> |
760 | 760 | </a> |
761 | 761 |
|
762 | 762 | </li> |
763 | 763 |
|
764 | 764 | <li class="md-nav__item"> |
765 | | - <a href="#how-to-get-started" class="md-nav__link"> |
| 765 | + <a href="#submitting-your-contributions" class="md-nav__link"> |
766 | 766 | <span class="md-ellipsis"> |
767 | | - How to get started |
| 767 | + Submitting your contributions |
768 | 768 | </span> |
769 | 769 | </a> |
770 | 770 |
|
|
786 | 786 | </span> |
787 | 787 | </a> |
788 | 788 |
|
789 | | -</li> |
790 | | - |
791 | | - <li class="md-nav__item"> |
792 | | - <a href="#submitting-your-contributions" class="md-nav__link"> |
793 | | - <span class="md-ellipsis"> |
794 | | - Submitting your contributions |
795 | | - </span> |
796 | | - </a> |
797 | | - |
798 | 789 | </li> |
799 | 790 |
|
800 | 791 | <li class="md-nav__item"> |
|
872 | 863 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> |
873 | 864 |
|
874 | 865 | <li class="md-nav__item"> |
875 | | - <a href="#before-contributing" class="md-nav__link"> |
| 866 | + <a href="#how-to-get-started" class="md-nav__link"> |
876 | 867 | <span class="md-ellipsis"> |
877 | | - Before contributing |
| 868 | + How to get started |
878 | 869 | </span> |
879 | 870 | </a> |
880 | 871 |
|
881 | 872 | </li> |
882 | 873 |
|
883 | 874 | <li class="md-nav__item"> |
884 | | - <a href="#how-to-get-started" class="md-nav__link"> |
| 875 | + <a href="#submitting-your-contributions" class="md-nav__link"> |
885 | 876 | <span class="md-ellipsis"> |
886 | | - How to get started |
| 877 | + Submitting your contributions |
887 | 878 | </span> |
888 | 879 | </a> |
889 | 880 |
|
|
905 | 896 | </span> |
906 | 897 | </a> |
907 | 898 |
|
908 | | -</li> |
909 | | - |
910 | | - <li class="md-nav__item"> |
911 | | - <a href="#submitting-your-contributions" class="md-nav__link"> |
912 | | - <span class="md-ellipsis"> |
913 | | - Submitting your contributions |
914 | | - </span> |
915 | | - </a> |
916 | | - |
917 | 899 | </li> |
918 | 900 |
|
919 | 901 | <li class="md-nav__item"> |
|
947 | 929 | <h1 id="getting-started">Getting started</h1> |
948 | 930 | <p>Pylon Core is written in <a href="https://kotlinlang.org/">Kotlin</a>, a language similar to Java, but with more modern features and concise syntax. If you know Java, you'll be able to pick up Kotlin very quickly.</p> |
949 | 931 | <p>Pylon Base is written in Java.</p> |
950 | | -<h2 id="before-contributing">Before contributing</h2> |
951 | | -<p>We strongly suggest joining our Discord server and having a chat with us before contributing to Pylon Core or Pylon Base. This is for a few reasons:</p> |
952 | | -<ul> |
953 | | -<li>It's easy to get overwhelmed at first. However, there's always plenty to do, and we can help you find tasks that are suitable for a newcomer and help you ease into Pylon development rather than diving in at the deep end. We can also support you when you get stuck.</li> |
954 | | -<li>It's best check with the Pylon team before making any changes beyond simple bug fixes, because we might already have something planned out that won't fit well with your changes. We don't want your effort to go to waste!</li> |
955 | | -</ul> |
956 | 932 | <h2 id="how-to-get-started">How to get started</h2> |
957 | | -<p>You should follow these steps regardless of whether you want to work on Pylon Base or Pylon Core.</p> |
958 | 933 | <ol> |
959 | | -<li>Clone the <code>pylon</code> repository: <code>git clone https://github.com/pylonmc/pylon</code> (or use a GUI like Github Desktop).</li> |
| 934 | +<li>Clone the <code>pylon</code> repository: <code>git clone https://github.com/pylonmc/pylon</code> (or use a GUI like Github Desktop)</li> |
960 | 935 | <li>If you're using IntelliJ, it'll set everything up automatically. If not, run <code>./gradlew</code>. This will clone the <code>pylon-core</code> and <code>pylon-base</code> repositories.</li> |
961 | 936 | <li>If you want to submit your changes to the Pylon project, <strong>delete the pylon-core or pylon-base directory (depending on which one you want to contribute to), fork the pylon-core or pylon-base repository, and clone your fork into the same directory.</strong> Otherwise, you won't be able to open a pull request with your changes (unless you're a Pylon developer and have access to the Pylon repositories).</li> |
962 | 937 | <li>To run the tests, open the Gradle menu in IntelliJ, click 'pylon' -> 'pylon' -> 'Tasks' -> 'run paper' -> 'runLiveTests'. If you're not using IntelliJ, run <code>./gradlew runLiveTests</code>. This will start a server and run the test addon.</li> |
963 | 938 | <li>To run a server with your local versions of <code>pylon-core</code> and <code>pylon-base</code>, open the Gradle menu in IntelliJ, click 'pylon' -> 'pylon' -> 'Tasks' -> 'run paper' -> 'runSnapshotServer'. If you're not using IntelliJ, run <code>./gradlew runSnapshotServer</code>. This will start a server which you can then join by connecting to <code>localhost</code> from Minecraft. The server's files will be located in the <code>run</code> directory.</li> |
964 | 939 | </ol> |
| 940 | +<h2 id="submitting-your-contributions">Submitting your contributions</h2> |
| 941 | +<p>We generally welcome contributions for both Core and Base, but it's best check with the Pylon team before making any major changes, because we might already have something planned out that won't fit well with your changes. Hop on our Discord server and have a chat with us if you're interested in doing anything major, or have any questions about contributing :)</p> |
| 942 | +<p>Once you're done with your changes, open a pull request and give some information about what you did and why you did it.</p> |
965 | 943 | <h2 id="pylon-master-repository">Pylon master repository</h2> |
966 | 944 | <p>Pylon has a master repository that contains both <code>pylon-core</code> and <code>pylon-base</code>. This allows you to run base using your very own home-baked version of core, which allows you to test new features much more easily. This is what the 'How to get started' section used. We recommend you make changes to both base and core using the master repository, and the rest of this guide will assume you're using it.</p> |
967 | 945 | <h2 id="tests">Tests</h2> |
968 | | -<p>Pylon core has a set of integration tests. Tests should only be added for critical functionality such as block storage and recipes. You should not have to worry about tests unless you're changing something deep inside the project.</p> |
969 | | -<h2 id="submitting-your-contributions">Submitting your contributions</h2> |
970 | | -<p>Once you're done with your changes, open a pull request on the relevant project (or both Core and Base, if you've modified both) and give some information about what you did and why you did it.</p> |
| 946 | +<p>Pylon core has a set of integration tests. Tests should only be added for critical functionality such as block storage and recipes.</p> |
971 | 947 | <h2 id="im-stuck-what-next">I'm stuck, what next?</h2> |
972 | 948 | <ol> |
973 | 949 | <li>If it's Pylon specific, check if it's in the docs. If it's not Pylon specific, google it.</li> |
@@ -1023,10 +999,10 @@ <h2 id="im-stuck-what-next">I'm stuck, what next?</h2> |
1023 | 999 |
|
1024 | 1000 |
|
1025 | 1001 |
|
1026 | | - <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> |
| 1002 | + <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> |
1027 | 1003 |
|
1028 | 1004 |
|
1029 | | - <script src="../../assets/javascripts/bundle.56ea9cef.min.js"></script> |
| 1005 | + <script src="../../assets/javascripts/bundle.c8b220af.min.js"></script> |
1030 | 1006 |
|
1031 | 1007 |
|
1032 | 1008 | </body> |
|
0 commit comments