Add Getting started tutorial and link it between pages #64
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. Nice work! just couple notes:
<p class="subtitle">
Skript requires Spigot to work. You heard it right, CraftBukkit does not work. <a
href="https://papermc.io/">Paper</a>, which is a fork of Spigot, is recommended; it is required for some parts of
Skript to be available.
- </p>
- <p class="subtitle">
Skript supports only the latest patch versions of Minecraft. For example, this means that if 1.16.5 is supported,
then 1.16.4 is not. Testing with all old patch versions is not feasible for us.
</p>
<p class="subtitle">
Skript requires Spigot to work. You heard it right, CraftBukkit does not work. <a
href="https://papermc.io/">Paper</a>, which is a fork of Spigot, is recommended; it is required for some parts of
Skript to be available.
+ <br>
Skript supports only the latest patch versions of Minecraft. For example, this means that if 1.16.5 is supported,
then 1.16.4 is not. Testing with all old patch versions is not feasible for us.
</p>There was a problem hiding this comment. Done. I replaced "Paper server", but two occurrences where I would like to leave the "Paper":
There was a problem hiding this comment. For me, it was a pain to figure out that I needed to use the "Spigot compatible" server. If you are not against, I would keep this information wherever it is possible. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| <h1 id="nav-title">Getting started</h1> | ||
|
|
||
| <div id="content-no-docs" class="no-left-panel"> | ||
| <div style="padding-top: 32px;"></div> <!-- Space --> | ||
| <p> | ||
| To run a custom <code>.sk</code> script from <code>plugins/Skript/scripts</code>, you should add the Skript plugin to the | ||
| Minecraft server. | ||
| </p> | ||
| <h2 class="title">Requirements</h2> | ||
| <p class="subtitle"> | ||
| Skript requires Spigot to work. You heard it right, CraftBukkit does not work. <a | ||
| href="https://papermc.io/">Paper</a>, which is a fork of Spigot, is recommended; it is required for some parts of | ||
| Skript to be available. | ||
| <br /> | ||
| Skript supports only the latest patch versions of Minecraft. For example, this means that if 1.16.5 is supported, | ||
| then 1.16.4 is not. Testing with all old patch versions is not feasible for us. | ||
| <br /> | ||
| Minecraft 1.12 and earlier are not, and will not be supported. New Minecraft versions will be supported as soon as | ||
| possible. | ||
| </p> | ||
| <h2 class="title">Downloading Skript</h2> | ||
| <p class="subtitle"> | ||
| You can find the downloads for each version with their release notes in the <a | ||
| href="https://github.com/SkriptLang/Skript/releases">releases page</a> (scroll down to the Assets section and | ||
| download the <code>.jar</code> file). | ||
| <br /> | ||
| Two major feature updates are expected each year in January and July, with monthly patches occurring in between. For | ||
| full details, please review our <a | ||
| href="https://github.com/SkriptLang/Skript/blob/master/CLOCKWORK_RELEASE_MODEL.md">release model</a>. | ||
| </p> | ||
| <h2 class="title">Adding plugin</h2> | ||
| <p class="subtitle"> | ||
| Follow these simple steps to add Skript plugin to the Minecraft server: | ||
| <br /> | ||
| <!-- Sorry, for the !important inline styling, but the subtitle class already overrides the padding and I am not going to do the css clean-up now. --> | ||
| <ol class="subtitle" style="padding-left: 52px !important;"> | ||
| <li> | ||
| Ensure the file you have downloaded ends in <code>.jar</code>. Some plugins also distribute as <code>.zip</code> | ||
| files, in which case you will need to extract the file and locate the <code>.jar</code> for your platform. | ||
| </li> | ||
| <li> | ||
| Once you have downloaded the plugin, locate the <code>plugins</code> folder from the root directory of | ||
| your Minecraft server. | ||
| </li> | ||
| <li> | ||
| Drag and drop the plugin file (<code>.jar</code>) into the <code>plugins</code> folder. | ||
| </li> | ||
| <li> | ||
| Restart your server. The plugin should load. | ||
| </li> | ||
| </ol> | ||
| </p> | ||
| <p class="subtitle"> | ||
| <!-- Separated into paragraph, otherwise it is black text on gray background. --> | ||
| For more information see <a href="https://docs.papermc.io/paper/adding-plugins">the Paper tutorial</a>. | ||
| </p> | ||
|
|
||
| <h2 class="title">Adding the first script</h2> | ||
| <p class="subtitle"> | ||
| Once you have started the server, you should see the folder <code>scripts</code> inside of <code>plugins/Skript</code> | ||
| folder. | ||
| <br /> | ||
| Just create <code>a-new-file.sk</code> file with the following example code: | ||
| <br /> | ||
| <pre class="box skript-code-block left-margin"> | ||
| on click: | ||
| message "Hello player!" to player</pre> | ||
| </p> | ||
| <p class="subtitle"> | ||
| <!-- Separated into paragraph, otherwise it is black text on gray background. --> | ||
| This piece of code displays the message "Hello player!" every time the user "clicks" (i.e. performs the mine action). | ||
| For more examples see the <code>examples</code> folder inside <code>plugins/Skript/scripts</code>. | ||
| </p> | ||
|
|
||
| <div id="info" class="grid-container padding"> | ||
| <div class="grid-item"> | ||
| <p class="box-title">Previous step</p> | ||
| <p class="box placeholder"><a class="link" href="index.html">Introduction</a></p> | ||
| </div> | ||
| <div class="grid-item"> | ||
| </div> | ||
| <div class="grid-item"> | ||
| <p class="box-title">Next step</p> | ||
| <p class="box placeholder"><a class="link" href="text.html">Text and formatting</a></p> | ||
| </div> | ||
| </div> | ||
| <div style="padding-top: 32px;"></div> <!-- Space --> | ||
| </div> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we should specify such things here in case it gets changed later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I may, I would disagree. I found the information in the readme. I'm new to MC development, and I Installed a different and incompatible server because I was missing this information.