diff --git a/README.md b/README.md index 0378fd03da1..fe8c5e88fb0 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,8 @@ You can find more about the docs templates in [docs/templates](docs/templates/RE Currently, the docs files is generated using Skript plugin. 1. You will need to create a directory named `docs/templates` in `plugins/Skript/`, and copy everything from [docs/templates folder](docs/templates) into that directory. -2. Execute the command `/sk gen-docs`. -3. The `docs/` directory will be created _(if not created already)_ in `plugins/Skript` containing the website's files. -4. Open `index.html` and browse the documentation. -5. _(Optionally)_ Add this system property `-Dskript.forceregisterhooks` in your server startup script (before the -jar property) to force generating hooks docs. +2. Launch the server (the [Paper](https://papermc.io/), which is a fork of Spigot, is recommended). +3. Execute the command `skript gen-docs` +4. The `docs/` directory will be created _(if not created already)_ in `plugins/Skript`, containing the website's files. +5. Open `index.html` and browse the documentation. +6. _(Optionally)_ Add this system property `-Dskript.forceregisterhooks` in your server startup script (before the -jar property) to force generating docs for Skript's hooks. diff --git a/docs/templates/getting-started.html b/docs/templates/getting-started.html new file mode 100644 index 00000000000..85d25c5e5dd --- /dev/null +++ b/docs/templates/getting-started.html @@ -0,0 +1,88 @@ +

Getting started

+ +
+
+

+ To run a custom .sk script from plugins/Skript/scripts, you should add the Skript plugin to the + Minecraft server. +

+

Requirements

+

+ Skript requires Spigot to work. You heard it right, CraftBukkit does not work. Paper, which is a fork of Spigot, is recommended; it is required for some parts of + Skript to be available. +
+ 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. +
+ Minecraft 1.12 and earlier are not, and will not be supported. New Minecraft versions will be supported as soon as + possible. +

+

Downloading Skript

+

+ You can find the downloads for each version with their release notes in the releases page (scroll down to the Assets section and + download the .jar file). +
+ Two major feature updates are expected each year in January and July, with monthly patches occurring in between. For + full details, please review our release model. +

+

Adding plugin

+

+ Follow these simple steps to add Skript plugin to the Minecraft server: +
+ +

    +
  1. + Ensure the file you have downloaded ends in .jar. Some plugins also distribute as .zip + files, in which case you will need to extract the file and locate the .jar for your platform. +
    2. +
  2. + Once you have downloaded the plugin, locate the plugins folder from the root directory of + your Minecraft server. +
    3. +
  3. + Drag and drop the plugin file (.jar) into the plugins folder. +
    4. +
  4. + Restart your server. The plugin should load. +
    5. +
+

+

+ + For more information see the Paper tutorial. +

+ +

Adding the first script

+

+ Once you have started the server, you should see the folder scripts inside of plugins/Skript + folder. +
+ Just create a-new-file.sk file with the following example code: +
+ 

+      on click: 
+        message "Hello player!" to player
+

+

+ + 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 examples folder inside plugins/Skript/scripts. +

+ +
+
+

Previous step

+

Introduction

+
+
+
+
+

Next step

+

Text and formatting

+
+
+
+
\ No newline at end of file diff --git a/docs/templates/index.html b/docs/templates/index.html index 193c3834f84..9638a501cb0 100644 --- a/docs/templates/index.html +++ b/docs/templates/index.html @@ -59,6 +59,8 @@

Documentation

if you're interested in helping out.

+

Next step

+

Visit the Getting started page to learn more on how to install Skript and create your first script!

Documentation Repo • Site developed by Ayham Al-Ali • Site Version ${site-version} • Generated on ${skript.build.date}

diff --git a/docs/templates/templates/navbar.html b/docs/templates/templates/navbar.html index e2e00ca2945..376aab7620f 100644 --- a/docs/templates/templates/navbar.html +++ b/docs/templates/templates/navbar.html @@ -20,6 +20,7 @@
  • Tutorials
    • + Getting started Text
    diff --git a/docs/templates/text.html b/docs/templates/text.html index 27b5c6a306f..70246c0f271 100644 --- a/docs/templates/text.html +++ b/docs/templates/text.html @@ -343,6 +343,18 @@

    Text and Variables

    Guide written by bensku. -

    +

    +
    +
    +

    Previous step

    +

    Getting started

    +
    +
    +
    +
    +

    Next step

    +

    Explore Events

    +
    +
    \ No newline at end of file