LMMS / LMMS/lmms

request: docs for nescaline, freeboy and SID

Open
#6,532 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

meta
Dominant language
C++
Stars
10.4k
Forks
1.3k
Avg merge
2d 13h
Merged PRs (30d)
7

Description

Hi

As you can read here I try to make a NES chiptune. (and later freeboy and SID).

https://lmms.io/forum/viewtopic.php?t=35767

It's difficult for 2 reasons:

1. There seems to be no documentation for nescaline, freeboy and SID which makes it very difficult for beginners.
What are the buttons doing, what channel represents a specific channel on the NES, ...
(See https://lmms.io/forum/viewtopic.php?t=35767 )

https://docs.lmms.io/user-manual/5-built-in-instruments/5.9-nescaline

https://docs.lmms.io/user-manual/5-built-in-instruments/5.15-sid

https://docs.lmms.io/user-manual/5-built-in-instruments/5.3-freeboy

2. What number of channels did the original hardware have and how are they mapped to the instrument channels?
Without documentation, I can't figure it out.

Is there somebody interested in writing documentation (on the LMMS documentation website) for nescaline, freeboy and SID with specific focus on the different channels and a summary of what each button of the instrument is doing exactly? Maybe with example (small) songs for LMMS that we can download.

Thanks
Lisa

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the LMMS user-manual pages for nescaline, SID, and freeboy, then use the linked forum discussion to identify the missing beginner information. Done means the documentation explains each instrument's controls, maps its channels to the original hardware, and includes small downloadable LMMS examples if available.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.