Getting Started

Upon running minecraft for the first time, Tweaked will created a new folder in the base directory called /Tweaked.

Inside that folder you will find a number of files/directories :

  • tweaked.cfg = Configuration file, this allows you to change the way Tweaked behaves.
  • tweaked.log = Log file, information or warnings are output here.
  • tweaked.dump = Dump file, any ingame commands output here.
  • scripts = A directory containing scripts (see below).


Commands

Commands are chat commands that the user can input while ingame in order to help creating and testing scripts.

The syntax for a command is /tweaked command arguments.

Example

# This command will print information on the currently held item
/tweaked hand

Note

/tweaked can be shortened to /tw, e.g : /tw hand


Scripts

Upon starting minecraft, Tweaked searches the /Tweaked/Scripts directory (including subdirectories) for scripts to load.

For a script to be loaded it must have the file type .tweak.

All scripts are loaded at the ModConstruction phase of minecraft, they are then deployed at the correct time by Tweaked.


Basic Scripting

Scripts consist of a number of Actions. These tell Tweaked what to do.

Actions are provided with Arguments that allow the user to pass in information.

The full syntax for an action is : action : argumentA, argumentB;.

Example

# This action will remove the recipe specific by "recipeName"
recipes.remove : "recipeName";


Variables can be used to store Arguments, allowing them to be used in Actions.

Variables can be defined using the syntax : define varName : argument;.

Once defined they can then be used in an action using the syntax : var(varName).

Example

# This does exactly the same as the previous example, except using a variable.
define testVar : "recipeName";
recipes.remove : var(testVar);

Note

Actions and Variables are case insensitive, addrecipe, addRecipe and AddRecipe all work the same.


Comments

Comments can be used to make scripts easier to understand. They will not be loaded by Tweaked and are for informational purposed only.

Comments have the syntax : #comment.

Example

# this will be completely ignored


Logging

You can print a message to the log file by using the print option, this can help with debugging your scripts.

Example

# will print Hello log file to tweaked.log
print : "Hello log file";

Note

It is possible to print any variable or argument, this can be used for instance to query defined items.


Logic - For

For loops can be used to run a block of code multiple times.

The can be defined by providing a list that will be looped and then a block of actions that will run on each action in that list.

The var keyword can be used within the logic block to call the current variable being iterated on be the for loop.

Note

For a practical example of using for loops look at the Tutorial - For Loops.

Example

for ["a", "b", "c"] {
    print : var;
}

Output : 
"a"
"b"
"c"