You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+85-6Lines changed: 85 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,20 +10,99 @@ DFScript is a mod created for DiamondFire to allow scripting on the client. This
10
10
## About
11
11
DFScript adds the ability to add new features through the added
12
12
'scripting' ability. Scripting is constructing event based code (similar to DiamondFire) inside a client side menu, with the events and actions being simple client-based activities.
13
-
For example, a script could play a sound when the player receives a message with their name on it, or automatically add @ commands in front of sent messages.
13
+
14
+
For example, a script could play a sound when the player receives a message with their name in it, or automatically add the @ character in front of sent messages.
14
15
___
15
16
16
-
To access the scripting menu, run ``/scripts``, and a menu will appear showing all of the scripts you have installed. Here you can toggle, delete, edit and upload scripts.
17
+
To access the scripting menu, run `/scripts`, and a menu will appear showing all of the scripts you have installed. Here you can toggle, delete, edit and upload scripts.
17
18
*(A simple menu which can disable scripts can be accessed through the button in the top left.)*
18
19
19
20
To install a script you can click 'Add' and browse through scripts that others have created, or select 'New Script' if you would like to create one yourself.
20
21
21
-
## Editing Scripts
22
+
## Creating Scripts
22
23
23
-
To create a new script, run ``/script``, select 'Add', and 'New Script'. After naming your script, it will be created and displayed in the main menu. From here, you can edit, upload, delete, and toggle your script.
24
+
To create a new script, run `/script`, select 'Add', and 'New Script'. After naming your script, it will be created and displayed in the main menu. From here, you can edit, upload, delete, and toggle your script.
24
25
25
26
Here is what each of these actions do:
26
27
- Edit: From this menu, you can add options and code to your script.
27
-
- Upload: Uploads the script so that others with the mod can install and use it.
28
+
- Upload: Uploads the script so that others with the mod can install and use it. (They can not modify the code)
28
29
- Delete: Deletes your script permanently.
29
-
-**/** Toggle: Toggles your script on and off. When a script is off, it does not run at all. (Red means script is currently on, green means script is off.)
30
+
-**/** Toggle: Toggles your script on and off. When a script is off, it does not run at all. (Red means script is currently on, green means script is off)
31
+
32
+
To edit your script, select the edit icon and a new menu will be opened. From here, you can add code, change your scripts description and add config options.
33
+
___
34
+
35
+
- From here you can write a short description about your script to tell others who may use it any important information.
36
+
You can also add config options which users can change without accessing the code. The values of these options can be used in your code. (More info later)
37
+
38
+
39
+
40
+
## Interactions
41
+
**Left click**
42
+
- Use on buttons to click them
43
+
- Use to add code to your script, and to add parameters to code blocks
44
+
- Use in your script menu to edit parameters of a code block
45
+
- Use to select text box
46
+
47
+
**Right Click**
48
+
- Use on code blocks in your script menu to bring up a small menu where you can:
49
+
- Delete the code block
50
+
- Insert code before the code block
51
+
- Insert new code after the code block
52
+
- Can also be used on buttons to click them
53
+
54
+
**Escape**
55
+
- Use in any menu to go back to the previous menu
56
+
57
+
**Scroll**
58
+
- Moves a menu up and down
59
+
60
+
## Editing Scripts
61
+
*Note that it is only possible to edit code in a script you have made yourself. Any downloaded script will still be able to be deleted, toggled, and have its options changed, but the code will be inaccessible.*
62
+
63
+
Select the 'Add' button to add code to your script. From there you can select the category, and a specific code block. There is a short description about each block if you hover over them to help you understand what they do.
64
+
65
+
All code is set in one menu. Just like in DiamondFire, all code must start with an event. When that event is triggered, the code inside it will run from top to bottom.
66
+
67
+
### Changing Parameters
68
+
Most code blocks need parameters inside them so they can execute properly. You can view what parameters a code blocks needs by hovering over its icon in your script menu. An asterisk after a parameter means that a value for it is not required and the code block can run without it.
69
+
70
+
To add values for these parameters, left click on the code block you would like to edit and a menu will be brought up. Any parameters already in the code block will show. To add values, click the 'Add' button, and a new menu with a text input box will appear.
71
+
___
72
+
This input screen has two important sections.
73
+
1. The text box. Here is where you input a number, string, name of a variable or any other type of value required. Make sure you have finished the value you would like to add to your code block before selecting a type.
74
+
2. The value type. Here is where you select what type of value you would like to add to your code block. For example, if I wanted to add a variable called 'score', I would type `score` in the text box, then click on the variable icon (magma cream). A variable named 'score' will be added to the code block.
75
+
Most value types and their icons such as a text, a number and a variable you may recognise from DiamondFire, but here are some ones you may not be familiar with:
76
+
77
+
- Client Value: *(Requires no text input.)* Selecting this value will bring up a menu containing values related to the client, very similar to DiamondFire's game values.
78
+
Some of these can be used in any scenario, such as the number of the players selected hotbar slot, or the players main hand item.
79
+
Others can only used if the code is under a certain event, such as the last received message *(pairs with the 'OnRecieveChat' event)* or the last received sound *(pairs with the 'OnRecieveSound' event)*.
80
+
- Config Value: *(Requires no text input.)* Selecting this value will bring up a menu of all the config options you have added to your script. These will act as a variable and return a value of the option.
81
+
For example, if I had created Option 1 as a string, and the user had set it to `complete`, the config value for options 1 would return 'complete' as a string.
82
+
These can be nearly any value type, so pay attention to make sure the code block you are using supports the value type.
83
+
84
+
*Currently, changing the order and contents of added parameters is not supported, so you will have to delete and redo if you make a mistake.*
85
+
## Downloading Scripts
86
+
To download a script that someone else has made, open the main scripts menu, select add, and there will be a list of scripts others have made as well as a search bar. Scripts with a star next to their name mean that they are verified and safe to use.
87
+
88
+
**!! Unverified scripts may potentially be dangerous, not towards your computer, but they may make your client spam or do other activities not appreciated on DiamondFire. You can ask in the discord if you are unsure about a certain script. !!**
89
+
90
+
Selecting a script from here will bring up a menu showing information about the script such as the authors name, script ID, and if it has been approved or not.
91
+
Clicking the install button from here will add the script to your client. A message will be shown in chat verifying the script has been loaded. This downloaded script will appear in the normal scripts menu, just without the ability to upload it or edit its code.
92
+
93
+
## Commands and Files
94
+
95
+
All DFScript commands begin with `/scripts`.
96
+
-`/scripts` Opens the main script menu.
97
+
-`/scripts recursion (number)` Changes the number of events that can trigger in a single tick.
98
+
-`/scripts reload` Reloads all of the scripts on your machine. Use this is you are manually installing are changing scripts through files.
99
+
-`/scripts vars (script name)` Lists the values of all the variables in the selected script. Similar to DiamondFire's /p vars command.
100
+
101
+
To access script files go to `%appdata%\.minecraft\DFScript` on your machine. Here there will be a 'Scripts' folder, which contains all the scripts you have installed in the form of a json file. If a script manages text files, they will be in a sub folder called `scriptname.json-files`.
102
+
103
+
You can easily back up scripts here by copy and pasting the json file into another location. Pasting and deleting json files from this folder will do the same in-game, so be careful about what you change.
0 commit comments