https://github.com/superctr/mmlgui
GUI for ctrmml
https://github.com/superctr/mmlgui
Last synced: about 1 month ago
JSON representation
GUI for ctrmml
- Host: GitHub
- URL: https://github.com/superctr/mmlgui
- Owner: superctr
- License: gpl-2.0
- Created: 2020-05-06T06:33:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T16:56:48.000Z (about 1 year ago)
- Last Synced: 2024-07-31T20:26:54.450Z (9 months ago)
- Language: C
- Size: 228 KB
- Stars: 49
- Watchers: 5
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: COPYING
Awesome Lists containing this project
README
mmlgui
======
### [Latest automatic build can be found here](https://nightly.link/superctr/mmlgui/workflows/win32-i686/master/binary)
MML (Music Macro Language) editor and compiler GUI. Powered by the [ctrmml](https://github.com/superctr/ctrmml) framework.
## Features
- MML text editor with instant feedback
- Supports Sega Mega Drive sound chips (YM2612, SN76489)
- Visualization of MML tracks
- Highlights currently playing notes in the editor window
- VGM and MDS file export
- Supports channel muting/isolation
### Future features / TODO
- Configuration window
- Support more sound chips
- More track visualizations
## Using
For Windows (or Wine) users, you can download the latest automatic build from [here](https://nightly.link/superctr/mmlgui/workflows/win32-i686/master/binary)
Feel free to join the [Discord server](https://discord.com/invite/BPwM6PJv7T)
if you have any questions or feedback.
See [ctrmml/mml_ref.md](https://github.com/superctr/ctrmml/blob/master/mml_ref.md) for an MML reference.
## Compiling using CMake
### Prerequisites
First, make sure all submodules have been cloned. If you didn't clone this repository
with `git clone --recurse-submodules`, do this:
git submodule update --init
Make sure you have the following packages installed: (this list might not be 100% correct)
glfw
You also need to have `pkg-config` (or a compatible equivalent such as `pkgconf`) installed.
Notice that there is no need to install libvgm for CMake builds, as it is built by the mmlgui target.
#### Building
mkdir build && cd build
cmake ..
cmake --build .
./mmlgui
To build a debug or release version, add `-DCMAKE_BUILD_TYPE=Debug` or `-DCMAKE_BUILD_TYPE=Release` to the first
cmake call.
Note that once cmake has setup the build environment, it is only needed to call `cmake --build .` for successive builds.
## Compiling using the makefile
The makefile is currently used for static linked builds for Windows as well as for address sanitizer builds.
Once these features are integrated in the CMake build, the makefiles will most likely be removed.
### Prerequisites
First, make sure all submodules have been cloned. If you didn't clone this repository
with `git clone --recurse-submodules`, do this:
git submodule update --init
Make sure you have the following packages installed: (this list might not be 100% correct)
glfw libvgm
#### Installing libvgm
If libvgm is not available on your system, you need to install it manually. Example:
##### Linux
mkdir build && cd build
cmake ..
make
sudo make install
##### Windows (MSYS2)
The `CMAKE_INSTALL_PREFIX` should of course match where your MSYS2/MinGW install folder is.
mkdir build && cd build
cmake .. -G "MSYS Makefiles" -D AUDIODRV_LIBAO=OFF -D CMAKE_INSTALL_PREFIX=/mingw64
make
make install
### Building
Once all prerequisites are installed, it should be as easy as
make
To build a release binary, add `RELEASE=1`.
### Special thanks
- [libvgm](https://github.com/ValleyBell/libvgm)
- [glfw](https://www.glfw.org/)
- [Dear ImGui](https://github.com/ocornut/imgui)
- [Dear ImGui addons branch](https://github.com/Flix01/imgui)
- [ImGuiColorTextEditor](https://github.com/BalazsJako/ImGuiColorTextEdit)
### Copyright
© 2020-2021 Ian Karlsson
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.