Skript Enhancements #2519

Olyno · 2019-10-04T23:29:06Z

Description

All referenced issues in #2506 have been fixed in this pull request.

Target Minecraft Versions: none
Requirements: none
Related Issues: #2506

This reverts commit ceb2dd8

This reverts commit 1467fd0

Matocolotoe

Wow, incredible work, just a few things that might need to be fixed

src/main/resources/scripts/vanilla gui.sk

FranKusmiruk · 2019-10-05T14:41:30Z

src/main/resources/scripts/teleport with compass.sk

-aliases:
-	# blocks without collision as of Minecraft 1.5 (excluding fire, nether portal & end portal)
-	nonsolid = 0, 6, 27, 28, 30, 31, 32, 37, 38, 39, 40, 50, 55, 59, 63, 64, 65, 66, 68, 69, 70, 71, 72, 75, 76, 77, 78:0, 83, 85:4-7, 104, 105, 106, 111, 115, 131, 132, 141, 142, 143, 147, 148, 157
-
 on rightclick with compass:
 	player has permission "skript.teleport"
 	loop blocks above targeted block:


I'd rather use a simple if check rather than the where filter, it'd confuse new people.

Yeah so the condition has to be brought back in

But how nonsolid blocks are usefull here? I mean, I did tests without this condition and it works really well.

Does it not prevent the player from being teleported inside a block ?
Also I think you should format the condition with if like you did in other examples

When you use if word, you are supposed to follow with the else part, or you just use it as "code block" so here you are not supposed to use the if word because it's an "affirmative" condition (so if this condition is not respected, it will not continue the code)

Yeah that's what I do but I would write it there as a convention, in Java or Python you cannot omit it

src/main/resources/scripts/vanilla gui.sk

src/main/resources/scripts/homes.sk

FranKusmiruk · 2019-10-05T14:41:30Z

src/main/resources/scripts/teleport with compass.sk

-aliases:
-	# blocks without collision as of Minecraft 1.5 (excluding fire, nether portal & end portal)
-	nonsolid = 0, 6, 27, 28, 30, 31, 32, 37, 38, 39, 40, 50, 55, 59, 63, 64, 65, 66, 68, 69, 70, 71, 72, 75, 76, 77, 78:0, 83, 85:4-7, 104, 105, 106, 111, 115, 131, 132, 141, 142, 143, 147, 148, 157
-
 on rightclick with compass:
 	player has permission "skript.teleport"
 	loop blocks above targeted block:


I'd rather use a simple if check rather than the where filter, it'd confuse new people.

Whimsyturtle · 2019-10-06T02:27:02Z

Should probably configure your git to not treat every file as being completely different so we can actually tell what was modified :P

Matocolotoe · 2019-10-06T09:41:14Z

The files changed section is displayed by GitHub itself

Whimsyturtle · 2019-10-06T10:05:46Z

According to https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-algorithmpatienceminimalhistogrammyers you can?

Matocolotoe · 2019-10-06T10:09:37Z

Didn't know that was possible but it still seems weird 🤔

Co-Authored-By: Giovanni <42092549+Matocolotoe@users.noreply.github.com>

bensku

Note: I didn't review the example script changes yet. This review is only for documentation site changes.

bensku · 2019-10-08T15:39:21Z

docs/README.md

-You can also include other files by using ${include <filename>}. Just please make
-sure that those included files don't have tags which are not allowed in position
-where include is called.
+**Using NPM:**


People exporting documentation should not be required to install anything in addition to Minecraft server + Java.

I'll clarify this a bit: currently, on Linux, Windows and Mac, Skript needs JDK 8 or newer to be compiled. Gradle wrapper provides Gradle, which in turn provides all compile-time dependencies. So, only JDK needed to produce a usable jar.

Spigot installation is, at the moment, needed for generating documentation. We could probably get rid of this, though, and just prepare classpath with dependencies (Guava, etc.) in build script.

Documentation should be not related to any minecraft server

the doc site is generated within the plugin itself, so it runs where the plugin runs (a minecraft server)

bensku · 2019-10-08T15:40:10Z

docs/README.md

-which provides head element, navigation bar and so on.
+ * Bulma
+ * FontAwesome
+ * Svelte


Documentation website must work without Javascript, or at very least there must be alternative that works.

Modern websites use javascript. What's the problem with javascript?

It is not necessary for static pages. For dynamic features such as search, there is no alternative.

Agree with you. But modern technologies (as react, and here svelte) use javascript to create modules. These modules are render on the website directly. So without javascript, Svelte, react and more component technologies will not work.

At least React supports rendering static content on server. Most frameworks do, though I don't know about Svelte.

Svelte too. Svelte is compiled using a bundler (as webpack or my favorite, rollup) into a static js file, what the website is using.

in this context, static doesn't mean that the files are the same every time - it means that the site has no dynamic content (like DOM manipulation and such via JS). The reason we don't want JS is because it just isn't necessary - it increases page load and parse times for no real benefit for a site as simple as Skript's docs.

I'm agree with you, but we could add more features later, that's the reason of my choice.
I forgot to say that the size doesn't matter. Sapper uses service workers and cache any content. So the javascript is cached into the client's browser. It's really faster. Plus, svelte is probably the smaller javascript librairy existing (comparing to react, vue etc...)

Web browsers are pretty good at caching static pages too. What I'd like to see is static pages with dynamic features implemented in JS. If that is not feasible, static pages when JS is not enabled, otherwise everything done with JS. If even that can't be done, two sites for browsing docs wouldn't be any worse than current situation. In fact, I suggested the last option when you were initially working on this PR.

docs/static/bulma.css

Matocolotoe · 2019-10-10T16:50:58Z

src/main/resources/scripts/simple join and leave message.sk

+# A join and leave message.
+#
+
+command /set <string> message <text>:


Suggested change

command /set <string> message <text>:

command /set <text> message <text>:

Should be better to use string instead of text type right?

Skript handles both but at least if you want to use one in particular, use it everywhere

Yeah I missed to change the 2nd text with string. I will fix that.

Matocolotoe · 2019-10-10T16:51:06Z

src/main/resources/scripts/simple join and leave message.sk

+		else:
+			message "Only 'join' and 'leave' messages are available here."
+
+command /show <string> message:


Suggested change

command /show <string> message:

command /show <text> message:

ShaneBeee · 2019-10-11T06:25:01Z

docs/src/utils/developers.json

+            "Skript maintainer",
+            "Skript Developer"
+        ]
+    },
+    "FranKusmiruk": {
+        "avatar": "https://avatars3.githubusercontent.com/u/48283695?s=400&v=4",
+        "roles": [
+            "Skript Developer"
+        ]
+    },
+    "Pikachu920": {
+        "avatar": "https://avatars0.githubusercontent.com/u/28607612?s=400&v=4",
+        "roles": [
+            "Skript Developer"
+        ]
+    },
+    "Nicofisi": {
+        "avatar": "https://avatars2.githubusercontent.com/u/12614053?s=400&v=4",
+        "roles": [
+            "Skript Developer"
+        ]
+    },
+    "TheBentoBox": {
+        "avatar": "https://avatars3.githubusercontent.com/u/6902229?s=400&v=4",
+        "roles": [
+            "Issue tracker manager",
+            "Aliases developer"


Consistency seems a little off in terms of casing.
You have Skript Developer and then Skript maintainer
I recommend sticking with upper casing for each word, but thats just my opinion.
If not, then lower case developer to match the rest.

TPGamesNL · 2019-10-11T12:48:23Z

docs/src/utils/tutorials.json

+        "description": "What is a loop? And how make loops in Skript? Look here!"
+    },
+    "Functions": {
+        "description": "The most usefull thing in any language: functions!"


Suggested change

"description": "The most usefull thing in any language: functions!"

"description": "The most useful thing in any language: functions!"

TPGamesNL · 2019-10-11T12:48:40Z

docs/src/utils/tutorials.json

+        "description": "The most usefull thing in any language: functions!"
+    },
+    "Custom Commands": {
+        "description": "The most usefull thing in Skript: custom commands!"


Suggested change

"description": "The most usefull thing in Skript: custom commands!"

"description": "The most useful thing in Skript: custom commands!"

Olyno · 2019-10-13T17:25:48Z

I close this pull request to split it better and make it more easily to review. Thanks to everyone who reviewed this pull request.

Olyno and others added 13 commits September 30, 2019 07:59

Added scripts tests support

ceb2dd8

Fix disabled names of examples

1467fd0

Resolve issues #1253 #1429 #2425 and #611

98d9342

Fix base name of documentation

28242dc

Added some precisions about how export website

e61d6f4

Resolve #2252: outdated skript default examples

a883b16

Resolve #1825: info command

cba3d48

Revert "Added scripts tests support"

8b253c9

This reverts commit ceb2dd8

Revert "Fix disabled names of examples"

0915b28

This reverts commit 1467fd0

Fix "info" command description

f4096cc

Fix "syntaxes cards" in the documentation (website)

b478f4f

Fix scroll issue with the website

a8e736b

Put a default base name for the export command (website)

1fc67e8

Matocolotoe suggested changes Oct 5, 2019

View reviewed changes

FranKusmiruk reviewed Oct 5, 2019

View reviewed changes

Olyno and others added 2 commits October 6, 2019 20:13

Fix english grammar in "vanilla gui" example script

ee0b108

Co-Authored-By: Giovanni <42092549+Matocolotoe@users.noreply.github.com>

Fix english grammar in "home" example script

62d356b

Co-Authored-By: Giovanni <42092549+Matocolotoe@users.noreply.github.com>

bensku self-assigned this Oct 6, 2019

Fix english grammar in "vanilla gui" script example

0a472ed

Co-Authored-By: Giovanni <42092549+Matocolotoe@users.noreply.github.com>

bensku requested changes Oct 8, 2019

View reviewed changes

Whimsyturtle added the enhancement Feature request, an issue about something that could be improved, or a PR improving something. label Oct 9, 2019

Matocolotoe reviewed Oct 10, 2019

View reviewed changes

ShaneBeee reviewed Oct 11, 2019

View reviewed changes

TPGamesNL reviewed Oct 11, 2019

View reviewed changes

Olyno closed this Oct 13, 2019

	command /set <string> message <text>:
	command /set <text> message <text>:

	command /show <string> message:
	command /show <text> message:

	"description": "The most usefull thing in any language: functions!"
	"description": "The most useful thing in any language: functions!"

Skript Enhancements #2519

Skript Enhancements #2519

Conversation

Olyno commented Oct 4, 2019

Description

Matocolotoe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Matocolotoe Oct 5, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Whimsyturtle commented Oct 6, 2019

Matocolotoe commented Oct 6, 2019

Whimsyturtle commented Oct 6, 2019

Matocolotoe commented Oct 6, 2019

bensku left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Olyno Oct 11, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Olyno commented Oct 13, 2019

Matocolotoe Oct 5, 2019 •

edited

Loading

Olyno Oct 11, 2019 •

edited

Loading