Bukkit

@uncovery

Currently, it is not possible to create custom control blocks with revo expressions. Right now, the only way to implement custom blocks is to create a MinecartRevolution plugin (if you want to do that, take a look at the MinecartRevolutionTags source code for some information on how to write plugins).

Here's some technical information on RevoScript:

• Each expression has the following format: [+/-] <command> [argument]
• By using + or - in front of the expression, it will be executed each time the minecart moves (being in motion for one tick).
• +/- can be used with and without an argument. If there's no argument, all expressions with the given command are removed. If there's an argument, only the expression with the given command and argument are removed. See the samples for more information on this.
• Variables (internally, they are called constants) can be written in the format $<variable>.
• If you are able to read Java code, you can take a look at this page which lists all available commands.
• You can also take a look at this page which lists all available variables.

Here're some sample expressions (note that both the long and short forms of the commands are provided):

# Set the weather of the world the minecart is in to "sunny".
weather sun
w sun

# Permanently set the speed of a passing minecart to 0.3.
# That means that the minecart will keep that speed forever.
+ speed 0.3
+ sp 0.3

# Remove the speed setting of the previous expression.
- speed
- sp

# Print the current location coordinate of the minecart to the passenger (multiple variables are used here).
announce $x,$y,$z
a $x,$y,$z

# Add the flames effect to the minecart.
+ effect flames
+ ef flames

# Add the smoke effect to the minecart.
+ effect smoke
+ ef smoke

# Remove the flames effect without removing the smoke effect.
- effect flames
- ef flames

Some more information can be found in this comment.

The latest development build (go here and click on the big red button on the right) fixes some minor bugs. However, it has not yet been checked by the bukkit staff.

@rustyshakelford2

We're currently setting up the wiki pages. There will be some documentation on the control sign part soon :)

@pulpius

It's great that you try to create a documentation for MR! Sadly, I don't have enough time to create a wiki or any kind of documentation by myself, so it's good news that you want to do that :)

Effect

The effect command can be used for playing effects (particles, some sounds, lighting strikes, explosion particles etc.). The expression command is "effect <effect here>", the sign syntax is:

[Effect]
[+/-] <effect>

The second line also applies to the third and fourth line, the "+" or "-" in front of the effect just means "add or remove the effect from the minecart" and is equal to a + or - in front of an expression. Have fun playing around! (you can get the available effects from the "com.quartercode.minecartrevolution.basicexpressions.util.EffectUtil" class in "basicexpressions")

Sensor

The sensor command can be used for detecting different states of a minecart ("terms"), like if there's a player in it or if the passenger is holding a specific item. It outputs signals to levers which are attached to a block that is located near the sign. The system is too deep for a quick rundown, my solution for that is put after this list.

File

Yes, the file sign can be used for executing scripts. You can put text files which have the ending ".revo" into the "plugins/MinecartRevolution/scripts" folder and write a file control sign like:

[File]
<file name without .revo ending>

Such script files are simple sequences of expression commands like:

+ speed 0.1
+ effect flames
+ effect smoke
lock +

The script above would set the speed of the minecart to 0.1 every tick. It will also spawn flames and smpke every tick and lock the minecart once.

You can see that a "+" in front of a command lets the minecart execute the command every tick, it "adds" the command to the minecart. You can also remove added commands by using a "-" and the command:

- speed
- effect flames

Note that you don't need the command parameter when using "-", it is optional. If you don't provide a parameter, every added command with the provided command name will be removed. If the "- effect flames" would be replaced with just "- effect", the smoke effect would be removed as well.

Revo

You can also use the "[Revo]" sign to implement small scripts. You will use this sign most of the times you want to use the RevoScript expressions.

You can put script lines on the second, third and fourth line, but they could also be empty. In order to use up less space (the character amount of a sign is somewhat limited), you can use shortcuts for all of the available expression commands. The script from above would look like this on a sign (without the second effect command):

+ sp 0.1
+ ef flames
l +

Hope you understood that :)

My Test World

You can download by test world here in order to check out most of the implemented features:

Link Removed: http://www.mediafire.com/download/xevg22zgeyl7bxv/MinecartRevolutionTest.zip

Question

Since you already try to create a documentation for MinecartRevolution, would you like to write the official wiki for MR (or at least some parts of it, if you don't feel to motivated)? As mentioned in the beginning, I sadly don't have enough time for writing docs, so would you like to do that?

- LoadingByte/QuarterCode

@pulpius

That's a great idea, I totally forgot about that.
It'll be fun to play around with different algorithms in order to achieve a nice routing. Thank you for the tip!

And of course, thank you for the testing! I forgot to check the whole container logic before releasing.