Skip to content

Commit ac1f0c3

Browse files
authored
Update README
- Add project status - Add Twitter and YouTube links - Add instructions to use older GameMaker runtime - Add clarification about the program being Windows-only
1 parent 45f35ea commit ac1f0c3

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,27 @@
1818
</a>
1919
</p>
2020
<p align="center">
21-
An open source continuation of Minecraft Note Block Studio with exciting new features!
21+
An open-source continuation of Minecraft Note Block Studio with exciting new features!
2222
</p>
2323

2424
### Download
25-
You can download Open Note Block Studio [here](https://github.com/OpenNBS/OpenNoteBlockStudio/releases/latest).
26-
You can either download it as an `.exe` installer (recommended), or as a ZIP file.
25+
You can download Open Note Block Studio [here](https://github.com/OpenNBS/OpenNoteBlockStudio/releases/latest)! _(Windows-only. Support for other platforms is coming soon!)_
26+
27+
### Project Status
28+
The current version is considered stable and feature-complete; as such, it's no longer accepting contributions or new features other than minor bug fixes.
29+
30+
In order to future-proof the project and allow us to make further improvements, we're currently in the process of rewriting the program using the Qt framework. You can read more about this and our future plans regarding the project in [this discussion](https://github.com/OpenNBS/OpenNoteBlockStudio/discussions/426)!
2731

2832
### Issues
2933
To report issues, please head over to the [Issues](https://github.com/OpenNBS/OpenNoteBlockStudio/issues) page.
3034
You can also join our [Discord server](https://discord.gg/w35BqQp) to get support and share your creations!
3135

3236
### Contributions
33-
This project is written in GameMaker Language (GML). You must have GameMaker Studio 2 in order to open the project and make changes.
34-
For contributions, please open a pull request.
37+
This project is written in GameMaker Language (GML). You must have [GameMaker Studio 2](https://gamemaker.io/) in order to open the project and make changes.
38+
39+
Since OpenNBS relies on 32-bit DLLs, you must use GameMaker runtime version **2022.6** as 32-bit support was removed in further versions. Scroll down [this page](https://gms.yoyogames.com/ReleaseNotes.html) and click _'Older versions'_ to find the appropriate installer.
40+
41+
If you'd like to contribute, please [open an issue](https://github.com/OpenNBS/OpenNoteBlockStudio/issues/new/choose) before making a pull request!
3542

36-
### Website
37-
For everything else, please visit the [website](https://opennbs.org/).
43+
### More
44+
For everything else, please visit our [website](https://opennbs.org/). You can also follow us on [Twitter](https://twitter.com/OpenNBS) and [YouTube](https://youtube.com/@OpenNBS)!

0 commit comments

Comments
 (0)