Skip to content

Commit d701052

Browse files
authored
Update README.md
1 parent 2337f08 commit d701052

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,31 @@
11
# Minecraft Text Editor
22

3-
This is an online Minecraft Text Component WYSIWYG editor, updated for modern versions, and easy-to-use, written in SvelteKit and TypeScript.
3+
This is an online and open source Minecraft Text Component WYSIWYG editor, updated for modern versions, and easy-to-use, written in SvelteKit and TypeScript.
4+
5+
Check it out at: https://text.datapackhub.net/
46

57
![image](https://github.com/user-attachments/assets/2c16718a-c8dd-49cc-9eb5-90167834e76e)
68

9+
:eyes: To prove it works, the generated text from the image above is below:
10+
11+
```
12+
["",{italic:true,text:"so many"}," ",{color:"yellow",text:"cool features!"},"\n- ",{bold:true,text:"bold"},", ",{italic:true,text:"italic"},", ",{strikethrough:true,text:"strikethrough"},", ",{underlined:true,text:"underlined"},", obfuscated\n- ",{color:"red",text:"any "},{color:"blue",text:"colours "},"(",{color:"#DD7171",text:"including custom colours"},") and ",{shadow_color:34047,text:"shadow colours"},"\n- ",{underlined:true,text:"",extra:[{color:"#f22f24",text:"c"},{color:"#f23922",text:"r"},{color:"#f24421",text:"e"},{color:"#f34e1f",text:"a"},{color:"#f3581e",text:"t"},{color:"#f3621c",text:"e"},{color:"#f36c1b",text:" "},{color:"#f37719",text:"g"},{color:"#f38118",text:"r"},{color:"#f48b16",text:"a"},{color:"#f49515",text:"d"},{color:"#f49f13",text:"i"},{color:"#f4aa12",text:"e"},{color:"#f4b410",text:"n"},{color:"#f4be0f",text:"t"},{color:"#f4c80d",text:"s"},{color:"#f5d20c",text:" "},{color:"#f5dd0a",text:"t"},{color:"#f5e709",text:"o"},{color:"#f5f107",text:"o!!!"}]},"\n- ",{bold:true,text:"custom sources"}," (",{color:"red",text:"nbt"},", ",{color:"gold",text:"scores"},", ",{color:"yellow",text:"translate keys"},", ",{color:"dark_green",text:"selectors"},", ",{color:"blue",text:"keybinds"},")\n- ",{text:"click events like this",click_event:{action:"open_url",url:"https://text.datapackhub.net/"}},"\n- ",{text:"hover events like this",hover_event:{action:"show_text",value:"i'm a hover event!"}},"\n- export to ",{color:"yellow",underlined:true,text:"json"}," and ",{color:"light_purple",underlined:true,text:"lore item components"}," (as well as normal nbt)\n- ",{color:"light_purple",underlined:true,text:"import from nbt into the editor"},"\n- save and load so you never lose your work\n\n",{color:"yellow",text:"check it out:"}," ",{color:"aqua",underlined:true,text:"https://text.datapackhub.net",click_event:{action:"open_url",url:"https://text.datapackhub.net"}}]
13+
```
14+
15+
## Bugs and feature requests
16+
17+
If you find a bug or have feature ideas or requests, please create an issue. It'll be considered and might become a reality!
18+
719
## Contribution
820

9-
Do not bother.
21+
Contributions are welcome! For general changes and fixes, please submit a pull request to the `main` branch. Or, if your pull request is specifically related to an indev feature, submit it to a `feature/*` branch.
22+
23+
Make sure you've tested the code locally before making any pull requests!!
24+
25+
### Local Environment
26+
27+
To develop locally, you will need node.js and a package manager (like npm, pnpm, etc).
28+
29+
1. Pull the code onto your local machine
30+
2. Download required packages by running `npm i` (or `pnpm i`, or `bun i`)
31+
3. Start the dev server with `npm run dev`. Info about the server will be visible in the console.

0 commit comments

Comments
 (0)