https://github.com/skriptlang/skript-aliases
Aliases for Skript
https://github.com/skriptlang/skript-aliases
skript
Last synced: 8 months ago
JSON representation
Aliases for Skript
- Host: GitHub
- URL: https://github.com/skriptlang/skript-aliases
- Owner: SkriptLang
- Created: 2018-03-07T18:10:40.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-12T15:23:53.000Z (9 months ago)
- Last Synced: 2025-05-09T00:11:39.769Z (8 months ago)
- Topics: skript
- Homepage:
- Size: 350 KB
- Stars: 21
- Watchers: 10
- Forks: 38
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Skript Aliases
These are the new aliases for Skript, currently work in progress. If you are
looking for the plugin, you should go to the main
[repository](https://github.com/SkriptLang/Skript).
## Structure of Aliases
Aliases are laid out in multiple subfolders and files inside them. In each file,
they are put in *sections*, like code in scripts is put to triggers. Names for
sections should be descriptive and unique per-file, but other than that they do
not matter much.
In sections, most of lines will define new aliases. The basic format is quite
simple, actually:
```
carrot¦s = minecraft:carrot
```
The strange character, ¦, tells where the difference between singular and plural
is. In this case: *carrot*, *carrots*
For figuring out the ids, [Minecraft Wiki](https://minecraft.wiki/)
is probably the best place. Alternatively, you can see them ingame if you use
F3+H.
### Multiple Items and Other Aliases
Aliases may refer to multiple items by separating them with commas. They can
also refer to other aliases, which have been loaded before. For example:
```
food = minecraft:potato, carrot
```
(refers to minecraft:item_id and minecraft:some_item)
### Name Patterns
Alias names can contain optional parts and "choose one" parts. They work
similarly with Skript's syntax patterns:
```
[vegan] food = minecraft:potato, carrot # Optional part
(vegetables|food) = minecraft:potato, carrot # Choose one
```
Spaces after and before optional parts are mostly ignored. Leave them outside
of the optional parts.
### (NBT) Tags
Aliases can define NBT tags to apply for items. The tags should be in Mojang's
JSON format that Vanilla commands such as /give use. Tags are put after item
id, separated with a space:
```
mundane potion = minecraft:potion {"Potion": "minecraft:mundane"}
```
If there are multiple ids defined for an alias, each of them can have their
own tags specified before the next id is given.
### Block States
Block states can be used by appending them to the id:
```
anvil pointing north = minecraft:anvil[facing=north]
```
Note that before 1.13, **not all** block states are supported. Things that do
not have a block state in 1.13 do not work, even if they technically have it
on target Minecraft version.
Also, these are *block* states. Any data values that persist to items should be
treated as damage values and represented as a tag:
```
[raw] salmon¦s = minecraft:fish {Damage:1}
```
1.13 will mostly get rid of these items, finally leaving damage to actually be
used for, well, damage.
### Variations
Sometimes, there are multiple items that are quite similar, but still have
some differences. For example potions are like this: they all share an id, but
have their own tags. In these cases, it might make sense to define a variation:
```
{potions}:
mundane = - {"Potion": "minecraft:mundane"}
awkward = - {"Potion": "mineraft:awkward"}
{potions} potion = minecraft:potion
```
Basically, in place of {potions}, there can be either mundane or awkward. What
it is, will affect the tags of resulting item. Since all potions share an id,
we can use a hyphen instead of retyping minecraft:potion.
You can also substitute parts of ids to variations. Prefix a Minecraft id of
alias with a hyphen, and place a hyphen in ids of all variations, in place
where the replacement is desired:
```
{colored}:
white = minecraft:white_- # minecraft:white_wool
orange = minecraft:orange_- # minecraft:orange_wool
{colored} wool = -wool
```
Variations support default values, which equal to empty strings:
```
{colored}:
{default} = minecraft:white_- # White wool is just 'wool'
white = minecraft:white_-
{colored} wool = -wool
```
### Conditions
Each section that contains aliases may have a special entry to control which
Minecraft versions the aliases in said section are for. The options are
following:
```
minecraft version = 1.12 or newer # Matches a version and newer ones
minecraft version = 1.12 or older # Matches a version and previous ones
minecraft version = 1.11 to 1.12 # Matches both given versions and the versions between them
```
Of course, in reality, only one of these is allowed per section of aliases.
### Related entities
An alias can have an associated entity defined. This is used to deal with
naming conflicts. For example, if we want armor stand entity to be usable
everywhere, we need to define it as:
```
armor stand¦s = minecraft:armor_stand[relatedEntity=armor stand]
```
Note that relatedEntity is not a block state, even if it
looks like one.
## Developing Aliases (for experienced developers)
1. Fork if you don't have write access
2. Clone this in plugins/Skript, rename cloned folder to just *aliases*
3. Make your changes in correct files and folders
4. Use a text editor to modify aliases
5. Test using Spigot/Paper and Skript, without any addons
6. Open a pull request or push to this repo
## Developing Aliases (for newbies)
Since working on aliases is easy, some of you might not be familiar with Git
or Github, but still want to help. I've written this guide to make it a bit
easier.
### What you need
To contribute to aliases, you will need:
* A Git client
* Windows/Mac: get it from their [website](https://git-scm.com/)
* Linux: use your distro to install it
* A tutorial can be found [here](https://guides.github.com/introduction/git-handbook/)
* A text editor
* Anything that you use to edit scripts will do
* A Github Account
* A Minecraft server for testing
* Skript (currently a development build; can be downloaded [here](https://github.com/SkriptLang/skript-aliases/releases))
* Spigot or Paper
* No addons
### Setting Everything Up
Got them? Good. Now, go edit your config.sk in plugins/Skript. To end of the
of the file, add:
```
load default aliases: false
```
Default aliases from Skript's jar or packed aliases will not be used. Instead,
you will get the latest version of them using Git.
[Fork](https://guides.github.com/activities/forking/) this repository, unless
you have write access. Clone your forked repository in plugins/Skript. Rename
the produced folder from *skript-aliases* to just aliases.
### What Now?
If you have something you want to do, good. If not, you can check issues in
this repository to find out something you'd like to work on.
When know *what* you want to do, it is time to decide where the change goes to.
Look at the files, read their comments and try to figure that out. Usually, the
aliases files are categorized based on Minecraft creative inventory categories.
You can, and must, test your changes using Skript. Basically, reload aliases
a lot while you do your changes. Log in to the server and give items to you to
make sure your aliases work correctly. Commit using Git and push to your fork
when you get something done.
When it is all ready, open a pull request. Your change will be reviewed, and
if everything goes well, soon added to Skript's default aliases.