Skip to content

Commit 2eff58c

Browse files
committed
added usage to readme
1 parent 5ae9c99 commit 2eff58c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,28 @@ An effort to create a midi conversion tool for Polyend tracker project files.
66

77
I am in no way affiliated with Polyend. This is a hobby project.
88

9+
## Usage
10+
11+
Converting Polyend Tracker `*.mtp` pattern file to midi (pattern files are nested in project folders under `patterns`):
12+
13+
```sh
14+
:$ python polytracker2midi.py ./my-tracker-project/patterns/pattern_02.mtp
15+
```
16+
17+
Specify custom output file name:
18+
19+
```sh
20+
:$ python polytracker2midi.py ./my-tracker-project/patterns/pattern_02.mtp ./my-midi-file.mid
21+
```
22+
23+
Converting Polyend Tracker `*.mtp` pattern file to a text file (outputs a table view of the
24+
pattern similar to how you see it in Tracker UI):
25+
26+
```sh
27+
:$ python polytracker2text.py ./my-tracker-project/patterns/pattern_02.mtp
28+
```
29+
30+
You can see an example of pattern text representation [here](./reverse-engineering/session%201/project%20files/datagreed%20-%20rebel%20path%20tribute%202/patterns/pattern_01.txt)
931

1032
## Reverse Engineering
1133

0 commit comments

Comments
 (0)