Skip to content

Commit 9262a04

Browse files
authored
Update README.md
1 parent 3176816 commit 9262a04

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,29 @@
1-
[![Build](https://github.com/DFOnline/DFScript/actions/workflows/build.yml/badge.svg)](https://github.com/DFOnline/DFScript/actions/workflows/build.yml)
1+
![Build](https://github.com/DFOnline/DFScript/actions/workflows/build.yml/badge.svg)](https://github.com/DFOnline/DFScript/actions/workflows/build.yml)
22
# DFScript
3-
DFScript is a mod created specifically for DiamondFire to allow scripting on the client. This mod is a seperation and improvement from the shutdown mod [CodeUtilities](https://github.com/CodeUtilities/CodeUtilities)
3+
DFScript is a mod created for DiamondFire to allow scripting on the client. This mod is a seperation and improvement from the shutdown mod [CodeUtilities](https://github.com/CodeUtilities/CodeUtilities).
44

5+
- You can download DFScript from its [Github page](https://github.com/DFOnline/DFScript/releases/latest), or its [Modrinth page](https://modrinth.com/mod/dfscript).
6+
- You can report issues on [the issues tab](https://github.com/DFOnline/DFScript/issues)
57

6-
You can report issues on [the issues tab](https://github.com/DFOnline/DFScript/issues)
8+
- You can join our [discord here](https://discord.gg/gtfFwWEapx)
79

8-
You can join our [discord here](https://discord.gg/gtfFwWEapx)
10+
## About
11+
DFScript adds the ability to add new features through the added
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.
14+
___
15+
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+
*(A simple menu which can disable scripts can be accessed through the button in the top left.)*
18+
19+
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+
## Editing Scripts
22+
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+
25+
Here is what each of these actions do:
26+
- ![Edit icon](https://i.imgur.com/T01dmur.png) Edit: From this menu, you can add options and code to your script.
27+
- ![Upload icon]( https://i.imgur.com/0FuRXJ1.png) Upload: Uploads the script so that others with the mod can install and use it.
28+
- ![Delete icon](https://i.imgur.com/Ya9xyWH.png) Delete: Deletes your script permanently.
29+
- ![enter image description here](https://i.imgur.com/Av7lZmu.png)**/**![enter image description here](https://i.imgur.com/I8PXtvr.png) 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.)

0 commit comments

Comments
 (0)