Skip to content

Saniac249/tabToMXL

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 

Repository files navigation

TAB2MXL

Introduction

TAB2MXL is a java application which will convert tablature made for percussion, guitar, and bass guitar from a “.txt” format to a ".musicxml" format.

The specific xml format being used is musicxml and there are various resources on the web that will allow conversion from the resultant musicxml file into sheet music.

Functionality

Currently, our application supports input in the form of plain text (pasted into a text area), or the selection of a .txt file from the user's file system.

Requirements

TAB2MXL uses Java 15.0.2, so please ensure that version 15.0.2 of java is installed on your machine prior to setup.

Supported Features

We support the conversion of simple guitar tabs. These tabs must not contain additional information such as title, repeats, and text between lines of the tab. We currently support chords. We currently only support 6 string guitars in standard tuning. Hammerons and pulloffs are only supported outside of chords and in pairs of two. These features are currently being added.

Two example tabs are shown below.

e|-------5-7-----7-|-8-----8-2-----2-|-0---------0-----|-----------------|
B|-----5-----5-----|---5-------3-----|---1---1-----1---|-0-1-1-----------|
G|---5---------5---|-----5-------2---|-----2---------2-|-0-2-2---2-------|
D|-7-------6-------|-5-------4-------|-3---------------|-----------------|
A|-----------------|-----------------|-----------------|-2-0-0---0---8-7-|
E|-----------------|-----------------|-----------------|-----------------|
 
e|---------7-----7-|-8-----8-2-----2-|-0---------0-----|-----------------|
B|-------5---5-----|---5-------3-----|---1---1-----1---|-0-1-1-----------|
G|-----5-------5---|-----5-------2---|-----2---------2-|-0-2-2-----------|
D|---7-----6-------|-5-------4-------|-3---------------|-----------------|
A|-0---------------|-----------------|-----------------|-2-0-0-------0-2-|
E|-----------------|-----------------|-----------------|-----------------|
|-----------0-----|-0---------------|
|---------0---0---|-0---------------|
|-------1-------1-|-1---------------|
|-----2-----------|-2---------------|
|---2-------------|-2---------------|
|-0---------------|-0---------------|

Setup

Outlined below are instructions for setting up the project in Eclipse.

Eclipse

Downloading the project via zip file

  1. Download the zip file from this repository.
    image

  2. Unzip the file using some file extractor software.
    image

  3. File -> Open Projects From File System.
    image

  4. Select 'Directory' and navigate to the TabToMXL folder.

    image
    Click 'Select Folder' and then click 'Finish'.

Downloading the project via git

  1. Right click on Package Explorer section in Eclipse, select Import -> Projects from Git.
    image

  2. Click Next -> Clone URI -> Next and paste this link in the URI section: https://github.com/PBaciu/tabToMXL.git
    image

  3. Click 'Next' then unckeck the 'Develop' branch and then click 'Next'. Leave the next page as defaults and click Next. Then hit 'Finish'.

Running the project

  1. The Package Explorer should now appear on the left hand side of the window.
    image

  2. Right click on the project 'TabToMXL' and navigate to Gradle -> Refresh Gradle Project.
    image

  3. Right click on the project 'TabToMXL' and navigate to Run As -> Run Configurations.

    image

  4. Select Gradle Task and then click the icon circled in red to create a new configuration.
    image

  5. Click Add and rename the configuration from 'task' to 'run', by clicking on the name. Then, select 'Workspace' and then choose 'TabToMXL'. Apply and Run.
    image

  6. TabToMXL is now set up to run on your system. You can run the project in the future by clicking the run button on the top bar menu.
    image

Usage

Our application currently consists of three pages

Input Page

This page allows the insertion of text via a .txt file that can be selected from the file system, or copied text. Incase of the user already having the file open, the user could also drag and drop the file into the designated space.
Screen Shot 2021-03-17 at 11 22 51 PM

A successful input should look like the following: Screen Shot 2021-03-17 at 11 30 47 PM

If the user made changes right after the user inserted the .txt file from the file explorer. The user would be notified with a message saying that changes has been made and if you would like to save those changes, where you can click the save changes button. image

Output Page

This page allows the user to view the resulting xml and gives the option to save the file, convert another file, or go back to the previously inputted file.
image

Issues

In case of any problems, please open an issue on this github page, or email Patrick at [email protected]

CC Attribution-ShareAlike 4.0 International

Shield: CC BY-SA 4.0

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

CC BY-SA 4.0

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors