diff --git a/gh-pages/guide.html b/gh-pages/guide.html index d3d0f490..3af49e8e 100644 --- a/gh-pages/guide.html +++ b/gh-pages/guide.html @@ -11,6 +11,18 @@ + + @@ -28,14 +40,15 @@

For people new to pxtone

-
-

Background on pxtone

-
-pxtone is a set of music creation tools made by Pixel, the creator of Cave Story and Kero Blaster. It includes two instrument editors, pxtone voice and pxtone noise, and a sequencer called pxtone collage. pxtone collab is a fan sequence editor that uses the audio engine source with a slightly different workflow, and also a few other features like network collaboration. +
+ Background on pxtone + -

Getting started

+ Getting started +
@@ -92,137 +108,152 @@

Effects

For pxtone collage users


-

Workflow differences

-
-ptcollab tries to have a similar workflow to pxtone collage. Besides hosting / connection, some notable differences are: - -
+ Workflow differences + + +

What does X mean?


-

Voice tab

- voice tab -
-
    -
  1. Repeat sample. For wav and ogg voices, you can toggle this to have the sample stop after one loop, or repeat as long as the note is held.
  2. -
  3. Beat fit. For wav and ogg voices, you can toggle this so that the sample always plays for 1 whole beat on note A4. This is useful for certain percussion sounds if you want to fix their start and end times.
  4. -
  5. Base key. If beat fit isn’t checked, change this to transpose this voice by a number of semitones. It’s inverted, so lower it if you want everything to sound higher. Double-click to edit.
  6. -
  7. Name. The name of the voice. Double-click to edit.
  8. -
+ Voice tab + -

Unit tab

- unit tab -
+ Unit tab + -

Effects

- delay effects -
-
    -
  1. Group. Which unit group should this effect apply to?
  2. -
  3. Unit. Together with frequency, determines how often the echo should play. The name is a bit misleading since units already have a different meaning in pxtone. Options are Beat, Meas, Sec.
  4. -
  5. Frequency. How many times should the echo play within one “Unit”. For example, if set to 3Hz and Unit is Beat, it will play 3 times in a beat.
  6. -
  7. Ratio. How loud should an echo be compared to the previous one?
  8. -
-
+ Effects + -

Miscellaneous

- miscallaneous labels -
-
    -
  1. Users connected to this session. Each row shows a user’s ID, name, and ping.
  2. -
  3. Watch another user. You follow their cursor, window position, playhead, and current unit. You can input a note or watch yourself to stop following.
  4. -
  5. Local playback volume (doesn’t affect song).
  6. -
  7. Playback buffer length. If your audio is choppy, try raising this. It will add some audio latency though.
  8. -
  9. The parameter you’re currently editing.
  10. -
  11. Quantization for your current note (e.g., if Snap X is ⅓, you can place notes ⅓ of a beat long). Snap lets you do microtonal placements.
  12. -
  13. When copying and pasting, this determines if you want to include the current parameter in the copy. Note: velocity controls whether or not the notes themselves are copied.
  14. -
  15. Follow playhead. Toggle this to automatically scroll if the playhead falls offscreen.
  16. -
-
-
+ Miscellaneous + +

How do I...


-

Host?

-

To edit with friends, one person has to host a server. This can be a bit complicated depending on your network setup.

-

First, you have to tick "Host" in the New Session window.

-

If your home internet uses a router, though, you might have to set up port forwarding, so that computers outside of your network can connect to you. Many multiplayer game servers usually need something similar.

-

Copied below is a brief guide on how to do this, from here.

-
    -
  • Go to the router configuration site (Often 192.168.1.1 or 10.0.0.1; it depends on your router model, so you should probably find that out).
    • You might see a login screen that looks like this. Your router usually will have information about how to log in.
  • -
  • Go to the "forwarding" or "virtual servers" page
  • -
  • Create a new forwarding entry: port 15835 (or whatever port you want to host on), TCP protocol (or Both) and the local IP address of your computer. -
      -
    • There are guides online to help figure out your local IP address, for example here.
    • -
    • My own setup looks something like this.
    • -
    + Edit with friends? +
+

If you have a local firewall (Windows firewall, Comodo, McAfee, F-secure, etc.), you need to configure that as well. For more detailed guides, check out portforward.com (you generally don't need to download anything).

+

Once the server is up, others can connect to it by going to File > Connect, and in the Connect dialog, type in your public IP (which you can find here), then a colon, then the port you're hosting on.

+
-

Copy and paste?

-

Make a selection with Ctrl+Shift+Drag.

- selection for copy and paste -

Press Ctrl + C and make a new selection somewhere else.

- new selection for copy and paste -

Press Ctrl + V.

- paste for copy and paste -

Advanced copy and paste

-

You can also copy and paste over multiple units if you check the selection checkbox (the third box) in the Unit tab.

- multi-unit copy -

Additionally, the “Copy” checkbox in the bottom left can be used to set only certain parameters to be copied. If you want to only copy panning, for example, you can untick the checkbox for each other parameter setting, then copy and paste.

- copy certain params + Copy and paste? + -

Portamento / vibrato?

-

Copy and paste?

- setting portamento -

Ctrl+click somewhere in the middle of the note. This changes the pitch of the note without creating a new note.

-
correct porta + Portamento / vibrato? +
-

Glossary of shortcuts

-
+ Glossary of shortcuts +
+

For other operating systems, there are build instructions in the source repo.

+

Guides & Help

-

Check out this page for a brief guide on getting started and setting up collaboration!

-

For other operating systems, there are build instructions in the source repo.

+

Here's a guide for getting started, hosting a server, and various other common actions.

If you have any questions, comments, or suggestions, please feel free to contact me there, by email, in Discord (server link below), or on Twitter!

@@ -96,7 +97,6 @@

Resources

  • The official pxtone website
  • pxtone web, a fan site for posting pxtone music
  • The Pxtone Collage Collective, an archive of pxtone songs and a library for many free instrument libraries
  • -
  • Tutorial: Getting started with PxTone is also pretty applicable here (the section on the tabs especially).
  • English Discord Server
  • diff --git a/gh-pages/resources/style.css b/gh-pages/resources/style.css index 23d06897..b9c19325 100644 --- a/gh-pages/resources/style.css +++ b/gh-pages/resources/style.css @@ -6,7 +6,7 @@ } img { box-sizing: border-box; } -.screenshot { display:block; margin:5px auto; border:2px solid #202020; } +.screenshot { display:block; margin:5px auto; border:2px solid #202020; max-width:100%; } .screenshot img { margin:0 } text img.screenshot { border:2px solid #00F080; } @@ -21,6 +21,12 @@ header { margin: 0 0 20px 0; } +a.h3 { + font-size:14pt; + display:block; + text-decoration:none; +} + section { padding: 10px 20px; margin: 20px 0; @@ -34,7 +40,7 @@ html,body { background-color:#202020; } -h1,h2,h3,h4,h5,h6{ +h1,h2,h3,h4,h5,h6,a.h3{ text-transform:uppercase; margin:10px 0 15px 0; }