arkos2basic 0.1.0b1__tar.gz → 0.1.0b2__tar.gz

{arkos2basic-0.1.0b1 → arkos2basic-0.1.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arkos2basic
-Version: 0.1.0b1
+Version: 0.1.0b2
 Summary: Converts Arkos Tracker 3 text exports to CVBasic MUSIC blocks. Handles note transposition, variable note duration, percussion detection and intro/loop splitting. Targets ColecoVision, MSX and Sega SG-1000.
 Author: Francesco Maida
 Author-email: francesco.maida@gmail.com
@@ -24,7 +24,50 @@ pipx install arkos2basic
   
 ## Usage
 
+Export your song from Arkos Tracker as a TXT file, then launch this command:
+
 ```
 arkos2basic <input-file> <output-file>
 ```
 
+If your song has a loop, the app will provide you with two files:
+
+- <output-file-path>/<output-file-stem>.bas
+- <output-file-path>/<output-file-stem>_loop.bas
+
+## Example
+
+Let's imagine you have a TXT source file named `mymusic.txt` in the same folder of your CVBasic project.
+
+Convert the source file with the command:
+
+```
+arkos2basic mymusic.txt mymusic.bas
+```
+
+If the song has a loop, arkos2basic will provide you these two files:
+
+```
+mymusic.bas
+mymusic_loop.bas
+```
+
+To test if the music has been properly converted, create a `test_music.bas` file with this code:
+
+```basic 
+DIM loop_on
+loop_on = 0
+PLAY FULL
+PLAY mymusic
+DO
+    WAIT
+    IF MUSIC.PLAYING = 0 AND loop_on = 0 THEN
+        loop_on = 1
+        PLAY mymusic_loop
+    END IF
+LOOP WHILE 1
+
+INCLUDE mymusic.bas
+INCLUDE mymusic_loop.bas
+```
+

arkos2basic-0.1.0b2/README.md

@@ -0,0 +1,58 @@
+# Arkos2Basic
+
+Converts Arkos Tracker 3 text exports to CVBasic MUSIC blocks. Handles note transposition, variable note duration, percussion detection and intro/loop splitting. Targets ColecoVision, MSX and Sega SG-1000.
+
+## Installation
+
+```
+pipx install arkos2basic
+```
+  
+## Usage
+
+Export your song from Arkos Tracker as a TXT file, then launch this command:
+
+```
+arkos2basic <input-file> <output-file>
+```
+
+If your song has a loop, the app will provide you with two files:
+
+- <output-file-path>/<output-file-stem>.bas
+- <output-file-path>/<output-file-stem>_loop.bas
+
+## Example
+
+Let's imagine you have a TXT source file named `mymusic.txt` in the same folder of your CVBasic project.
+
+Convert the source file with the command:
+
+```
+arkos2basic mymusic.txt mymusic.bas
+```
+
+If the song has a loop, arkos2basic will provide you these two files:
+
+```
+mymusic.bas
+mymusic_loop.bas
+```
+
+To test if the music has been properly converted, create a `test_music.bas` file with this code:
+
+```basic 
+DIM loop_on
+loop_on = 0
+PLAY FULL
+PLAY mymusic
+DO
+    WAIT
+    IF MUSIC.PLAYING = 0 AND loop_on = 0 THEN
+        loop_on = 1
+        PLAY mymusic_loop
+    END IF
+LOOP WHILE 1
+
+INCLUDE mymusic.bas
+INCLUDE mymusic_loop.bas
+```

{arkos2basic-0.1.0b1 → arkos2basic-0.1.0b2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "arkos2basic"
-version = "0.1.0b1"
+version = "0.1.0b2"
 description = "Converts Arkos Tracker 3 text exports to CVBasic MUSIC blocks. Handles note transposition, variable note duration, percussion detection and intro/loop splitting. Targets ColecoVision, MSX and Sega SG-1000."
 authors = [
     {name = "Francesco Maida",email = "francesco.maida@gmail.com"}

arkos2basic-0.1.0b1/README.md

@@ -1,15 +0,0 @@
-# Arkos2Basic
-
-Converts Arkos Tracker 3 text exports to CVBasic MUSIC blocks. Handles note transposition, variable note duration, percussion detection and intro/loop splitting. Targets ColecoVision, MSX and Sega SG-1000.
-
-## Installation
-
-```
-pipx install arkos2basic
-```
-  
-## Usage
-
-```
-arkos2basic <input-file> <output-file>
-```