Skip to content

Commit

Permalink
update readme and manual
Browse files Browse the repository at this point in the history
  • Loading branch information
B0ney committed Aug 26, 2024
1 parent 8ab5c84 commit 526ebbd
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,20 @@ If you wish to build from source, go to [building](#building).

If you prefer to use a minimal version of this tool, a command line version of xmodits can be found [here](https://github.com/B0ney/xmodits-cli). Additionally, the command line version has more supported architectures.

## Supported Tracker Formats
## Supported Tracker Module Formats
| Extension | Format |
| - | - |
| ``.it`` | Impulse Tracker |
| ``.xm`` | Extended Module |
| ``.s3m`` | Scream Tracker 3 |
| ``.mod`` | Amiga Pro Tracker |
| ``.mod`` | Amiga Protracker |
| ``.mptm`` | ModPlug Tracker module |
| ``.umx`` | Unreal Music Package (Containing above) |

## Supported Containers
| Extension | Description |
| --- | --- |
| ``.umx`` | Unreal Music Package|
| N/A | Protracker 3.6 project file |

# Supported Exports
| Extension | Format |
Expand Down
8 changes: 4 additions & 4 deletions assets/manual.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
XMODITS v0.12.0 MANUAL
XMODITS v0.12.2 MANUAL

Author: B0ney
Last Modified: 27 June 2024
Last Modified: 26 August 2024


HOW TO USE.
Expand All @@ -21,7 +21,8 @@ Currently Supported Formats:
* Impulse Tracker - it/mptm

Supported Containers:
* Unreal Music Package - umx
* Unreal Music Package - umx
* Protracker 3.6 project - n/a

Keyboard Shortcuts:
* DELETE - Clears only the selected entries
Expand Down Expand Up @@ -167,7 +168,6 @@ Even I was surprised to see how fast it ran on my system.

What can't XMODITS rip?
* Scream Tracker 3 modules that ONLY have adlib instruments (it's not pcm!)
* Protracker 3 modules - pt3, XMODITS may recognise it as an "IFF module" and inform you anyway. This restriction will be lifted for later versions.
* Modules that use "exotic" compression (except IT214 & IT215 since they're quite common in impulse tracker)
* .xm modules below 1.4 (those are quite rare)

Expand Down

0 comments on commit 526ebbd

Please sign in to comment.