Skip to content

Commit daa2225

Browse files
committed
docs: update README, CHANGELOG, LICENSE and others
The repo has migrated from rx-modules/language-mcfunction to MinecraftCommands/syntax-mcfunction.
1 parent 75e4e34 commit daa2225

File tree

4 files changed

+24
-14
lines changed

4 files changed

+24
-14
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## v0.3.1
4+
5+
- Update name to `syntax-mcfunction`
6+
- Move to `MinecraftCommands` organization
7+
38
## v0.3.0
49

510
- Added support for Sublime Text

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023-2023 RitikShah
3+
Copyright (c) 2023-2023 MinecraftCommands
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# language-mcfunction
1+
# syntax-mcfunction
22

33
> **Warning**
4-
> This repo is heavily under construction and is targeting the 1.20.2 (23w31a snapshot)
4+
> This syntax is in **beta** targeting Minecraft 1.20.2+
55
66
![demo](imgs/demo.png)
77

88
## Goals
99

10-
The aim of this repo is to provide a general, feature complete language spec for Minecraft commands. It is **not** geared towards error checking or the specific commands.
10+
The aim of this syntax definition is to provide a general, feature complete language spec for Minecraft commands. It is **not** geared towards error checking or the specific commands and specifically contains **zero** error highlighting, allowing for decent hightlighting of invalid or custom pre-processed command scripts.
11+
12+
## TODOs
1113

1214
- [x] Add explicit macro support
13-
- [x] Add macro lines
14-
- [x] ~~Disable quoting~~ (not needed)
15-
- [ ] Fix issues with nbt types
15+
- [ ] Fix issues with nbt and other suffixes on numbrs
1616
- [ ] Fix issues on resource names versus keywords
17-
- [ ] Likely will need to combine them to some extent
17+
- Specifically when using dotted names
1818

1919
## Installing
2020

2121
### VSCode
2222

23-
1. Grab the `.vsix` extension from [here](https://github.com/rx-modules/language-mcfunction/releases).
23+
1. Grab the `.vsix` extension from [here](https://github.com/MinecraftCommands/syntax-mcfunction/releases).
2424
2. Drag and drop it into VSCode (any folder).
2525
3. Right click the file and click "Install Extension VSIX".
2626

@@ -31,10 +31,15 @@ The aim of this repo is to provide a general, feature complete language spec for
3131
It is recommended you use [Package Control](https://packagecontrol.io/) to manage the package:
3232

3333
1. [Install Package Control](https://packagecontrol.io/installation) if it is not already present.
34-
2. Run the `Package Control: Add Repository` [command](https://packagecontrol.io/docs/usage) and enter `https://github.com/rx-modules/language-mcfunction.git` to add the repository as a package.
35-
3. Run the `Package Control: Install Package` and search for `language-mcfunction` to install it as you would a normal package.
34+
2. Run the `Package Control: Add Repository` [command](https://packagecontrol.io/docs/usage) and enter `https://github.com/rx-modules/syntax-mcfunction.git` to add the repository as a package.
35+
3. Run the `Package Control: Install Package` and search for `syntax-mcfunction` to install it as you would a normal package.
36+
37+
<details><summary> If you already had language-mcfunction </summary>
38+
39+
> **Note**
40+
> You might want to remove Arc's language-mcfunction if you have it installed. You can do that via `Package Control: Remove Repository` and selecting https://github.com/Arcensoth/language-mcfunction then `Package Control: Remove Package` and selecting `language-mcfunction` from 2021.
3641
37-
> Note: You might need to remove Arc's language-mcfunction if you have it installed. You can do that via `Package Control: Remove Repository` and selecting https://github.com/Arcensoth/language-mcfunction then `Package Control: Remove Package` and selecting `language-mcfunction` from 2021.
42+
</details>
3843

3944
This will keep the package updated with the repository automatically.
4045

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
"name": "mcfunction-tmlang",
33
"displayName": "MCFunction Language",
44
"description": "MCFunction",
5-
"author": "rx97",
5+
"author": "MinecraftCommands",
66
"private": true,
7-
"version": "0.3.0",
7+
"version": "0.3.1",
88
"license": "MIT",
99
"repository": {
1010
"type": "git",

0 commit comments

Comments
 (0)